• Home
• Neos
• Flow
• Http
• Request

PHP Class Neos\Flow\Http\Request

ファイルを表示 Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$arguments	array
$attributes	array	PSR-7
$baseUri	Uri
$inputStreamUri	string	URI for the "input" stream wrapper which can be modified for testing purposes
$method	string
$server	array	Data similar to that which is typically provided by $_SERVER
$uri	Uri

Public Methods

Method	Description
__clone ( )	Creates a deep clone
__construct ( array $get, array $post, array $files, array $server )	Constructs a new Request object based on the given environment data.
__toString ( ) : string	Cast the request to a string: return the content part of this response
create ( Uri $uri, string $method = 'GET', array $arguments = [], array $files = [], array $server = [] ) : Request	Creates a new Request object from the given data.
createActionRequest ( ) : ActionRequest	Creates a new Action Request request as a sub request to this HTTP request.
createFromEnvironment ( ) : Request	Considers the environment information found in PHP's superglobals and Flow's environment configuration and creates a new instance of this Request class matching that data.
getAcceptedMediaTypes ( ) : array	Returns an list of IANA media types defined in the Accept header.
getArgument ( string $name ) : mixed	Returns the value of the specified GET / POST / PUT argument.
getArguments ( ) : array	Returns the unified arguments of this request.
getAttribute ( string $name, mixed $default = null ) : mixed	PSR-7
getAttributes ( ) : mixed[]	PSR-7
getBaseUri ( ) : Uri	Returns the detected base URI
getClientIpAddress ( ) : string	Returns the best guess of the client's IP address.
getContent ( boolean $asResource = false ) : string | resource	Returns the content of the request body
getMethod ( ) : string	Returns the request method
getNegotiatedMediaType ( array $supportedMediaTypes, boolean $trim = true ) : string	Returns the best fitting IANA media type after applying the content negotiation rules on a possible Accept header.
getPort ( ) : integer	Returns the port used for this request
getRelativePath ( ) : string	Returns the request's path relative to the $baseUri
getRequestLine ( ) : string	Return the Request-Line of this Request Message, consisting of the method, the uri and the HTTP version Would be, for example, "GET /foo?bar=baz HTTP/1.1" Note that the URI part is, at the moment, only possible in the form "abs_path" since the actual requestUri of the Request cannot be determined during the creation of the Request.
getScriptRequestPath ( ) : string	Returns the relative path (ie. relative to the web root) to the script as it was accessed through the web server.
getScriptRequestPathAndFilename ( ) : string	Returns the relative path (ie. relative to the web root) and name of the script as it was accessed through the web server.
getServerParams ( ) : array	PSR-7
getStartLine ( ) : string	Returns the first line of this Request Message, which is the Request-Line in this case
getUri ( ) : Uri	Returns the request URI
hasArgument ( string $name ) : boolean	Checks if an argument of the given name exists in this request.
isMethodSafe ( ) : boolean	Tells if the request method is "safe", that is, it is expected to not take any other action than retrieval. This should the case with "GET" and "HEAD" requests.
isSecure ( ) : boolean	Indicates if this request has been received through a secure channel.
mediaRangeMatches ( string $mediaRange, string $mediaType ) : boolean	Checks if the given media range and the media type match.
parseContentNegotiationQualityValues ( string $rawValues ) : array	Parses a RFC 2616 content negotiation header field by evaluating the Quality Values and splitting the options into an array list, ordered by user preference.
parseMediaType ( string $rawMediaType ) : array	Parses a RFC 2616 Media Type and returns its parts in an associative array.
renderHeaders ( ) : string	Renders the HTTP headers - including the status header - of this request
setBaseUri ( Uri $baseUri )
setContent ( string | resource $content ) : void	Explicitly sets the content of the request body
setMethod ( string $method ) : void	Sets the request method
trimMediaType ( string $rawMediaType ) : string	Strips off any parameters from the given media type and returns just the type and subtype in the format "type/subtype".
withAttribute ( string $name, mixed $value ) : self	PSR-7
withoutAttribute ( string $name ) : self	PSR-7

Protected Methods

Method	Description
buildUnifiedArguments ( array $getArguments, array $postArguments, array $uploadArguments ) : array	Takes the raw GET & POST arguments and maps them into the request object.
calculateFieldPaths ( array $structure, string $firstLevelFieldName = null ) : array	Returns and array of all possibles "field paths" for the given array.
detectBaseUri ( ) : void	Tries to detect the base URI of request.
setAttribute ( string $name, mixed $value )
unsetAttribute ( string $name )
untangleFilesArray ( array $convolutedFiles ) : array	Transforms the convoluted _FILES superglobal into a manageable form.

Method Details

Property Details