Http Class Reference

Inheritance diagram for Http:

Public Member Functions
	__construct (CookieReaderInterface $cookieReader, StringUtils $converter, ConfigInterface $routeConfig, PathInfoProcessorInterface $pathInfoProcessor, ObjectManagerInterface $objectManager, $uri=null, $directFrontNames=[], PathInfo $pathInfoService=null)
	getOriginalPathInfo ()
	getPathInfo ()
	setPathInfo ($pathInfo=null)
	isDirectAccessFrontendName ($code)
	getBasePath ()
	getFrontName ()
	setRouteName ($route)
	getRouteName ()
	setControllerModule ($module)
	getControllerModule ()
	initForward ()
	getBeforeForwardInfo ($name=null)
	isAjax ()
	getDistroBaseUrl ()
	getFullActionName ($delimiter='_')
	__sleep ()
	isSafeMethod ()
Public Member Functions inherited from Request
	__construct (CookieReaderInterface $cookieReader, StringUtils $converter, $uri=null)
	getModuleName ()
	setModuleName ($value)
	getControllerName ()
	setControllerName ($value)
	getActionName ()
	setActionName ($value)
	getPathInfo ()
	setPathInfo ($pathInfo=null)
	getRequestString ()
	getAlias ($name)
	setAlias ($name, $target)
	getParam ($key, $default=null)
	setParam ($key, $value)
	getParams ()
	setParams (array $array)
	clearParams ()
	getScheme ()
	setDispatched ($flag=true)
	isDispatched ()
	isSecure ()
	getCookie ($name=null, $default=null)
	getServerValue ($name=null, $default=null)
	getQueryValue ($name=null, $default=null)
	setQueryValue ($name, $value=null)
	getPostValue ($name=null, $default=null)
	setPostValue ($name, $value=null)
	__get ($key)
	get ($key)
	__isset ($key)
	has ($key)
	getHeader ($name, $default=false)
	getHttpHost ($trimPort=true)
	getClientIp ($checkProxy=true)
	getUserParams ()
	getUserParam ($key, $default=null)
	setRequestUri ($requestUri=null)
	getBaseUrl ()
	isForwarded ()
	setForwarded ($forwarded)
Public Member Functions inherited from RequestInterface
	getModuleName ()
	setModuleName ($name)
	getActionName ()
	setActionName ($name)
	getParam ($key, $defaultValue=null)
	setParams (array $params)
	getParams ()
	getCookie ($name, $default)
	isSecure ()
Public Member Functions inherited from PlainTextRequestInterface
	getContent ()
Public Member Functions inherited from HttpRequestInterface
	isPost ()
	isGet ()
	isPatch ()
	isDelete ()
	isPut ()

Static Public Member Functions
static	getDistroBaseUrlPath ($server)
static	getUrlNoScript ($url)

Data Fields
const	DEFAULT_HTTP_PORT = 80
const	DEFAULT_HTTPS_PORT = 443
const	XML_PATH_OFFLOADER_HEADER = 'web/secure/offloader_header'
Data Fields inherited from Request
const	SCHEME_HTTP = 'http'
const	SCHEME_HTTPS = 'https'
const	XML_PATH_OFFLOADER_HEADER = 'web/secure/offloader_header'

Protected Attributes
	$route
	$pathInfo = ''
	$originalPathInfo = ''
	$directFrontNames
	$controllerModule
	$beforeForwardInfo = []
	$routeConfig
	$pathInfoProcessor
	$objectManager
	$isSafeMethod = null
	$safeRequestTypes = ['GET', 'HEAD', 'TRACE', 'OPTIONS']
Protected Attributes inherited from Request
	$module
	$controller
	$action
	$pathInfo = ''
	$requestString = ''
	$params = []
	$aliases = []
	$dispatched = false
	$forwarded
	$cookieReader
	$converter
	$appConfig
	$sslOffloadHeader

Additional Inherited Members
Protected Member Functions inherited from Request
	immediateRequestSecure ()
	initialRequestSecure ($offLoaderHeader)

Detailed Description

Http request

Definition at line 20 of file Http.php.

Constructor & Destructor Documentation

__construct()

__construct	(	CookieReaderInterface	$cookieReader,
		StringUtils	$converter,
		ConfigInterface	$routeConfig,
		PathInfoProcessorInterface	$pathInfoProcessor,
		ObjectManagerInterface	$objectManager,
			$uri = null,
			$directFrontNames = [],
		PathInfo	$pathInfoService = null
	)

Parameters

CookieReaderInterface	$cookieReader
StringUtils	$converter
ConfigInterface	$routeConfig
PathInfoProcessorInterface	$pathInfoProcessor
ObjectManagerInterface	$objectManager
\Zend\Uri\UriInterface | string | null	$uri
array	$directFrontNames
PathInfo | null	$pathInfoService

Definition at line 113 of file Http.php.

      {
        parent::__construct($cookieReader, $converter, $uri);
        $this->routeConfig = $routeConfig;
        $this->pathInfoProcessor = $pathInfoProcessor;
        $this->objectManager = $objectManager;
        $this->directFrontNames = $directFrontNames;
        $this->pathInfoService = $pathInfoService ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
            PathInfo::class
        );
    }

Member Function Documentation

__sleep()

__sleep

(

)

Sleep

Returns

array

Definition at line 416 of file Http.php.

    {
        return [];
    }

getBasePath()

getBasePath

(

)

Get base path

Returns

string

Definition at line 199 of file Http.php.

    {
        $path = parent::getBasePath();
        if (empty($path)) {
            $path = '/';
        } else {
            $path = str_replace('\\', '/', $path);
        }
        return $path;
    }

getBeforeForwardInfo()

getBeforeForwardInfo

(

$name = null

)

Retrieve property's value which was before _forward call. If property was not changed during _forward call null will be returned. If passed name will be null whole state array will be returned.

Parameters

string

$name

Returns

array|string|null

Definition at line 296 of file Http.php.

    {
        if ($name === null) {
            return $this->beforeForwardInfo;
        } elseif (isset($this->beforeForwardInfo[$name])) {
            return $this->beforeForwardInfo[$name];
        }
        return null;
    }

getControllerModule()

getControllerModule

(

)

Get module name of currently used controller

Returns

string

Definition at line 264 of file Http.php.

    {
        return $this->controllerModule;
    }

getDistroBaseUrl()

getDistroBaseUrl

(

)

Get website instance base url

Returns

string

@SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 329 of file Http.php.

    {
        if ($this->distroBaseUrl) {
            return $this->distroBaseUrl;
        }
        $headerHttpHost = $this->getServer('HTTP_HOST');
        $headerHttpHost = $this->converter->cleanString($headerHttpHost);
        $headerScriptName = $this->getServer('SCRIPT_NAME');

        if (isset($headerScriptName) && isset($headerHttpHost)) {
            if ($secure = $this->isSecure()) {
                $scheme = 'https://';
            } else {
                $scheme = 'http://';
            }

            $hostArr = explode(':', $headerHttpHost);
            $host = $hostArr[0];
            $port = isset($hostArr[1])
                && (!$secure && $hostArr[1] != 80 || $secure && $hostArr[1] != 443) ? ':' . $hostArr[1] : '';
            $path = $this->getBasePath();

            return $this->distroBaseUrl = $scheme . $host . $port . rtrim($path, '/') . '/';
        }
        return 'http://localhost/';
    }

getDistroBaseUrlPath()

static getDistroBaseUrlPath (   $server )

static

Determines a base URL path from environment

Parameters

array

$server

Returns

string

Definition at line 362 of file Http.php.

    {
        $result = '';
        if (isset($server['SCRIPT_NAME'])) {
            $envPath = str_replace('\\', '/', dirname(str_replace('\\', '/', $server['SCRIPT_NAME'])));
            if ($envPath != '.' && $envPath != '/') {
                $result = $envPath;
            }
        }
        if (!preg_match('/\/$/', $result)) {
            $result .= '/';
        }
        return $result;
    }

getFrontName()

getFrontName

(

)

Retrieve request front name

Returns

string|null

Definition at line 215 of file Http.php.

    {
        $pathParts = explode('/', trim($this->getPathInfo(), '/'));
        return reset($pathParts);
    }

getFullActionName()

getFullActionName

(

$delimiter = '_'

)

Retrieve full action name

Parameters

string

$delimiter

Returns

string

Definition at line 402 of file Http.php.

    {
        return $this->getRouteName() .
            $delimiter .
            $this->getControllerName() .
            $delimiter .
            $this->getActionName();
    }

getOriginalPathInfo()

getOriginalPathInfo

(

)

Return the ORIGINAL_PATH_INFO. This value is calculated and processed from $_SERVER due to cross-platform differences. instead of reading PATH_INFO

Returns

string

Definition at line 140 of file Http.php.

    {
        if (empty($this->originalPathInfo)) {
            $originalPathInfoFromRequest = $this->pathInfoService->getPathInfo(
                $this->getRequestUri(),
                $this->getBaseUrl()
            );
            $this->originalPathInfo = (string)$this->pathInfoProcessor->process($this, $originalPathInfoFromRequest);
            $this->requestString = $this->originalPathInfo
                . $this->pathInfoService->getQueryString($this->getRequestUri());
        }
        return $this->originalPathInfo;
    }

getPathInfo()

getPathInfo

(

)

Return the path info

Returns

string

Definition at line 159 of file Http.php.

    {
        if (empty($this->pathInfo)) {
            $this->pathInfo = $this->getOriginalPathInfo();
        }
        return $this->pathInfo;
    }

getRouteName()

getRouteName

(

)

Retrieve route name

Returns

string|null

Definition at line 242 of file Http.php.

    {
        return $this->route;
    }

getUrlNoScript()

static getUrlNoScript (   $url )

static

Return url with no script name

Parameters

string

$url

Returns

string

Definition at line 383 of file Http.php.

    {
        if (!isset($_SERVER['SCRIPT_NAME'])) {
            return $url;
        }

        if (($pos = strripos($url, basename($_SERVER['SCRIPT_NAME']))) !== false) {
            $url = substr($url, 0, $pos);
        }

        return $url;
    }

initForward()

initForward

(

)

Collect properties changed by _forward in protected storage before _forward was called first time.

Returns

$this

Definition at line 274 of file Http.php.

    {
        if (empty($this->beforeForwardInfo)) {
            $this->beforeForwardInfo = [
                'params' => $this->getParams(),
                'action_name' => $this->getActionName(),
                'controller_name' => $this->getControllerName(),
                'module_name' => $this->getModuleName(),
                'route_name' => $this->getRouteName(),
            ];
        }
        return $this;
    }

isAjax()

isAjax

(

)

Check is Request from AJAX

Returns

boolean

Implements HttpRequestInterface.

Definition at line 311 of file Http.php.

    {
        if ($this->isXmlHttpRequest()) {
            return true;
        }
        if ($this->getParam('ajax') || $this->getParam('isAjax')) {
            return true;
        }
        return false;
    }

isDirectAccessFrontendName()

isDirectAccessFrontendName

(

$code

)

Check if code declared as direct access frontend name.

This means what this url can be used without store code.

Parameters

string

$code

Returns

bool

Definition at line 189 of file Http.php.

    {
        return isset($this->directFrontNames[$code]);
    }

isSafeMethod()

isSafeMethod

(

)

Check that this is safe request

Returns

bool

Implements RequestSafetyInterface.

Definition at line 424 of file Http.php.

    {
        if ($this->isSafeMethod === null) {
            if (isset($_SERVER['REQUEST_METHOD']) && (in_array($_SERVER['REQUEST_METHOD'], $this->safeRequestTypes))) {
                $this->isSafeMethod = true;
            } else {
                $this->isSafeMethod = false;
            }
        }
        return $this->isSafeMethod;
    }

setControllerModule()

setControllerModule

(

$module

)

Specify module name where was found currently used controller

Parameters

string

$module

Returns

$this

Definition at line 253 of file Http.php.

    {
        $this->controllerModule = $module;
        return $this;
    }

setPathInfo()

setPathInfo

(

$pathInfo = null

)

Set the PATH_INFO string.

Set the ORIGINAL_PATH_INFO string.

Parameters

string | null

$pathInfo

Returns

$this

Definition at line 175 of file Http.php.

    {
        $this->pathInfo = (string)$pathInfo;
        return $this;
    }

setRouteName()

setRouteName

(

$route

)

Set route name

Parameters

string

$route

Returns

$this

Definition at line 227 of file Http.php.

    {
        $this->route = $route;
        $module = $this->routeConfig->getRouteFrontName($route);
        if ($module) {
            $this->setModuleName($module);
        }
        return $this;
    }

Field Documentation

$beforeForwardInfo

$beforeForwardInfo = []

protected

Definition at line 66 of file Http.php.

$controllerModule

$controllerModule

protected

Definition at line 59 of file Http.php.

$directFrontNames

$directFrontNames

protected

Definition at line 54 of file Http.php.

$isSafeMethod

$isSafeMethod = null

protected

Definition at line 86 of file Http.php.

$objectManager

$objectManager

protected

Definition at line 81 of file Http.php.

$originalPathInfo

$originalPathInfo = ''

protected

Definition at line 49 of file Http.php.

$pathInfo

$pathInfo = ''

protected

Definition at line 42 of file Http.php.

$pathInfoProcessor

$pathInfoProcessor

protected

Definition at line 76 of file Http.php.

$route

$route

protected

Definition at line 35 of file Http.php.

$routeConfig

$routeConfig

protected

Definition at line 71 of file Http.php.

$safeRequestTypes

$safeRequestTypes = ['GET', 'HEAD', 'TRACE', 'OPTIONS']

protected

Definition at line 91 of file Http.php.

DEFAULT_HTTP_PORT

const DEFAULT_HTTP_PORT = 80

#+ HTTP Ports

Definition at line 25 of file Http.php.

DEFAULT_HTTPS_PORT

const DEFAULT_HTTPS_PORT = 443

Definition at line 26 of file Http.php.

XML_PATH_OFFLOADER_HEADER

const XML_PATH_OFFLOADER_HEADER = 'web/secure/offloader_header'

#-

Definition at line 30 of file Http.php.

---

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

• vendor/magento/framework/App/Request/Http.php