You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
2.9 KiB
94 lines
2.9 KiB
<?php
|
|
|
|
/**
|
|
* CodeIgniter
|
|
*
|
|
* An open source application development framework for PHP
|
|
*
|
|
* This content is released under the MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
|
* Copyright (c) 2019 CodeIgniter Foundation
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* @package CodeIgniter
|
|
* @author CodeIgniter Dev Team
|
|
* @copyright 2019 CodeIgniter Foundation
|
|
* @license https://opensource.org/licenses/MIT MIT License
|
|
* @link https://codeigniter.com
|
|
* @since Version 4.0.0
|
|
* @filesource
|
|
*/
|
|
|
|
namespace CodeIgniter\HTTP;
|
|
|
|
/**
|
|
* Expected behavior of an HTTP request
|
|
*
|
|
* @mixin \CodeIgniter\HTTP\IncomingRequest
|
|
* @mixin \CodeIgniter\HTTP\CLIRequest
|
|
* @mixin \CodeIgniter\HTTP\CURLRequest
|
|
*/
|
|
interface RequestInterface
|
|
{
|
|
|
|
/**
|
|
* Gets the user's IP address.
|
|
*
|
|
* @return string IP address
|
|
*/
|
|
public function getIPAddress(): string;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Validate an IP address
|
|
*
|
|
* @param string $ip IP Address
|
|
* @param string $which IP protocol: 'ipv4' or 'ipv6'
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isValidIP(string $ip, string $which = null): bool;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Get the request method.
|
|
*
|
|
* @param boolean $upper Whether to return in upper or lower case.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getMethod(bool $upper = false): string;
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Fetch an item from the $_SERVER array.
|
|
*
|
|
* @param string $index Index for item to be fetched from $_SERVER
|
|
* @param null $filter A filter name to be applied
|
|
* @return mixed
|
|
*/
|
|
public function getServer($index = null, $filter = null);
|
|
|
|
//--------------------------------------------------------------------
|
|
}
|
|
|