Inheritance diagram for Request:

Public Member Functions
	__construct (CookieReaderInterface $cookieReader, StringUtils $converter, AreaList $areaList, ScopeInterface $configScope, $uri=null)

	getHeader ($header, $default=false)

	getRequestedServices ($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 ()

Data Fields
const	REQUEST_PARAM_SERVICES = 'services'

const	ALL_SERVICES = 'all'

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
	_convertRequestParamToServiceArray ($param)

Protected Member Functions inherited from Request
	immediateRequestSecure ()

	initialRequestSecure ($offLoaderHeader)

Additional Inherited Members
Static Public Member Functions inherited from Http
static	getDistroBaseUrlPath ($server)

static	getUrlNoScript ($url)

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

Detailed Description

Definition at line 18 of file Request.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	CookieReaderInterface	$cookieReader,
		StringUtils	$converter,
		AreaList	$areaList,
		ScopeInterface	$configScope,
			$uri = `null`
	)

Modify pathInfo: strip down the front name and query parameters.

Parameters

CookieReaderInterface	$cookieReader
StringUtils	$converter
AreaList	$areaList
ScopeInterface	$configScope
null \| string	$uri

Remove base url and area from path

Remove GET parameters from path

Definition at line 39 of file Request.php.

       {
         parent::__construct($cookieReader, $converter, $uri);
 
         $pathInfo = $this->getRequestUri();
         $areaFrontName = $areaList->getFrontName($configScope->getCurrentScope());
         $pathInfo = preg_replace("#.*?/{$areaFrontName}/?#", '/', $pathInfo);
         $pathInfo = preg_replace('#\?.*#', '', $pathInfo);
         $this->setPathInfo($pathInfo);
     }

Member Function Documentation

◆ _convertRequestParamToServiceArray()

_convertRequestParamToServiceArray ( $param )

protected

Extract the resources query param value and return associative array of the form 'resource' => 'version'

Parameters

string

$param

eg

 testModule1AllSoapAndRestV1,testModule2AllSoapNoRestV1

Returns

string|array

 eg array (
     'testModule1AllSoapAndRestV1',
     'testModule2AllSoapNoRestV1',
     )

Exceptions

Definition at line 98 of file Request.php.

     {
         $serviceSeparator = ',';
         $serviceVerPattern = "[a-zA-Z\d]*V[\d]+";
         $regexp = "/^({$serviceVerPattern})([{$serviceSeparator}]{$serviceVerPattern})*\$/";
         if ($param == 'all') {
             return $param;
         }
         //Check if the $param is of valid format
         if (empty($param) || !preg_match($regexp, $param)) {
             $message = new Phrase('Incorrect format of request URI or Requested services are missing.');
             throw new \Magento\Framework\Webapi\Exception($message);
         }
         //Split the $param string to create an array of 'service' => 'version'
         $serviceVersionArray = explode($serviceSeparator, $param);
         $serviceArray = [];
         foreach ($serviceVersionArray as $service) {
             $serviceArray[] = $service;
         }
         return $serviceArray;
     }

◆ getHeader()

getHeader	(	$header,
		$default = `false`
	)

{}

Added CGI environment support.

Workaround for hhvm environment

Definition at line 62 of file Request.php.

     {
         $headerValue = parent::getHeader($header, $default);
         if ($headerValue == false) {
             $header = 'REDIRECT_HTTP_' . strtoupper(str_replace('-', '_', $header));
             if (isset($_SERVER[$header])) {
                 $headerValue = $_SERVER[$header];
             }
         }
         return $headerValue;
     }

◆ getRequestedServices()

getRequestedServices ( $default = null )

Identify versions of resources that should be used for API configuration generation.

Parameters

string | null $default

Returns: array|string

Exceptions

Definition at line 82 of file Request.php.

     {
         $param = $this->getParam(self::REQUEST_PARAM_SERVICES, $default);
         return $this->_convertRequestParamToServiceArray($param);
     }

Field Documentation

◆ ALL_SERVICES

const ALL_SERVICES = 'all'

services parameter value to indicate that a schema for all services should be generated

Definition at line 28 of file Request.php.

◆ REQUEST_PARAM_SERVICES

const REQUEST_PARAM_SERVICES = 'services'

Name of query parameter to specify services for which to generate schema

Definition at line 23 of file Request.php.

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

vendor/magento/framework/Webapi/Request.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _convertRequestParamToServiceArray()

◆ getHeader()

◆ getRequestedServices()

Field Documentation

◆ ALL_SERVICES

◆ REQUEST_PARAM_SERVICES