API Documentation

Zend/Controller/Request/Http.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Version
$Id: Http.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Request_Http

Package: Zend\Controller\Request

Zend_Controller_Request_Http

HTTP request object for use with Zend_Controller family.

Parent(s)
\Zend_Controller_Request_Abstract
Children
\Zend_Controller_Request_Apache404
\Zend_Controller_Request_HttpTestCase
Used_by
\Zend_Controller_Request_Apache404  
Used_by
\Zend_Controller_Request_HttpTestCase  
Uses
\Zend_Controller_Request_Abstract  

Constants

Constant  SCHEME_HTTP = 'http'

Scheme for http

Constant  SCHEME_HTTPS = 'https'

Scheme for https

Properties

Propertyprotectedarray  $_aliases= 'array()'

Alias keys for request parameters

Default valuearray()Details
Type
array
Propertyprotectedstring  $_basePath= 'null'

Base path of request

Default valuenullDetails
Type
string
Propertyprotectedstring  $_baseUrl= 'null'

Base URL of request

Default valuenullDetails
Type
string
Propertyprotectedarray  $_paramSources= 'array('_GET''

Allowed parameter sources

Default valuearray('_GET'Details
Type
array
Propertyprotectedarray  $_params= 'array()'

Instance parameters

Default valuearray()Details
Type
array
Propertyprotectedstring  $_pathInfo= ''''

PATH_INFO

Default value''Details
Type
string
Propertyprotectedstring|false  $_rawBody= ''

Raw request body

Details
Type
stringfalse
Propertyprotected\string;  $_requestUri= ''

REQUEST_URI

Details
Type
\string;

Methods

methodpublic__construct( string|\Zend_Uri $uri = null ) : void

Constructor

If a $uri is passed, the object will attempt to populate itself using that information.

Parameters
Name Type Description
$uri string|\Zend_Uri
Throws
Exception Description
\Zend_Controller_Request_Exception when invalid URI passed
methodpublic__get( string $key ) : mixed

Access values contained in the superglobals as public members Order of precedence: 1. GET, 2. POST, 3. COOKIE, 4. SERVER, 5. ENV

Parameters
Name Type Description
$key string
Returns
Type Description
mixed
Details
See
\http://msdn.microsoft.com/en-us/library/system.web.httprequest.item.aspx  
methodpublic__isset( string $key ) : boolean

Check to see if a property is set

Parameters
Name Type Description
$key string
Returns
Type Description
boolean
methodpublic__set( string $key, mixed $value ) : void

Set values

In order to follow {@link __get()}, which operates on a number of superglobals, setting values through overloading is not allowed and will raise an exception. Use setParam() instead.

Parameters
Name Type Description
$key string
$value mixed
Throws
Exception Description
\Zend_Controller_Request_Exception
methodpublicget( string $key ) : mixed

Alias to __get

Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetAlias( string $name ) : string|null

Retrieve an alias

Retrieve the actual key represented by the alias $name.

Parameters
Name Type Description
$name string
Returns
Type Description
string|null Returns null when no alias exists
methodpublicgetAliases( ) : array

Retrieve the list of all aliases

Returns
Type Description
array
methodpublicgetBasePath( ) : string

Everything in REQUEST_URI before PATH_INFO not including the filename

Returns
Type Description
string
methodpublicgetBaseUrl(  $raw = false ) : string

Everything in REQUEST_URI before PATH_INFO

Parameters
Name Type Description
$raw
Returns
Type Description
string
methodpublicgetClientIp( boolean $checkProxy = true ) : string

Get the client's IP addres

Parameters
Name Type Description
$checkProxy boolean
Returns
Type Description
string
methodpublicgetCookie( string $key = null, mixed $default = null ) : mixed

Retrieve a member of the $_COOKIE superglobal

If no $key is passed, returns the entire $_COOKIE array.

Parameters
Name Type Description
$key string
$default mixed

Default value to use if key not found

Returns
Type Description
mixed Returns null if key does not exist
Details
Todo
How to retrieve from nested arrays  
methodpublicgetEnv( string $key = null, mixed $default = null ) : mixed

Retrieve a member of the $_ENV superglobal

If no $key is passed, returns the entire $_ENV array.

Parameters
Name Type Description
$key string
$default mixed

Default value to use if key not found

Returns
Type Description
mixed Returns null if key does not exist
methodpublicgetHeader( string $header ) : string|false

Return the value of the given HTTP header. Pass the header name as the plain, HTTP-specified header name. Ex.: Ask for 'Accept' to get the Accept header, 'Accept-Encoding' to get the Accept-Encoding header.

Parameters
Name Type Description
$header string

HTTP header name

Returns
Type Description
string|false HTTP header value, or false if not found
Throws
Exception Description
\Zend_Controller_Request_Exception
methodpublicgetHttpHost( ) : string

Get the HTTP host.

"Host" ":" host [ ":" port ] ; Section 3.2.2 Note the HTTP Host header is not the same as the URI host. It includes the port while the URI host doesn't.

Returns
Type Description
string
methodpublicgetMethod( ) : string

Return the method by which the request was made

Returns
Type Description
string
methodpublicgetParam( mixed $key, mixed $default = null ) : mixed

Retrieve a parameter

Retrieves a parameter from the instance. Priority is in the order of userland parameters (see {@link setParam()}), $_GET, $_POST. If a parameter matching the $key is not found, null is returned.

If the $key is an alias, the actual key aliased will be used.

Parameters
Name Type Description
$key mixed
$default mixed

Default value to use if key not found

Returns
Type Description
mixed
methodpublicgetParamSources( ) : array

Get list of allowed parameter sources

Returns
Type Description
array
methodpublicgetParams( ) : array

Retrieve an array of parameters

Retrieves a merged array of parameters, with precedence of userland params (see {@link setParam()}), $_GET, $_POST (i.e., values in the userland params will take precedence over all others).

Returns
Type Description
array
methodpublicgetPathInfo( ) : string

Returns everything between the BaseUrl and QueryString.

This value is calculated instead of reading PATH_INFO directly from $_SERVER due to cross-platform differences.

Returns
Type Description
string
methodpublicgetPost( string $key = null, mixed $default = null ) : mixed

Retrieve a member of the $_POST superglobal

If no $key is passed, returns the entire $_POST array.

Parameters
Name Type Description
$key string
$default mixed

Default value to use if key not found

Returns
Type Description
mixed Returns null if key does not exist
Details
Todo
How to retrieve from nested arrays  
methodpublicgetQuery( string $key = null, mixed $default = null ) : mixed

Retrieve a member of the $_GET superglobal

If no $key is passed, returns the entire $_GET array.

Parameters
Name Type Description
$key string
$default mixed

Default value to use if key not found

Returns
Type Description
mixed Returns null if key does not exist
Details
Todo
How to retrieve from nested arrays  
methodpublicgetRawBody( ) : string|false

Return the raw body of the request, if present

Returns
Type Description
string|false Raw body, or false if not present
methodpublicgetRequestUri( ) : string

Returns the REQUEST_URI taking into account platform differences between Apache and IIS

Returns
Type Description
string
methodpublicgetScheme( ) : string

Get the request URI scheme

Returns
Type Description
string
methodpublicgetServer( string $key = null, mixed $default = null ) : mixed

Retrieve a member of the $_SERVER superglobal

If no $key is passed, returns the entire $_SERVER array.

Parameters
Name Type Description
$key string
$default mixed

Default value to use if key not found

Returns
Type Description
mixed Returns null if key does not exist
methodpublichas( string $key ) : boolean

Alias to __isset()

Parameters
Name Type Description
$key string
Returns
Type Description
boolean
methodpublicisDelete( ) : boolean

Was the request made by DELETE?

Returns
Type Description
boolean
methodpublicisFlashRequest( ) : boolean

Is this a Flash request?

Returns
Type Description
boolean
methodpublicisGet( ) : boolean

Was the request made by GET?

Returns
Type Description
boolean
methodpublicisHead( ) : boolean

Was the request made by HEAD?

Returns
Type Description
boolean
methodpublicisOptions( ) : boolean

Was the request made by OPTIONS?

Returns
Type Description
boolean
methodpublicisPost( ) : boolean

Was the request made by POST?

Returns
Type Description
boolean
methodpublicisPut( ) : boolean

Was the request made by PUT?

Returns
Type Description
boolean
methodpublicisSecure( ) : boolean

Is https secure request

Returns
Type Description
boolean
methodpublicisXmlHttpRequest( ) : boolean

Is the request a Javascript XMLHttpRequest?

Should work with Prototype/Script.aculo.us, possibly others.

Returns
Type Description
boolean
methodpublicset( string $key, mixed $value ) : void

Alias to __set()

Parameters
Name Type Description
$key string
$value mixed
methodpublicsetAlias( string $name, string $target ) : \Zend_Controller_Request_Http

Set a key alias

Set an alias used for key lookups. $name specifies the alias, $target specifies the actual key to use.

Parameters
Name Type Description
$name string
$target string
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetBasePath( string|null $basePath = null ) : \Zend_Controller_Request_Http

Set the base path for the URL

Parameters
Name Type Description
$basePath string|null
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetBaseUrl( mixed $baseUrl = null ) : \Zend_Controller_Request_Http

Set the base URL of the request; i.e., the segment leading to the script name

E.g.: - /admin - /myapp - /subdir/index.php

Do not use the full URI when providing the base. The following are examples of what not to use: - http://example.com/admin (should be just /admin) - http://example.com/subdir/index.php (should be just /subdir/index.php)

If no $baseUrl is provided, attempts to determine the base URL from the environment, using SCRIPT_FILENAME, SCRIPT_NAME, PHP_SELF, and ORIG_SCRIPT_NAME in its determination.

Parameters
Name Type Description
$baseUrl mixed
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetParam( mixed $key, mixed $value ) : \Zend_Controller_Request_Http

Set a userland parameter

Uses $key to set a userland parameter. If $key is an alias, the actual key will be retrieved and used to set the parameter.

Parameters
Name Type Description
$key mixed
$value mixed
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetParamSources(  $paramSources = array() ) : \Zend_Controller_Request_Http

Set allowed parameter sources

Can be empty array, or contain one or more of '_GET' or '_POST'.

Parameters
Name Type Description
$paramSources
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetParams( array $params ) : \Zend_Controller_Request_Http

Set parameters

Set one or more parameters. Parameters are set as userland parameters, using the keys specified in the array.

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetPathInfo( string|null $pathInfo = null ) : \Zend_Controller_Request_Http

Set the PATH_INFO string

Parameters
Name Type Description
$pathInfo string|null
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetPost( string|array $spec, null|mixed $value = null ) : \Zend_Controller_Request_Http

Set POST values

Parameters
Name Type Description
$spec string|array
$value null|mixed
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetQuery( string|array $spec, null|mixed $value = null ) : \Zend_Controller_Request_Http

Set GET values

Parameters
Name Type Description
$spec string|array
$value null|mixed
Returns
Type Description
\Zend_Controller_Request_Http
methodpublicsetRequestUri( string $requestUri = null ) : \Zend_Controller_Request_Http

Set the REQUEST_URI on which the instance operates

If no request URI is passed, uses the value in $_SERVER['REQUEST_URI'], $_SERVER['HTTP_X_REWRITE_URL'], or $_SERVER['ORIG_PATH_INFO'] + $_SERVER['QUERY_STRING'].

Parameters
Name Type Description
$requestUri string
Returns
Type Description
\Zend_Controller_Request_Http
Documentation was generated by DocBlox 0.15.1.