RemoteAddress Class Reference

Public Member Functions
	__construct (RequestInterface $httpRequest, array $alternativeHeaders=[], array $trustedProxies=null)
	getRemoteAddress (bool $ipToLong=false)
	getRemoteHost ()

Protected Attributes
	$request
	$remoteAddress
	$alternativeHeaders

Detailed Description

Library for working with client ip address.

Definition at line 13 of file RemoteAddress.php.

Constructor & Destructor Documentation

__construct()

__construct	(	RequestInterface	$httpRequest,
		array	$alternativeHeaders = [],
		array	$trustedProxies = null
	)

Parameters

RequestInterface	$httpRequest
array	$alternativeHeaders
	string[]|null	$trustedProxies

Definition at line 44 of file RemoteAddress.php.

      {
        $this->request = $httpRequest;
        $this->alternativeHeaders = $alternativeHeaders;
        $this->trustedProxies = $trustedProxies;
    }

Member Function Documentation

getRemoteAddress()

getRemoteAddress

(

bool

$ipToLong = false

)

Retrieve Client Remote Address. If alternative headers are used and said headers allow multiple IPs it is suggested that trusted proxies is also used for more accurate IP recognition.

Parameters

bool

$ipToLong

converting IP to long format

Returns

string IPv4|long

Definition at line 120 of file RemoteAddress.php.

    {
        if ($this->remoteAddress !== null) {
            return $this->remoteAddress;
        }

        $remoteAddress = $this->readAddress();
        if (!$remoteAddress) {
            $this->remoteAddress = false;

            return false;
        }
        $remoteAddress = $this->filterAddress($remoteAddress);

        if (!$remoteAddress) {
            $this->remoteAddress = false;

            return false;
        } else {
            $this->remoteAddress = $remoteAddress;

            return $ipToLong ? ip2long($this->remoteAddress) : $this->remoteAddress;
        }
    }

getRemoteHost()

getRemoteHost

(

)

Returns internet host name corresponding to remote server

Returns

string|null

Definition at line 150 of file RemoteAddress.php.

    {
        return $this->getRemoteAddress()
            ? gethostbyaddr($this->getRemoteAddress())
            : null;
    }

Field Documentation

$alternativeHeaders

$alternativeHeaders

protected

Definition at line 32 of file RemoteAddress.php.

$remoteAddress

$remoteAddress

protected

Definition at line 27 of file RemoteAddress.php.

$request

$request

protected

Definition at line 20 of file RemoteAddress.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/HTTP/PhpEnvironment/RemoteAddress.php