Request Class Reference

Inheritance diagram for Request:

Public Member Functions
	getHttpHost ($trimPort=true)
	setServer (ParametersInterface $server)
	getServer ($name=null, $default=null)
Public Member Functions inherited from Http
	__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 ()

Protected Attributes
	$_server
Protected Attributes inherited from Http
	$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
Static Public Member Functions inherited from Http
static	getDistroBaseUrlPath ($server)
static	getUrlNoScript ($url)
Data Fields inherited from Http
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 Member Functions inherited from Request
	immediateRequestSecure ()
	initialRequestSecure ($offLoaderHeader)

Detailed Description

HTTP request implementation that is used instead core one for testing

Definition at line 13 of file Request.php.

Member Function Documentation

getHttpHost()

getHttpHost

(

$trimPort = true

)

Retrieve HTTP HOST. This method is a stub - all parameters are ignored, just static value returned.

Parameters

bool

$trimPort

Returns

string

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 31 of file Request.php.

    {
        return $trimPort ? 'localhost' : 'localhost:81';
    }

getServer()

getServer	(		$name = null,
			$default = null
	)

Overridden getter to avoid using of $_SERVER

Parameters

string | null	$name
mixed | null	$default

Returns

ParametersInterface|array|mixed|null

Definition at line 55 of file Request.php.

    {
        if (null === $name) {
            return $this->_server;
        }
        return $this->_server->get($name, $default);
    }

setServer()

setServer

(

ParametersInterface

$server

)

Set "server" super-global mock

Parameters

ParametersInterface

$server

Returns

\Magento\TestFramework\Request

Definition at line 42 of file Request.php.

    {
        $this->_server = $server;
        return $this;
    }

Field Documentation

$_server

$_server

protected

Definition at line 20 of file Request.php.

---

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

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/Request.php