PHP Class ManaPHP\Http\Request

Inheritance: extends ManaPHP\Component, implements ManaPHP\Http\RequestInterface

Datei anzeigen Open project: manaphp/manaphp

Protected Properties

Property	Type	Description
$_clientAddress	string
$_putCache	array
$_rawBody	string

Public Methods

Method	Description
get ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed	Gets a variable from the $_REQUEST applying filters if needed.
getAccessToken ( ) : string \| null
getClientAddress ( ) : string	Gets most possible client IPv4 Address. This method search in $_SERVER['REMOTE_ADDR'] and optionally in $_SERVER['HTTP_X_FORWARDED_FOR']
getFiles ( boolean $onlySuccessful = false ) : File[]	Gets attached files as \ManaPHP\Http\Request\File instances
getGet ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed	Gets variable from $_GET applying filters if needed If no parameters are given the $_GET is returned
getHeader ( string $name ) : string \| null
getJsonBody ( boolean $assoc = true ) : array \| stdClass
getMethod ( ) : string
getPost ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed	Gets a variable from the $_POST applying filters if needed If no parameters are given the $_POST is returned
getPut ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed	Gets a variable from put request
getQuery ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed	Gets variable from $_GET applying filters if needed If no parameters are given the $_GET is returned
getRawBody ( ) : string	Gets HTTP raw request body
getReferer ( ) : string	Gets web page that refers active request. ie: http://www.google.com
getScheme ( ) : string	Gets HTTP schema (http/https)
getServer ( string $name = null, mixed $defaultValue = null ) : mixed	Gets variable from $_SERVER
getUri ( ) : string
getUrl ( boolean $withQuery = false ) : string
getUserAgent ( ) : string	Gets HTTP user agent used to made the request
has ( string $name ) : boolean	Checks whether $_REQUEST has certain index
hasFiles ( boolean $onlySuccessful = false ) : boolean	Checks whether request includes attached files http://php.net/manual/en/features.file-upload.multiple.php
hasGet ( string $name ) : boolean	Checks whether $_GET has certain index
hasPost ( string $name ) : boolean	Checks whether $_POST has certain index
hasPut ( string $name ) : boolean	Checks whether put has certain index
hasQuery ( string $name ) : boolean	Checks whether $_GET has certain index
hasServer ( string $name ) : boolean	Checks whether $_GET has certain index
isAjax ( ) : boolean	Checks whether request has been made using ajax. Checks if $_SERVER['HTTP_X_REQUESTED_WITH']=='XMLHttpRequest'
isDelete ( ) : boolean	Checks whether HTTP method is DELETE. if $_SERVER['REQUEST_METHOD']=='DELETE'
isGet ( ) : boolean	Checks whether HTTP method is GET. if $_SERVER['REQUEST_METHOD']=='GET'
isHead ( ) : boolean	Checks whether HTTP method is HEAD. if $_SERVER['REQUEST_METHOD']=='HEAD'
isOptions ( ) : boolean	Checks whether HTTP method is OPTIONS. if $_SERVER['REQUEST_METHOD']=='OPTIONS'
isPatch ( ) : boolean	Checks whether HTTP method is PATCH. if $_SERVER['REQUEST_METHOD']=='PATCH'
isPost ( ) : boolean	Checks whether HTTP method is POST. if $_SERVER['REQUEST_METHOD']=='POST'
isPut ( ) : boolean	Checks whether HTTP method is PUT. if $_SERVER['REQUEST_METHOD']=='PUT'
setClientAddress ( string \| callable $address ) : static	set the client address for getClientAddress method

Protected Methods

Method	Description
_getHelper ( array $source, string $name = null, string $rule = null, mixed $defaultValue = null ) : string \| null

Method Details

_getHelper() protected method

protected _getHelper ( array $source, string $name = null, string $rule = null, mixed $defaultValue = null ) : string \| null
$source	array
$name	string
$rule	string
$defaultValue	mixed
return	string \| null

get() public method

If no parameters are given the $_REQUEST is returned


Returns value from $_REQUEST["user_email"] without sanitizing
   $userEmail = $request->get("user_email");
Returns value from $_REQUEST["user_email"] with sanitizing
   $userEmail = $request->get("user_email", "email");

public get ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed
$name	string
$rule	string
$defaultValue	mixed
return	mixed

getAccessToken() public method

public getAccessToken ( ) : string \| null
return	string \| null

getClientAddress() public method

Gets most possible client IPv4 Address. This method search in $_SERVER['REMOTE_ADDR'] and optionally in $_SERVER['HTTP_X_FORWARDED_FOR']

public getClientAddress ( ) : string
return	string

getFiles() public method

Gets attached files as \ManaPHP\Http\Request\File instances

public getFiles ( boolean $onlySuccessful = false ) : File[]
$onlySuccessful	boolean
return	ManaPHP\Http\Request\File[]

getGet() public method


Returns value from $_GET["id"] without sanitizing
   $id = $request->getGet("id");
Returns value from $_GET["id"] with sanitizing
   $id = $request->getGet("id", "int");
Returns value from $_GET["id"] with a default value
   $id = $request->getGet("id", null, 150);

public getGet ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed
$name	string
$rule	string
$defaultValue	mixed
return	mixed

getHeader() public method

public getHeader ( string $name ) : string \| null
$name	string
return	string \| null

getJsonBody() public method

public getJsonBody ( boolean $assoc = true ) : array \| stdClass
$assoc	boolean
return	array \| stdClass

getMethod() public method

public getMethod ( ) : string
return	string

getPost() public method


Returns value from $_POST["user_email"] without sanitizing
   $userEmail = $request->getPost("user_email");
Returns value from $_POST["user_email"] with sanitizing
   $userEmail = $request->getPost("user_email", "email");

public getPost ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed
$name	string
$rule	string
$defaultValue	mixed
return	mixed

getPut() public method


   $userEmail = $request->getPut("user_email");

   $userEmail = $request->getPut("user_email", "email");

public getPut ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed
$name	string
$rule	string
$defaultValue	mixed
return	mixed

getQuery() public method


Returns value from $_GET["id"] without sanitizing
   $id = $request->getQuery("id");
Returns value from $_GET["id"] with sanitizing
   $id = $request->getQuery("id", "int");
Returns value from $_GET["id"] with a default value
   $id = $request->getQuery("id", null, 150);

public getQuery ( string $name = null, string $rule = null, mixed $defaultValue = null ) : mixed
$name	string
$rule	string
$defaultValue	mixed
return	mixed

getRawBody() public method

Gets HTTP raw request body

public getRawBody ( ) : string
return	string

getReferer() public method

Gets web page that refers active request. ie: http://www.google.com

public getReferer ( ) : string
return	string

getScheme() public method

Gets HTTP schema (http/https)

public getScheme ( ) : string
return	string

getServer() public method

Gets variable from $_SERVER

public getServer ( string $name = null, mixed $defaultValue = null ) : mixed
$name	string
$defaultValue	mixed
return	mixed

getUri() public method

public getUri ( ) : string
return	string

getUrl() public method

public getUrl ( boolean $withQuery = false ) : string
$withQuery	boolean
return	string

getUserAgent() public method

Gets HTTP user agent used to made the request

public getUserAgent ( ) : string
return	string

has() public method

Checks whether $_REQUEST has certain index

public has ( string $name ) : boolean
$name	string
return	boolean

hasFiles() public method

Checks whether request includes attached files http://php.net/manual/en/features.file-upload.multiple.php

public hasFiles ( boolean $onlySuccessful = false ) : boolean
$onlySuccessful	boolean
return	boolean

hasGet() public method

Checks whether $_GET has certain index

public hasGet ( string $name ) : boolean
$name	string
return	boolean

hasPost() public method

Checks whether $_POST has certain index

public hasPost ( string $name ) : boolean
$name	string
return	boolean

hasPut() public method

Checks whether put has certain index

public hasPut ( string $name ) : boolean
$name	string
return	boolean

hasQuery() public method

Checks whether $_GET has certain index

public hasQuery ( string $name ) : boolean
$name	string
return	boolean

hasServer() public method

Checks whether $_GET has certain index

public hasServer ( string $name ) : boolean
$name	string
return	boolean

isAjax() public method

Checks whether request has been made using ajax. Checks if $_SERVER['HTTP_X_REQUESTED_WITH']=='XMLHttpRequest'

public isAjax ( ) : boolean
return	boolean

isDelete() public method

Checks whether HTTP method is DELETE. if $_SERVER['REQUEST_METHOD']=='DELETE'

public isDelete ( ) : boolean
return	boolean

isGet() public method

Checks whether HTTP method is GET. if $_SERVER['REQUEST_METHOD']=='GET'

public isGet ( ) : boolean
return	boolean

isHead() public method

Checks whether HTTP method is HEAD. if $_SERVER['REQUEST_METHOD']=='HEAD'

public isHead ( ) : boolean
return	boolean

isOptions() public method

Checks whether HTTP method is OPTIONS. if $_SERVER['REQUEST_METHOD']=='OPTIONS'

public isOptions ( ) : boolean
return	boolean

isPatch() public method

Checks whether HTTP method is PATCH. if $_SERVER['REQUEST_METHOD']=='PATCH'

public isPatch ( ) : boolean
return	boolean

isPost() public method

Checks whether HTTP method is POST. if $_SERVER['REQUEST_METHOD']=='POST'

public isPost ( ) : boolean
return	boolean

isPut() public method

Checks whether HTTP method is PUT. if $_SERVER['REQUEST_METHOD']=='PUT'

public isPut ( ) : boolean
return	boolean

setClientAddress() public method

set the client address for getClientAddress method

public setClientAddress ( string \| callable $address ) : static
$address	string \| callable
return	static

Property Details

$_clientAddress protected_oe property

protected string $_clientAddress
return	string

$_putCache protected_oe property

protected array $_putCache
return	array

$_rawBody protected_oe property

protected string $_rawBody
return	string