/vendor/phalcon/devtools/ide/1.3.1/Phalcon/Http/Request.php
PHP | 489 lines | 57 code | 103 blank | 329 comment | 0 complexity | 0cf18937fab04bb107a00e4cbaac03a5 MD5 | raw file
- <?php
- namespace Phalcon\Http {
- /**
- * Phalcon\Http\Request
- *
- * <p>Encapsulates request information for easy and secure access from application controllers.</p>
- *
- * <p>The request object is a simple value object that is passed between the dispatcher and controller classes.
- * It packages the HTTP request environment.</p>
- *
- *<code>
- * $request = new Phalcon\Http\Request();
- * if ($request->isPost() == true) {
- * if ($request->isAjax() == true) {
- * echo 'Request was made using POST and AJAX';
- * }
- * }
- *</code>
- *
- */
-
- class Request implements \Phalcon\Http\RequestInterface, \Phalcon\DI\InjectionAwareInterface {
- protected $_dependencyInjector;
- protected $_filter;
- protected $_rawBody;
- protected $_put;
- /**
- * Sets the dependency injector
- *
- * @param \Phalcon\DiInterface $dependencyInjector
- */
- public function setDI($dependencyInjector){ }
- /**
- * Returns the internal dependency injector
- *
- * @return \Phalcon\DiInterface
- */
- public function getDI(){ }
- /**
- * Gets a variable from the $_REQUEST superglobal applying filters if needed.
- * If no parameters are given the $_REQUEST superglobal is returned
- *
- *<code>
- * //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");
- *</code>
- *
- * @param string $name
- * @param string|array $filters
- * @param mixed $defaultValue
- * @param boolean $notAllowEmpty
- * @param boolean $noRecursive
- * @return mixed
- */
- public function get($name=null, $filters=null, $defaultValue=null){ }
- /**
- * Gets a variable from the $_POST superglobal applying filters if needed
- * If no parameters are given the $_POST superglobal is returned
- *
- *<code>
- * //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");
- *</code>
- *
- * @param string $name
- * @param string|array $filters
- * @param mixed $defaultValue
- * @param boolean $notAllowEmpty
- * @param boolean $noRecursive
- * @return mixed
- */
- public function getPost($name=null, $filters=null, $defaultValue=null){ }
- /**
- * Gets a variable from put request
- *
- *<code>
- * $userEmail = $request->getPut("user_email");
- *
- * $userEmail = $request->getPut("user_email", "email");
- *</code>
- *
- * @param string $name
- * @param string|array $filters
- * @param mixed $defaultValue
- * @param boolean $notAllowEmpty
- * @param boolean $noRecursive
- * @return mixed
- */
- public function getPut($name=null, $filters=null, $defaultValue=null){ }
- /**
- * Gets variable from $_GET superglobal applying filters if needed
- * If no parameters are given the $_GET superglobal is returned
- *
- *<code>
- * //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);
- *</code>
- *
- * @param string $name
- * @param string|array $filters
- * @param mixed $defaultValue
- * @param boolean $notAllowEmpty
- * @param boolean $noRecursive
- * @return mixed
- */
- public function getQuery($name=null, $filters=null, $defaultValue=null){ }
- /**
- * Gets variable from $_SERVER superglobal
- *
- * @param string $name
- * @return mixed
- */
- public function getServer($name){ }
- /**
- * Checks whether $_REQUEST superglobal has certain index
- *
- * @param string $name
- * @return boolean
- */
- public function has($name){ }
- /**
- * Checks whether $_POST superglobal has certain index
- *
- * @param string $name
- * @return boolean
- */
- public function hasPost($name){ }
- /**
- * Checks whether put has certain index
- *
- * @param string $name
- * @return boolean
- */
- public function hasPut($name){ }
- /**
- * Checks whether $_GET superglobal has certain index
- *
- * @param string $name
- * @return boolean
- */
- public function hasQuery($name){ }
- /**
- * Checks whether $_SERVER superglobal has certain index
- *
- * @param string $name
- * @return mixed
- */
- public function hasServer($name){ }
- /**
- * Gets HTTP header from request data
- *
- * @param string $header
- * @return string
- */
- public function getHeader($header){ }
- /**
- * Gets HTTP schema (http/https)
- *
- * @return string
- */
- public function getScheme(){ }
- /**
- * Checks whether request has been made using ajax. Checks if $_SERVER['HTTP_X_REQUESTED_WITH']=='XMLHttpRequest'
- *
- * @return boolean
- */
- public function isAjax(){ }
- /**
- * Checks whether request has been made using SOAP
- *
- * @return boolean
- */
- public function isSoapRequested(){ }
- /**
- * Checks whether request has been made using any secure layer
- *
- * @return boolean
- */
- public function isSecureRequest(){ }
- /**
- * Gets HTTP raw request body
- *
- * @return string
- */
- public function getRawBody(){ }
- /**
- * Gets decoded JSON HTTP raw request body
- *
- * @param bool $assoc
- * @return string
- */
- public function getJsonRawBody(){ }
- /**
- * Gets active server address IP
- *
- * @return string
- */
- public function getServerAddress(){ }
- /**
- * Gets active server name
- *
- * @return string
- */
- public function getServerName(){ }
- /**
- * Gets information about schema, host and port used by the request
- *
- * @return string
- */
- public function getHttpHost(){ }
- /**
- * Gets most possible client IPv4 Address. This method search in $_SERVER['REMOTE_ADDR'] and optionally in $_SERVER['HTTP_X_FORWARDED_FOR']
- *
- * @param boolean $trustForwardedHeader
- * @return string
- */
- public function getClientAddress($trustForwardedHeader=null){ }
- /**
- * Gets HTTP method which request has been made
- *
- * @return string
- */
- public function getMethod(){ }
- /**
- * Gets HTTP URI which request has been made
- *
- * @return string
- */
- public function getURI(){ }
- /**
- * Gets HTTP user agent used to made the request
- *
- * @return string
- */
- public function getUserAgent(){ }
- /**
- * Check if HTTP method match any of the passed methods
- *
- * @param string|array $methods
- * @return boolean
- */
- public function isMethod($methods){ }
- /**
- * Checks whether HTTP method is POST. if $_SERVER['REQUEST_METHOD']=='POST'
- *
- * @return boolean
- */
- public function isPost(){ }
- /**
- * Checks whether HTTP method is GET. if $_SERVER['REQUEST_METHOD']=='GET'
- *
- * @return boolean
- */
- public function isGet(){ }
- /**
- * Checks whether HTTP method is PUT. if $_SERVER['REQUEST_METHOD']=='PUT'
- *
- * @return boolean
- */
- public function isPut(){ }
- /**
- * Checks whether HTTP method is PATCH. if $_SERVER['REQUEST_METHOD']=='PATCH'
- *
- * @return boolean
- */
- public function isPatch(){ }
- /**
- * Checks whether HTTP method is HEAD. if $_SERVER['REQUEST_METHOD']=='HEAD'
- *
- * @return boolean
- */
- public function isHead(){ }
- /**
- * Checks whether HTTP method is DELETE. if $_SERVER['REQUEST_METHOD']=='DELETE'
- *
- * @return boolean
- */
- public function isDelete(){ }
- /**
- * Checks whether HTTP method is OPTIONS. if $_SERVER['REQUEST_METHOD']=='OPTIONS'
- *
- * @return boolean
- */
- public function isOptions(){ }
- /**
- * Checks whether request includes attached files
- *
- * @return boolean
- */
- public function hasFiles($notErrored=null){ }
- /**
- * Gets attached files as \Phalcon\Http\Request\File instances
- *
- * @param boolean $notErrored
- * @return \Phalcon\Http\Request\File[]
- */
- public function getUploadedFiles($notErrored=null){ }
- /**
- * Returns the available headers in the request
- *
- * @return array
- */
- public function getHeaders(){ }
- /**
- * Gets web page that refers active request. ie: http://www.google.com
- *
- * @return string
- */
- public function getHTTPReferer(){ }
- /**
- * Process a request header and return an array of values with their qualities
- *
- * @param string $serverIndex
- * @param string $name
- * @return array
- */
- protected function _getQualityHeader(){ }
- /**
- * Process a request header and return the one with best quality
- *
- * @param array $qualityParts
- * @param string $name
- * @return string
- */
- protected function _getBestQuality(){ }
- /**
- * Gets array with mime/types and their quality accepted by the browser/client from $_SERVER['HTTP_ACCEPT']
- *
- * @return array
- */
- public function getAcceptableContent(){ }
- /**
- * Gets best mime/type accepted by the browser/client from $_SERVER['HTTP_ACCEPT']
- *
- * @return array
- */
- public function getBestAccept(){ }
- /**
- * Gets charsets array and their quality accepted by the browser/client from $_SERVER['HTTP_ACCEPT_CHARSET']
- *
- * @return array
- */
- public function getClientCharsets(){ }
- /**
- * Gets best charset accepted by the browser/client from $_SERVER['HTTP_ACCEPT_CHARSET']
- *
- * @return string
- */
- public function getBestCharset(){ }
- /**
- * Gets languages array and their quality accepted by the browser/client from $_SERVER['HTTP_ACCEPT_LANGUAGE']
- *
- * @return array
- */
- public function getLanguages(){ }
- /**
- * Gets best language accepted by the browser/client from $_SERVER['HTTP_ACCEPT_LANGUAGE']
- *
- * @return string
- */
- public function getBestLanguage(){ }
- /**
- * Gets auth info accepted by the browser/client from $_SERVER['PHP_AUTH_USER']
- *
- * @return array
- */
- public function getBasicAuth(){ }
- /**
- * Gets auth info accepted by the browser/client from $_SERVER['PHP_AUTH_DIGEST']
- *
- * @return array
- */
- public function getDigestAuth(){ }
- }
- }