• Главная
• Symfony
• Component
• HttpFoundation
• Request

PHP Класс Symfony\Component\HttpFoundation\Request

The methods dealing with URL accept / return a raw path (% encoded): * getBasePath * getBaseUrl * getPathInfo * getRequestUri * getUri * getUriForPath Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$attributes	Symfony\Component\HttpFoundation\ParameterBag	Custom parameters.
$cookies	Symfony\Component\HttpFoundation\ParameterBag	Cookies ($_COOKIE).
$files	FileBag	Uploaded files ($_FILES).
$headers	HeaderBag	Headers (taken from the $_SERVER).
$query	Symfony\Component\HttpFoundation\ParameterBag	Query string parameters ($_GET).
$request	Symfony\Component\HttpFoundation\ParameterBag	Request body parameters ($_POST).
$server	ServerBag	Server and execution environment parameters ($_SERVER).

Защищенные свойства (Protected)

Свойство	Тип	Описание
$acceptableContentTypes	array
$basePath	string
$baseUrl	string
$charsets	array
$content	string
$defaultLocale	string
$encodings	array
$format	string
$formats	array
$httpMethodParameterOverride
$languages	array
$locale	string
$method	string
$pathInfo	string
$requestFactory
$requestUri	string
$session	Symfony\Component\HttpFoundation\Session\SessionInterface
$trustedHeaders		The FORWARDED header is the standard as of rfc7239. The other headers are non-standard, but widely used by popular reverse proxies (like Apache mod_proxy or Amazon EC2).
$trustedHostPatterns	string[]
$trustedHosts	string[]
$trustedProxies	string[]

Открытые методы

Метод	Описание
__clone ( )	Clones the current request.
__construct ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string | resource $content = null )	Constructor.
__toString ( ) : string	Returns the request as a string.
create ( string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null ) : Request	Creates a Request based on a given URI and configuration.
createFromGlobals ( ) : Request	Creates a new request with values from PHP's super globals.
duplicate ( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null ) : Request	Clones a request and overrides some of its parameters.
enableHttpMethodParameterOverride ( )	Enables support for the _method request parameter to determine the intended HTTP method.
get ( string $key, mixed $default = null ) : mixed	Gets a "parameter" value from any bag.
getAcceptableContentTypes ( ) : array	Gets a list of content types acceptable by the client browser.
getBasePath ( ) : string	Returns the root path from which this request is executed.
getBaseUrl ( ) : string	Returns the root URL from which this request is executed.
getCharsets ( ) : array	Gets a list of charsets acceptable by the client browser.
getClientIp ( ) : string	Returns the client IP address.
getClientIps ( ) : array	Returns the client IP addresses.
getContent ( boolean $asResource = false ) : string | resource	Returns the request body content.
getContentType ( ) : string | null	Gets the format associated with the request.
getDefaultLocale ( ) : string	Get the default locale.
getETags ( ) : array	Gets the Etags.
getEncodings ( ) : array	Gets a list of encodings acceptable by the client browser.
getFormat ( string $mimeType ) : string | null	Gets the format associated with the mime type.
getHost ( ) : string	Returns the host name.
getHttpHost ( ) : string	Returns the HTTP host being requested.
getHttpMethodParameterOverride ( ) : boolean	Checks whether support for the _method request parameter is enabled.
getLanguages ( ) : array	Gets a list of languages acceptable by the client browser.
getLocale ( ) : string	Get the locale.
getMethod ( ) : string	Gets the request "intended" method.
getMimeType ( string $format ) : string	Gets the mime type associated with the format.
getMimeTypes ( string $format ) : array	Gets the mime types associated with the format.
getPassword ( ) : string | null	Returns the password.
getPathInfo ( ) : string	Returns the path being requested relative to the executed script.
getPort ( ) : string	Returns the port on which the request is made.
getPreferredLanguage ( array $locales = null ) : string | null	Returns the preferred language.
getQueryString ( ) : string | null	Generates the normalized query string for the Request.
getRealMethod ( ) : string	Gets the "real" request method.
getRelativeUriForPath ( string $path ) : string	Returns the path as relative reference from the current Request path.
getRequestFormat ( string $default = 'html' ) : string	Gets the request format.
getRequestUri ( ) : string	Returns the requested URI (path and query string).
getScheme ( ) : string	Gets the request's scheme.
getSchemeAndHttpHost ( ) : string	Gets the scheme and HTTP host.
getScriptName ( ) : string	Returns current script name.
getSession ( ) : Symfony\Component\HttpFoundation\Session\SessionInterface | null	Gets the Session.
getTrustedHeaderName ( string $key ) : string	Gets the trusted proxy header name.
getTrustedHosts ( ) : array	Gets the list of trusted host patterns.
getTrustedProxies ( ) : array	Gets the list of trusted proxies.
getUri ( ) : string	Generates a normalized URI (URL) for the Request.
getUriForPath ( string $path ) : string	Generates a normalized URI for the given path.
getUser ( ) : string | null	Returns the user.
getUserInfo ( ) : string	Gets the user info.
hasPreviousSession ( ) : boolean	Whether the request contains a Session which was started in one of the previous requests.
hasSession ( ) : boolean	Whether the request contains a Session object.
initialize ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string | resource $content = null )	Sets the parameters for this request.
isFromTrustedProxy ( ) : boolean	Indicates whether this request originated from a trusted proxy.
isMethod ( string $method ) : boolean	Checks if the request method is of specified type.
isMethodCacheable ( ) : boolean	Checks whether the method is cacheable or not.
isMethodIdempotent ( ) : boolean	Checks whether or not the method is idempotent.
isMethodSafe ( ) : boolean	Checks whether or not the method is safe.
isNoCache ( ) : boolean
isSecure ( ) : boolean	Checks whether the request is secure or not.
isXmlHttpRequest ( ) : boolean	Returns true if the request is a XMLHttpRequest.
normalizeQueryString ( string $qs ) : string	Normalizes a query string.
overrideGlobals ( )	Overrides the PHP global variables according to this request instance.
setDefaultLocale ( string $locale )	Sets the default locale.
setFactory ( callable | null $callable )	Sets a callable able to create a Request instance.
setFormat ( string $format, string | array $mimeTypes )	Associates a format with mime types.
setLocale ( string $locale )	Sets the locale.
setMethod ( string $method )	Sets the request method.
setRequestFormat ( string $format )	Sets the request format.
setSession ( Symfony\Component\HttpFoundation\Session\SessionInterface $session )	Sets the Session.
setTrustedHeaderName ( string $key, string $value )	Sets the name for trusted headers.
setTrustedHosts ( array $hostPatterns )	Sets a list of trusted host patterns.
setTrustedProxies ( array $proxies )	Sets a list of trusted proxies.

Защищенные методы

Метод	Описание
initializeFormats ( )	Initializes HTTP request formats.
prepareBasePath ( ) : string	Prepares the base path.
prepareBaseUrl ( ) : string	Prepares the base URL.
preparePathInfo ( ) : string	Prepares the path info.
prepareRequestUri ( )	* The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)

Приватные методы

Метод	Описание
createRequestFromFactory ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null )
getUrlencodedPrefix ( $string, $prefix )	* Returns the prefix as encoded in the string when the string starts with the given prefix, false otherwise.
normalizeAndFilterClientIps ( array $clientIps, $ip )
setPhpDefaultLocale ( string $locale )	Sets the default PHP locale.

Описание методов

Описание свойств