Controller/Request/Http.php

Show:

inherited

Classes
- \Zend_Controller_Request_Http

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 [email protected] 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 24842 2012-05-31 18:31:28Z rob $

\Zend_Controller_Request_Http
jump to top

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
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
Uses: \global\Zend_Controller_Request_Abstract

Constants

 
                SCHEME_HTTP
                = 'http'

Scheme for http

 
                SCHEME_HTTPS
                = 'https'

Scheme for https

Properties

string $_action =

inherited

Action

Inherited from: \Zend_Controller_Request_Abstract::$$_action

Details

Type: string
Inherited_from: \Zend_Controller_Request_Abstract::$$_action

string $_actionKey = 'action'

inherited

Action key for retrieving action from params

Inherited from: \Zend_Controller_Request_Abstract::$$_actionKey

Default value'action'Details

Type: string
Inherited_from: \Zend_Controller_Request_Abstract::$$_actionKey

array $_aliases = array()

Alias keys for request parameters

Default valuearray()Details

Type: array

string $_basePath = null

Base path of request

Default valuenullDetails

Type: string

string $_baseUrl = null

Base URL of request

Default valuenullDetails

Type: string

string $_controller =

inherited

Controller

Inherited from: \Zend_Controller_Request_Abstract::$$_controller

Details

Type: string
Inherited_from: \Zend_Controller_Request_Abstract::$$_controller

string $_controllerKey = 'controller'

inherited

Controller key for retrieving controller from params

Inherited from: \Zend_Controller_Request_Abstract::$$_controllerKey

Default value'controller'Details

Type: string
Inherited_from: \Zend_Controller_Request_Abstract::$$_controllerKey

boolean $_dispatched = false

inherited

Has the action been dispatched?

Inherited from: \Zend_Controller_Request_Abstract::$$_dispatched

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Controller_Request_Abstract::$$_dispatched

string $_module =

inherited

Module

Inherited from: \Zend_Controller_Request_Abstract::$$_module

Details

Type: string
Inherited_from: \Zend_Controller_Request_Abstract::$$_module

string $_moduleKey = 'module'

inherited

Module key for retrieving module from params

Inherited from: \Zend_Controller_Request_Abstract::$$_moduleKey

Default value'module'Details

Type: string
Inherited_from: \Zend_Controller_Request_Abstract::$$_moduleKey

array $_paramSources = array('_GET', '_POST')

Allowed parameter sources

Default valuearray('_GET', '_POST')Details

Type: array

array $_params = array()

Instance parameters

Default valuearray()Details

Type: array

string $_pathInfo = ''

PATH_INFO

Default value''Details

Type: string

string|false $_rawBody =

Raw request body

Details

Type: string | false

\string; $_requestUri =

REQUEST_URI

Details

Type: \string;

Methods

__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

__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: \global\http://msdn.microsoft.com/en-us/library/system.web.httprequest.item.aspx

__isset(string $key) : boolean

Check to see if a property is set

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
boolean

__set(string $key, mixed $value) : void

Set values

In order to follow __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

clearParams() : \Zend_Controller_Request_Abstract

inherited

Unset all user parameters

Inherited from: \Zend_Controller_Request_Abstract::clearParams()

Returns

Type	Description
\Zend_Controller_Request_Abstract

get(string $key) : mixed

Alias to __get

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getActionKey() : string

inherited

Retrieve the action key

Inherited from: \Zend_Controller_Request_Abstract::getActionKey()

Returns

Type	Description
string

getActionName() : string

inherited

Retrieve the action name

Inherited from: \Zend_Controller_Request_Abstract::getActionName()

Returns

Type	Description
string

getAlias(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

getAliases() : array

Retrieve the list of all aliases

Returns

Type	Description
array

getBasePath() : string

Everything in REQUEST_URI before PATH_INFO not including the filename

Returns

Type	Description
string

getBaseUrl( $raw = false) : string

Everything in REQUEST_URI before PATH_INFO

Parameters

Name	Type	Description
$raw

Returns

Type	Description
string

getClientIp(boolean $checkProxy = true) : string

Get the client's IP addres

Parameters

Name	Type	Description
$checkProxy	boolean

Returns

Type	Description
string

getControllerKey() : string

inherited

Retrieve the controller key

Inherited from: \Zend_Controller_Request_Abstract::getControllerKey()

Returns

Type	Description
string

getControllerName() : string

inherited

Retrieve the controller name

Inherited from: \Zend_Controller_Request_Abstract::getControllerName()

Returns

Type	Description
string

getCookie(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

getEnv(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

getHeader(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

getHttpHost() : 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

getMethod() : string

Return the method by which the request was made

Returns

Type	Description
string

getModuleKey() : string

inherited

Retrieve the module key

Inherited from: \Zend_Controller_Request_Abstract::getModuleKey()

Returns

Type	Description
string

getModuleName() : string

inherited

Retrieve the module name

Inherited from: \Zend_Controller_Request_Abstract::getModuleName()

Returns

Type	Description
string

getParam(mixed $key, mixed $default = null) : mixed

Retrieve a parameter

Retrieves a parameter from the instance. Priority is in the order of userland parameters (see 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

getParamSources() : array

Get list of allowed parameter sources

Returns

Type	Description
array

getParams() : array

Retrieve an array of parameters

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

Returns

Type	Description
array

getPathInfo() : 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

getPost(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

getQuery(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

getRawBody() : string | false

Return the raw body of the request, if present

Returns

Type	Description
string \| false	Raw body, or false if not present

getRequestUri() : string

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

Returns

Type	Description
string

getScheme() : string

Get the request URI scheme

Returns

Type	Description
string

getServer(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

getUserParam(string $key, string $default = null) : mixed

inherited

Retrieve a single user param (i.e, a param specific to the object and not the environment)

Inherited from: \Zend_Controller_Request_Abstract::getUserParam()

Parameters

Name	Type	Description
$key	string
$default	string	Default value to use if key not found

Returns

Type	Description
mixed

getUserParams() : array

inherited

Retrieve only user params (i.e, any param specific to the object and not the environment)

Inherited from: \Zend_Controller_Request_Abstract::getUserParams()

Returns

Type	Description
array

has(string $key) : boolean

Alias to __isset()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
boolean

isDelete() : boolean

Was the request made by DELETE?

Returns

Type	Description
boolean

isDispatched() : boolean

inherited

Determine if the request has been dispatched

Inherited from: \Zend_Controller_Request_Abstract::isDispatched()

Returns

Type	Description
boolean

isFlashRequest() : boolean

Is this a Flash request?

Returns

Type	Description
boolean

isGet() : boolean

Was the request made by GET?

Returns

Type	Description
boolean

isHead() : boolean

Was the request made by HEAD?

Returns

Type	Description
boolean

isOptions() : boolean

Was the request made by OPTIONS?

Returns

Type	Description
boolean

isPost() : boolean

Was the request made by POST?

Returns

Type	Description
boolean

isPut() : boolean

Was the request made by PUT?

Returns

Type	Description
boolean

isSecure() : boolean

Is https secure request

Returns

Type	Description
boolean

isXmlHttpRequest() : boolean

Is the request a Javascript XMLHttpRequest?

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

Returns

Type	Description
boolean

set(string $key, mixed $value) : void

Alias to __set()

Parameters

Name	Type	Description
$key	string
$value	mixed

setActionKey(string $key) : \Zend_Controller_Request_Abstract

inherited

Set the action key

Inherited from: \Zend_Controller_Request_Abstract::setActionKey()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setActionName(string $value) : \Zend_Controller_Request_Abstract

inherited

Set the action name

Inherited from: \Zend_Controller_Request_Abstract::setActionName()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setAlias(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

setBasePath(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

setBaseUrl(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

setControllerKey(string $key) : \Zend_Controller_Request_Abstract

inherited

Set the controller key

Inherited from: \Zend_Controller_Request_Abstract::setControllerKey()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setControllerName(string $value) : \Zend_Controller_Request_Abstract

inherited

Set the controller name to use

Inherited from: \Zend_Controller_Request_Abstract::setControllerName()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setDispatched(boolean $flag = true) : \Zend_Controller_Request_Abstract

inherited

Set flag indicating whether or not request has been dispatched

Inherited from: \Zend_Controller_Request_Abstract::setDispatched()

Parameters

Name	Type	Description
$flag	boolean

Returns

Type	Description
\Zend_Controller_Request_Abstract

setModuleKey(string $key) : \Zend_Controller_Request_Abstract

inherited

Set the module key

Inherited from: \Zend_Controller_Request_Abstract::setModuleKey()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setModuleName(string $value) : \Zend_Controller_Request_Abstract

inherited

Set the module name to use

Inherited from: \Zend_Controller_Request_Abstract::setModuleName()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setParam(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

setParamSources( $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

setParams(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

setPathInfo(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

setPost(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

setQuery(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

setRequestUri(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

Controller/Request/Http.php

\Zend_Controller_Request_Httpjump to top

Constants

Properties

Methods

\Zend_Controller_Request_Http
jump to top