Файл: concrete5.7.5.6/concrete/vendor/zendframework/zend-http/src/Request.php
Строк: 476
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace ZendHttp;
use ZendStdlibParameters;
use ZendStdlibParametersInterface;
use ZendStdlibRequestInterface;
use ZendUriException as UriException;
use ZendUriHttp as HttpUri;
/**
* HTTP Request
*
* @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5
*/
class Request extends AbstractMessage implements RequestInterface
{
/**#@+
* @const string METHOD constant names
*/
const METHOD_OPTIONS = 'OPTIONS';
const METHOD_GET = 'GET';
const METHOD_HEAD = 'HEAD';
const METHOD_POST = 'POST';
const METHOD_PUT = 'PUT';
const METHOD_DELETE = 'DELETE';
const METHOD_TRACE = 'TRACE';
const METHOD_CONNECT = 'CONNECT';
const METHOD_PATCH = 'PATCH';
const METHOD_PROPFIND = 'PROPFIND';
/**#@-*/
/**
* @var string
*/
protected $method = self::METHOD_GET;
/**
* @var string|HttpUri
*/
protected $uri = null;
/**
* @var ParametersInterface
*/
protected $queryParams = null;
/**
* @var ParametersInterface
*/
protected $postParams = null;
/**
* @var ParametersInterface
*/
protected $fileParams = null;
/**
* A factory that produces a Request object from a well-formed Http Request string
*
* @param string $string
* @return Request
* @throws ExceptionInvalidArgumentException
*/
public static function fromString($string)
{
$request = new static();
$lines = explode("rn", $string);
// first line must be Method/Uri/Version string
$matches = null;
$methods = implode('|', array(
self::METHOD_OPTIONS, self::METHOD_GET, self::METHOD_HEAD, self::METHOD_POST,
self::METHOD_PUT, self::METHOD_DELETE, self::METHOD_TRACE, self::METHOD_CONNECT,
self::METHOD_PATCH
));
$regex = '#^(?P<method>' . $methods . ')s(?P<uri>[^ ]*)(?:sHTTP/(?P<version>d+.d+)){0,1}#';
$firstLine = array_shift($lines);
if (!preg_match($regex, $firstLine, $matches)) {
throw new ExceptionInvalidArgumentException(
'A valid request line was not found in the provided string'
);
}
$request->setMethod($matches['method']);
$request->setUri($matches['uri']);
if (isset($matches['version'])) {
$request->setVersion($matches['version']);
}
if (count($lines) == 0) {
return $request;
}
$isHeader = true;
$headers = $rawBody = array();
while ($lines) {
$nextLine = array_shift($lines);
if ($nextLine == '') {
$isHeader = false;
continue;
}
if ($isHeader) {
$headers[] = $nextLine;
} else {
$rawBody[] = $nextLine;
}
}
if ($headers) {
$request->headers = implode("rn", $headers);
}
if ($rawBody) {
$request->setContent(implode("rn", $rawBody));
}
return $request;
}
/**
* Set the method for this request
*
* @param string $method
* @return Request
* @throws ExceptionInvalidArgumentException
*/
public function setMethod($method)
{
$method = strtoupper($method);
if (!defined('static::METHOD_' . $method)) {
throw new ExceptionInvalidArgumentException('Invalid HTTP method passed');
}
$this->method = $method;
return $this;
}
/**
* Return the method for this request
*
* @return string
*/
public function getMethod()
{
return $this->method;
}
/**
* Set the URI/URL for this request, this can be a string or an instance of ZendUriHttp
*
* @throws ExceptionInvalidArgumentException
* @param string|HttpUri $uri
* @return Request
*/
public function setUri($uri)
{
if (is_string($uri)) {
try {
$uri = new HttpUri($uri);
} catch (UriExceptionInvalidUriPartException $e) {
throw new ExceptionInvalidArgumentException(
sprintf('Invalid URI passed as string (%s)', (string) $uri),
$e->getCode(),
$e
);
}
} elseif (!($uri instanceof HttpUri)) {
throw new ExceptionInvalidArgumentException(
'URI must be an instance of ZendUriHttp or a string'
);
}
$this->uri = $uri;
return $this;
}
/**
* Return the URI for this request object
*
* @return HttpUri
*/
public function getUri()
{
if ($this->uri === null || is_string($this->uri)) {
$this->uri = new HttpUri($this->uri);
}
return $this->uri;
}
/**
* Return the URI for this request object as a string
*
* @return string
*/
public function getUriString()
{
if ($this->uri instanceof HttpUri) {
return $this->uri->toString();
}
return $this->uri;
}
/**
* Provide an alternate Parameter Container implementation for query parameters in this object,
* (this is NOT the primary API for value setting, for that see getQuery())
*
* @param ZendStdlibParametersInterface $query
* @return Request
*/
public function setQuery(ParametersInterface $query)
{
$this->queryParams = $query;
return $this;
}
/**
* Return the parameter container responsible for query parameters or a single query parameter
*
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing.
* @return ZendStdlibParametersInterface|mixed
*/
public function getQuery($name = null, $default = null)
{
if ($this->queryParams === null) {
$this->queryParams = new Parameters();
}
if ($name === null) {
return $this->queryParams;
}
return $this->queryParams->get($name, $default);
}
/**
* Provide an alternate Parameter Container implementation for post parameters in this object,
* (this is NOT the primary API for value setting, for that see getPost())
*
* @param ZendStdlibParametersInterface $post
* @return Request
*/
public function setPost(ParametersInterface $post)
{
$this->postParams = $post;
return $this;
}
/**
* Return the parameter container responsible for post parameters or a single post parameter.
*
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing.
* @return ZendStdlibParametersInterface|mixed
*/
public function getPost($name = null, $default = null)
{
if ($this->postParams === null) {
$this->postParams = new Parameters();
}
if ($name === null) {
return $this->postParams;
}
return $this->postParams->get($name, $default);
}
/**
* Return the Cookie header, this is the same as calling $request->getHeaders()->get('Cookie');
*
* @convenience $request->getHeaders()->get('Cookie');
* @return HeaderCookie
*/
public function getCookie()
{
return $this->getHeaders()->get('Cookie');
}
/**
* Provide an alternate Parameter Container implementation for file parameters in this object,
* (this is NOT the primary API for value setting, for that see getFiles())
*
* @param ParametersInterface $files
* @return Request
*/
public function setFiles(ParametersInterface $files)
{
$this->fileParams = $files;
return $this;
}
/**
* Return the parameter container responsible for file parameters or a single file.
*
* @param string|null $name Parameter name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the parameter is missing.
* @return ParametersInterface|mixed
*/
public function getFiles($name = null, $default = null)
{
if ($this->fileParams === null) {
$this->fileParams = new Parameters();
}
if ($name === null) {
return $this->fileParams;
}
return $this->fileParams->get($name, $default);
}
/**
* Return the header container responsible for headers or all headers of a certain name/type
*
* @see ZendHttpHeaders::get()
* @param string|null $name Header name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the requested header is missing.
* @return ZendHttpHeaders|bool|ZendHttpHeaderHeaderInterface|ArrayIterator
*/
public function getHeaders($name = null, $default = false)
{
if ($this->headers === null || is_string($this->headers)) {
// this is only here for fromString lazy loading
$this->headers = (is_string($this->headers)) ? Headers::fromString($this->headers) : new Headers();
}
if ($name === null) {
return $this->headers;
}
if ($this->headers->has($name)) {
return $this->headers->get($name);
}
return $default;
}
/**
* Get all headers of a certain name/type.
*
* @see Request::getHeaders()
* @param string|null $name Header name to retrieve, or null to get the whole container.
* @param mixed|null $default Default value to use when the requested header is missing.
* @return ZendHttpHeaders|bool|ZendHttpHeaderHeaderInterface|ArrayIterator
*/
public function getHeader($name, $default = false)
{
return $this->getHeaders($name, $default);
}
/**
* Is this an OPTIONS method request?
*
* @return bool
*/
public function isOptions()
{
return ($this->method === self::METHOD_OPTIONS);
}
/**
* Is this a PROPFIND method request?
*
* @return bool
*/
public function isPropFind()
{
return ($this->method === self::METHOD_PROPFIND);
}
/**
* Is this a GET method request?
*
* @return bool
*/
public function isGet()
{
return ($this->method === self::METHOD_GET);
}
/**
* Is this a HEAD method request?
*
* @return bool
*/
public function isHead()
{
return ($this->method === self::METHOD_HEAD);
}
/**
* Is this a POST method request?
*
* @return bool
*/
public function isPost()
{
return ($this->method === self::METHOD_POST);
}
/**
* Is this a PUT method request?
*
* @return bool
*/
public function isPut()
{
return ($this->method === self::METHOD_PUT);
}
/**
* Is this a DELETE method request?
*
* @return bool
*/
public function isDelete()
{
return ($this->method === self::METHOD_DELETE);
}
/**
* Is this a TRACE method request?
*
* @return bool
*/
public function isTrace()
{
return ($this->method === self::METHOD_TRACE);
}
/**
* Is this a CONNECT method request?
*
* @return bool
*/
public function isConnect()
{
return ($this->method === self::METHOD_CONNECT);
}
/**
* Is this a PATCH method request?
*
* @return bool
*/
public function isPatch()
{
return ($this->method === self::METHOD_PATCH);
}
/**
* Is the request a Javascript XMLHttpRequest?
*
* Should work with Prototype/Script.aculo.us, possibly others.
*
* @return bool
*/
public function isXmlHttpRequest()
{
$header = $this->getHeaders()->get('X_REQUESTED_WITH');
return false !== $header && $header->getFieldValue() == 'XMLHttpRequest';
}
/**
* Is this a Flash request?
*
* @return bool
*/
public function isFlashRequest()
{
$header = $this->getHeaders()->get('USER_AGENT');
return false !== $header && stristr($header->getFieldValue(), ' flash');
}
/**
* Return the formatted request line (first line) for this http request
*
* @return string
*/
public function renderRequestLine()
{
return $this->method . ' ' . (string) $this->uri . ' HTTP/' . $this->version;
}
/**
* @return string
*/
public function toString()
{
$str = $this->renderRequestLine() . "rn";
$str .= $this->getHeaders()->toString();
$str .= "rn";
$str .= $this->getContent();
return $str;
}
}