124 lines
2.7 KiB
PHP
124 lines
2.7 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This file is part of CodeIgniter 4 framework.
|
||
|
|
*
|
||
|
|
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||
|
|
*
|
||
|
|
* For the full copyright and license information, please view
|
||
|
|
* the LICENSE file that was distributed with this source code.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace CodeIgniter\HTTP;
|
||
|
|
|
||
|
|
use CodeIgniter\Validation\FormatRules;
|
||
|
|
use Config\App;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Representation of an incoming, server-side HTTP request.
|
||
|
|
*
|
||
|
|
* @see \CodeIgniter\HTTP\RequestTest
|
||
|
|
*/
|
||
|
|
class Request extends OutgoingRequest implements RequestInterface
|
||
|
|
{
|
||
|
|
use RequestTrait;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Proxy IPs
|
||
|
|
*
|
||
|
|
* @var array<string, string>
|
||
|
|
*
|
||
|
|
* @deprecated 4.0.5 No longer used. Check the App config directly
|
||
|
|
*/
|
||
|
|
protected $proxyIPs;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructor.
|
||
|
|
*
|
||
|
|
* @param App $config
|
||
|
|
*
|
||
|
|
* @deprecated 4.0.5 The $config is no longer needed and will be removed in a future version
|
||
|
|
*/
|
||
|
|
public function __construct($config = null) // @phpstan-ignore-line
|
||
|
|
{
|
||
|
|
if (empty($this->method)) {
|
||
|
|
$this->method = $this->getServer('REQUEST_METHOD') ?? 'GET';
|
||
|
|
}
|
||
|
|
|
||
|
|
if (empty($this->uri)) {
|
||
|
|
$this->uri = new URI();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Validate an IP address
|
||
|
|
*
|
||
|
|
* @param string $ip IP Address
|
||
|
|
* @param string $which IP protocol: 'ipv4' or 'ipv6'
|
||
|
|
*
|
||
|
|
* @deprecated 4.0.5 Use Validation instead
|
||
|
|
*
|
||
|
|
* @codeCoverageIgnore
|
||
|
|
*/
|
||
|
|
public function isValidIP(?string $ip = null, ?string $which = null): bool
|
||
|
|
{
|
||
|
|
return (new FormatRules())->valid_ip($ip, $which);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the request method.
|
||
|
|
*
|
||
|
|
* @param bool $upper Whether to return in upper or lower case.
|
||
|
|
*
|
||
|
|
* @deprecated 4.0.5 The $upper functionality will be removed and this will revert to its PSR-7 equivalent
|
||
|
|
*
|
||
|
|
* @codeCoverageIgnore
|
||
|
|
*/
|
||
|
|
public function getMethod(bool $upper = false): string
|
||
|
|
{
|
||
|
|
return ($upper) ? strtoupper($this->method) : strtolower($this->method);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the request method. Used when spoofing the request.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*
|
||
|
|
* @deprecated 4.0.5 Use withMethod() instead for immutability
|
||
|
|
*
|
||
|
|
* @codeCoverageIgnore
|
||
|
|
*/
|
||
|
|
public function setMethod(string $method)
|
||
|
|
{
|
||
|
|
$this->method = $method;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns an instance with the specified method.
|
||
|
|
*
|
||
|
|
* @param string $method
|
||
|
|
*
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withMethod($method)
|
||
|
|
{
|
||
|
|
$request = clone $this;
|
||
|
|
|
||
|
|
$request->method = $method;
|
||
|
|
|
||
|
|
return $request;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieves the URI instance.
|
||
|
|
*
|
||
|
|
* @return URI
|
||
|
|
*/
|
||
|
|
public function getUri()
|
||
|
|
{
|
||
|
|
return $this->uri;
|
||
|
|
}
|
||
|
|
}
|