Apache Zeta Components Manual :: File Source for request.php
Source for file request.php
Documentation is available at request.php
* File containing the ezcMvcRequest class
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* @version //autogentag//
* The request object holds the request data.
* The request object should be created by the request parser
* It may also be returned by the controller, in the case of an
* It holds the protocol dependant data in an ezcMvcRawRequest
* object that is held in property $raw.
* It holds several structs which contain some protocol abstract
* data in the following properties:
* - $files: array of instances of ezcMvcRequestFile.
* - $cache: instance of ezcMvcRequestCache
* - $content: instance of ezcMvcRequestContent
* - $agent: instance of ezcMvcRequestAgent
* - $authentication: instance of ezcMvcRequestAuthentication
* It holds request variables like an array. For example, to hold
* a 'controller' GET variable in $request['controller'].
* @version //autogentag//
* Protocol description in a normalized form
* F.e. http-get, http-post, http-delete, mail, jabber
* Hostname of the requested server
* Uri of the requested resource
* Full Uri - combination of host name and uri in a protocol independent
* Request ID of the referring URI in the same format as $requestId
* Files bundled with the request.
* @var array(ezcMvcRequestFile)
* Request content type informations.
* @var ezcMvcRequestAccept
* Request user agent informations.
* @var ezcMvcRequestUserAgent
* Request authentication data.
* @var ezcMvcRequestAuthentication
* Contains all the cookies to be set
* @var array(ezcMvcRequestCookie)
* Whether this is a fatal error request, or a normal one
* Constructs a new ezcMvcRequest.
* @param string $protocol
* @param string $requestId
* @param string $referrer
* @param array $variables
* @param array(ezcMvcRequestFile) $files
* @param ezcMvcRequestAccept $accept
* @param ezcMvcRequestUserAgent $agent
* @param ezcMvcRequestAuthentication $authentication
* @param ezcMvcRawRequest $raw
* @param array(ezcMvcRequestCookie) $cookies
public function __construct( $date =
null, $protocol =
'',
$host =
'', $uri =
'', $requestId =
'', $referrer =
'',
$variables =
array(), $body =
'', $files =
null, $accept =
null,
$agent =
null, $authentication =
null, $raw =
null, $cookies =
array(), $isFatal =
false )
* Returns a new instance of this class with the data specified by $array.
* $array contains all the data members of this class in the form:
* array('member_name'=>value).
* __set_state makes this class exportable with var_export.
* var_export() generates code, that calls this method when it
* @param array(string=>mixed) $array
return new ezcMvcRequest( $array['date'], $array['protocol'],
$array['host'], $array['uri'], $array['requestId'],
$array['referrer'], $array['variables'], $array['body'],
$array['files'], $array['accept'], $array['agent'],
$array['authentication'], $array['raw'], $array['cookies'],