• Home
• AppserverIo
• Appserver
• ServletEngine
• Http
• Request

PHP Class AppserverIo\Appserver\ServletEngine\Http\Request

Datei anzeigen Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property	Type	Description
$attributes	array	Array that contains the attributes of this context.
$authType	string	The request's authentication type.
$authenticationManager	AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface	The session manager instance.
$baseModifier	string	Base modifier which allows for base path generation within rewritten URL environments.
$bodyStream	resource	The body content stream resource.
$context	AppserverIo\Psr\Context\ContextInterface	The request context instance.
$contextPath	string	The application context name.
$dispatched	boolean	Whether or not the request has been dispatched.
$documentRoot	string	The document root.
$handlers	array	The available request handlers.
$httpRequest	AppserverIo\Psr\HttpMessage\RequestInterface	The HTTP request instance.
$parts	array	The uploaded part instances.
$pathInfo	string	The absolute path info.
$queryString	string	The query string.
$requestHandler	AppserverIo\Appserver\ServletEngine\Http\RequestContextInterface	The request context.
$requestUri	string	The request URI.
$requestUrl	string	The request URL.
$requestedSessionId	string	The new session-ID.
$requestedSessionName	string	The new session name.
$response	AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface	The servlet response instance.
$serverName	string	The server name.
$serverVars	array	The server variables.
$servletPath	string	The path (URI) to the servlet.
$sessionManager	AppserverIo\Appserver\ServletEngine\SessionManagerInterface	The session manager instance.
$userPrincipal	AppserverIo\Psr\Security\PrincipalInterface	The user principal of the authenticated user or NULL if the user has not been authenticated.

Public Methods

Method	Description
__construct ( )	Initializes the request object with the default properties.
addCookie ( AppserverIo\Psr\HttpMessage\CookieInterface $cookie ) : void	Adds the passed cookie to this request.
addHeader ( string $name, string $value ) : void	Adds a header information got from connection.
addPart ( AppserverIo\Psr\HttpMessage\PartInterface $part, string $name = null ) : void	Adds a part to the parts collection.
authenticate ( AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse ) : boolean	Use the container login mechanism configured for the servlet context to authenticate the user making this request. This method may modify and commit the passed servlet response.
getAttribute ( string $key ) : mixed	Returns the value with the passed name from the context.
getAuthType ( ) : string | null	Return's the authentication type.
getAuthenticationManager ( ) : AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface	Return's the authentication manager instance.
getBaseModifier ( ) : string	Returns the base modifier which allows for base path generation within rewritten URL environments
getBodyContent ( ) : string	Return content
getBodyStream ( ) : resource	Returns the body stream as a resource.
getContext ( ) : AppserverIo\Psr\Context\ContextInterface	Returns the context that allows access to session and server information.
getContextPath ( ) : string	Returns the application context name (application name prefixed with a slash) for the actual request.
getCookie ( string $cookieName ) : AppserverIo\Psr\HttpMessage\CookieInterface	Returns the value of the cookie with the passed name.
getCookies ( ) : array	Return's the array with cookies.
getDocumentRoot ( ) : string	Returns the absolut path to the document root.
getHandlers ( ) : array	Returns the available file handlers registered by the webserver configuration.
getHeader ( string $name ) : string | null	Returns header info by given name
getHeaders ( ) : array	Returns headers data
getHttpPartInstance ( ) : AppserverIo\Psr\HttpMessage\PartInterface	Returns a part instance
getHttpRequest ( ) : AppserverIo\Psr\HttpMessage\RequestInterface	Returns the Http request instance.
getMethod ( ) : string	Returns request method
getParam ( string $name ) : string | null	Returns the parameter with the passed name if available or null if the parameter not exists.
getParameter ( string $name, integer $filter = FILTER_SANITIZE_STRING ) : string | null	Returns the parameter with the passed name if available or null if the parameter not exists.
getParameterMap ( ) : array	Returns an array with all request parameters.
getPart ( string $name ) : AppserverIo\Http\HttpPart	Returns a part object by given name
getParts ( ) : array	Returns the parts collection as array
getPathInfo ( ) : string	Returns the absolute path info started from the context path.
getProposedSessionId ( ) : string	Return the session identifier proposed by the actual configuration and request state.
getQueryString ( ) : string | null	Returns query string of the actual request.
getRemoteUser ( ) : AppserverIo\Lang\String | null	Return's the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.
getRequestHandler ( ) : AppserverIo\Appserver\ServletEngine\Http\RequestContextInterface	Returns the context that allows access to session and server information.
getRequestUri ( ) : string	Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
getRequestUrl ( ) : string	Returns the URL the client used to make the request.
getRequestedSessionId ( ) : string	Return the session identifier included in this request, if any.
getRequestedSessionName ( ) : string	Return the session name included in this request, if any.
getResponse ( ) : AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface	Returns the servlet response bound to this request.
getServerName ( ) : string	Returns the server name.
getServerVar ( string $name ) : mixed	Returns the server variable with the requested name.
getServerVars ( ) : array	Returns the array with the server variables.
getServletPath ( ) : string	Returns the path to the servlet used to handle this request.
getSession ( boolean $create = false ) : null | AppserverIo\Psr\Servlet\Http\HttpSessionInterface	Returns the session for this request.
getSessionManager ( ) : AppserverIo\Appserver\ServletEngine\SessionManagerInterface	Return's the session manager instance.
getUri ( ) : string	Returns request uri
getUserPrincipal ( ) : AppserverIo\Psr\Security\PrincipalInterface | null	Return's a PrincipalInterface object containing the name of the current authenticated user.
getVersion ( ) : string	Returns protocol version
hasCookie ( string $cookieName ) : boolean	Returns true if the request has a cookie header with the passed name, else false.
hasHeader ( string $name ) : boolean	Checks if header exists by given name.
hasParameter ( string $name ) : boolean	Queries whether the request contains a parameter or not.
init ( ) : void	Initializes the servlet request with the data from the injected HTTP request instance.
injectAuthenticationManager ( AppserverIo\Appserver\ServletEngine\Security\AuthenticationManagerInterface $authenticationManager ) : void	Injects the authentication manager instance.
injectContext ( AppserverIo\Psr\Context\ContextInterface $context ) : void	Injects the context that allows access to session and server information.
injectHandlers ( array $handlers ) : void	Injects the available file handlers registered by the webserver configuration.
injectHttpRequest ( AppserverIo\Psr\HttpMessage\RequestInterface $httpRequest ) : void	Injects the Http request instance.
injectResponse ( AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $response ) : void	Injects the servlet response bound to this request.
injectServerVars ( array $serverVars ) : void	Injects the server variables.
injectSessionManager ( AppserverIo\Appserver\ServletEngine\SessionManagerInterface $sessionManager ) : void	Injects the session manager instance.
isDispatched ( ) : boolean	Sets the flag that shows if the request has already been dispatched.
isUserInRole ( string $role ) : boolean	Return_s a boolean indicating whether the authenticated user is included in the specified logical "role".
login ( string $username, string $password ) : void	Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext.
logout ( ) : void	Establish null as the value returned when getUserPrincipal, getRemoteUser, and getAuthType is called on the request.
prepare ( ) : void	Prepares the request instance.
setAttribute ( string $key, mixed $value ) : void	Adds the attribute with the passed name to this context.
setAuthType ( string | null $authType = null ) : void	Set's the passed authentication type.
setBaseModifier ( string $baseModifier ) : null	Set the base modifier
setBodyStream ( resource $bodyStream ) : void	Resets the stream resource pointing to body content.
setContextPath ( string $contextPath ) : void	Sets the application context name (application name prefixed with a slash) for the actual request.
setDispatched ( boolean $dispatched = true ) : void	Sets the flag to mark the request dispatched.
setDocumentRoot ( string $documentRoot ) : void	Sets the absolute path to the document root.
setHeaders ( array $headers ) : void	Set headers data
setMethod ( string $method ) : void	Sets the method to be performed on the resource identified by the Request-URI.
setParameterMap ( array $parameterMap ) : void	Returns an array with all request parameters.
setPathInfo ( string $pathInfo ) : void	Sets the absolute path info started from the context path.
setQueryString ( string $queryString ) : void	Sets the query string of the actual request.
setRequestUri ( string $requestUri ) : void	Sets the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
setRequestUrl ( string $requestUrl ) : void	Sets the URL the client used to make the request.
setRequestedSessionId ( string $requestedSessionId ) : void	Set the requested session ID for this request. This is normally called by the HTTP Connector, when it parses the request headers.
setRequestedSessionName ( string $requestedSessionName ) : void	Set the requested session name for this request.
setServerName ( string $serverName ) : void	Sets the server name.
setServletPath ( string $servletPath ) : void	Sets the path to the servlet used to handle this request.
setUri ( string $uri ) : void	Sets the URI.
setUserPrincipal ( AppserverIo\Psr\Security\PrincipalInterface $userPrincipal = null ) : void	Set's the user principal for this request.
setVersion ( string $version ) : void	Set protocol version

Method Details

Property Details