Controller/Request/Apache404.php

Show:

inherited

Classes
- \Zend_Controller_Request_Apache404

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: Apache404.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Controller_Request_Apache404
jump to top

Package: Zend\Controller\Request

Zend_Controller_Request_Apache404

HTTP request object for use with Zend_Controller family. Extends basic HTTP request object to allow for two edge cases when using Apache: - Using Apache's 404 handler instead of mod_rewrite to direct requests - Using the PT flag in rewrite rules

In each case, the URL to check against is found in REDIRECT_URL, not REQUEST_URI.

Parent(s): \Zend_Controller_Request_Http < \Zend_Controller_Request_Abstract
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
Uses: \global\Zend_Controller_Request_Http

Constants

 
                SCHEME_HTTP
                = 'http'

inherited

Scheme for http

Inherited from: \Zend_Controller_Request_Http::SCHEME_HTTP

Inherited_from: \Zend_Controller_Request_Http::SCHEME_HTTP

 
                SCHEME_HTTPS
                = 'https'

inherited

Scheme for https

Inherited from: \Zend_Controller_Request_Http::SCHEME_HTTPS

Inherited_from: \Zend_Controller_Request_Http::SCHEME_HTTPS

Properties

string $_action =

inherited

Action

Inherited from: \Zend_Controller_Request_Abstract::$$_action \Zend_Controller_Request_Http::$$_action

Details

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

string $_actionKey = 'action'

inherited

Action key for retrieving action from params

Inherited from: \Zend_Controller_Request_Abstract::$$_actionKey \Zend_Controller_Request_Http::$$_actionKey

Default value'action'Details

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

array $_aliases = array()

inherited

Alias keys for request parameters

Inherited from: \Zend_Controller_Request_Http::$$_aliases

Default valuearray()Details

Type: array
Inherited_from: \Zend_Controller_Request_Http::$$_aliases

string $_basePath = null

inherited

Base path of request

Inherited from: \Zend_Controller_Request_Http::$$_basePath

Default valuenullDetails

Type: string
Inherited_from: \Zend_Controller_Request_Http::$$_basePath

string $_baseUrl = null

inherited

Base URL of request

Inherited from: \Zend_Controller_Request_Http::$$_baseUrl

Default valuenullDetails

Type: string
Inherited_from: \Zend_Controller_Request_Http::$$_baseUrl

string $_controller =

inherited

Controller

Inherited from: \Zend_Controller_Request_Abstract::$$_controller \Zend_Controller_Request_Http::$$_controller

Details

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

string $_controllerKey = 'controller'

inherited

Controller key for retrieving controller from params

Inherited from: \Zend_Controller_Request_Abstract::$$_controllerKey \Zend_Controller_Request_Http::$$_controllerKey

Default value'controller'Details

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

boolean $_dispatched = false

inherited

Has the action been dispatched?

Inherited from: \Zend_Controller_Request_Abstract::$$_dispatched \Zend_Controller_Request_Http::$$_dispatched

Default valuefalseDetails

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

string $_module =

inherited

Module

Inherited from: \Zend_Controller_Request_Abstract::$$_module \Zend_Controller_Request_Http::$$_module

Details

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

string $_moduleKey = 'module'

inherited

Module key for retrieving module from params

Inherited from: \Zend_Controller_Request_Abstract::$$_moduleKey \Zend_Controller_Request_Http::$$_moduleKey

Default value'module'Details

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

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

inherited

Allowed parameter sources

Inherited from: \Zend_Controller_Request_Http::$$_paramSources

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

Type: array
Inherited_from: \Zend_Controller_Request_Http::$$_paramSources

array $_params = array()

inherited

Instance parameters

Inherited from: \Zend_Controller_Request_Http::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Zend_Controller_Request_Http::$$_params

string $_pathInfo = ''

inherited

PATH_INFO

Inherited from: \Zend_Controller_Request_Http::$$_pathInfo

Default value''Details

Type: string
Inherited_from: \Zend_Controller_Request_Http::$$_pathInfo

string|false $_rawBody =

inherited

Raw request body

Inherited from: \Zend_Controller_Request_Http::$$_rawBody

Details

Type: string | false
Inherited_from: \Zend_Controller_Request_Http::$$_rawBody

\string; $_requestUri =

inherited

REQUEST_URI

Inherited from: \Zend_Controller_Request_Http::$$_requestUri

Details

Type: \string;
Inherited_from: \Zend_Controller_Request_Http::$$_requestUri

Methods

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

inherited

Constructor

Inherited from: \Zend_Controller_Request_Http::__construct()

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

inherited

Access values contained in the superglobals as public members Order of precedence: 1.

Inherited from: \Zend_Controller_Request_Http::__get()

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

inherited

Check to see if a property is set

Inherited from: \Zend_Controller_Request_Http::__isset()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
boolean

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

inherited

Set values

Inherited from: \Zend_Controller_Request_Http::__set()

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()\Zend_Controller_Request_Http::clearParams()

Returns

Type	Description
\Zend_Controller_Request_Abstract

get(string $key) : mixed

inherited

Alias to __get

Inherited from: \Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::getActionKey()

Returns

Type	Description
string

getActionName() : string

inherited

Retrieve the action name

Inherited from: \Zend_Controller_Request_Abstract::getActionName()\Zend_Controller_Request_Http::getActionName()

Returns

Type	Description
string

getAlias(string $name) : string | null

inherited

Retrieve an alias

Inherited from: \Zend_Controller_Request_Http::getAlias()

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

inherited

Retrieve the list of all aliases

Inherited from: \Zend_Controller_Request_Http::getAliases()

Returns

Type	Description
array

getBasePath() : string

inherited

Everything in REQUEST_URI before PATH_INFO not including the filename

Inherited from: \Zend_Controller_Request_Http::getBasePath()

Returns

Type	Description
string

getBaseUrl( $raw = false) : string

inherited

Everything in REQUEST_URI before PATH_INFO

Parameters

Name	Type	Description
$raw

Returns

Type	Description
string

getClientIp(boolean $checkProxy = true) : string

inherited

Get the client's IP addres

Inherited from: \Zend_Controller_Request_Http::getClientIp()

Parameters

Name	Type	Description
$checkProxy	boolean

Returns

Type	Description
string

getControllerKey() : string

inherited

Retrieve the controller key

Inherited from: \Zend_Controller_Request_Abstract::getControllerKey()\Zend_Controller_Request_Http::getControllerKey()

Returns

Type	Description
string

getControllerName() : string

inherited

Retrieve the controller name

Inherited from: \Zend_Controller_Request_Abstract::getControllerName()\Zend_Controller_Request_Http::getControllerName()

Returns

Type	Description
string

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

inherited

Retrieve a member of the $_COOKIE superglobal

Inherited from: \Zend_Controller_Request_Http::getCookie()

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

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

inherited

Retrieve a member of the $_ENV superglobal

Inherited from: \Zend_Controller_Request_Http::getEnv()

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

inherited

Return the value of the given HTTP header.

Inherited from: \Zend_Controller_Request_Http::getHeader()

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

inherited

Get the HTTP host.

Inherited from: \Zend_Controller_Request_Http::getHttpHost()

"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

inherited

Return the method by which the request was made

Inherited from: \Zend_Controller_Request_Http::getMethod()

Returns

Type	Description
string

getModuleKey() : string

inherited

Retrieve the module key

Inherited from: \Zend_Controller_Request_Abstract::getModuleKey()\Zend_Controller_Request_Http::getModuleKey()

Returns

Type	Description
string

getModuleName() : string

inherited

Retrieve the module name

Inherited from: \Zend_Controller_Request_Abstract::getModuleName()\Zend_Controller_Request_Http::getModuleName()

Returns

Type	Description
string

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

inherited

Retrieve a parameter

Inherited from: \Zend_Controller_Request_Http::getParam()

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

inherited

Get list of allowed parameter sources

Inherited from: \Zend_Controller_Request_Http::getParamSources()

Returns

Type	Description
array

getParams() : array

inherited

Retrieve an array of parameters

Inherited from: \Zend_Controller_Request_Http::getParams()

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

inherited

Returns everything between the BaseUrl and QueryString.

Inherited from: \Zend_Controller_Request_Http::getPathInfo()

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

inherited

Retrieve a member of the $_POST superglobal

Inherited from: \Zend_Controller_Request_Http::getPost()

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

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

inherited

Retrieve a member of the $_GET superglobal

Inherited from: \Zend_Controller_Request_Http::getQuery()

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

getRawBody() : string | false

inherited

Return the raw body of the request, if present

Inherited from: \Zend_Controller_Request_Http::getRawBody()

Returns

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

getRequestUri() : string

inherited

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

Inherited from: \Zend_Controller_Request_Http::getRequestUri()

Returns

Type	Description
string

getScheme() : string

inherited

Get the request URI scheme

Inherited from: \Zend_Controller_Request_Http::getScheme()

Returns

Type	Description
string

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

inherited

Retrieve a member of the $_SERVER superglobal

Inherited from: \Zend_Controller_Request_Http::getServer()

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()\Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::getUserParams()

Returns

Type	Description
array

has(string $key) : boolean

inherited

Alias to __isset()

Inherited from: \Zend_Controller_Request_Http::has()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
boolean

isDelete() : boolean

inherited

Was the request made by DELETE?

Inherited from: \Zend_Controller_Request_Http::isDelete()

Returns

Type	Description
boolean

isDispatched() : boolean

inherited

Determine if the request has been dispatched

Inherited from: \Zend_Controller_Request_Abstract::isDispatched()\Zend_Controller_Request_Http::isDispatched()

Returns

Type	Description
boolean

isFlashRequest() : boolean

inherited

Is this a Flash request?

Inherited from: \Zend_Controller_Request_Http::isFlashRequest()

Returns

Type	Description
boolean

isGet() : boolean

inherited

Was the request made by GET?

Inherited from: \Zend_Controller_Request_Http::isGet()

Returns

Type	Description
boolean

isHead() : boolean

inherited

Was the request made by HEAD?

Inherited from: \Zend_Controller_Request_Http::isHead()

Returns

Type	Description
boolean

isOptions() : boolean

inherited

Was the request made by OPTIONS?

Inherited from: \Zend_Controller_Request_Http::isOptions()

Returns

Type	Description
boolean

isPost() : boolean

inherited

Was the request made by POST?

Inherited from: \Zend_Controller_Request_Http::isPost()

Returns

Type	Description
boolean

isPut() : boolean

inherited

Was the request made by PUT?

Inherited from: \Zend_Controller_Request_Http::isPut()

Returns

Type	Description
boolean

isSecure() : boolean

inherited

Is https secure request

Inherited from: \Zend_Controller_Request_Http::isSecure()

Returns

Type	Description
boolean

isXmlHttpRequest() : boolean

inherited

Is the request a Javascript XMLHttpRequest?

Inherited from: \Zend_Controller_Request_Http::isXmlHttpRequest()

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

Returns

Type	Description
boolean

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

inherited

Alias to __set()

Inherited from: \Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::setActionName()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setAlias(string $name, string $target) : \Zend_Controller_Request_Http

inherited

Set a key alias

Inherited from: \Zend_Controller_Request_Http::setAlias()

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

inherited

Set the base path for the URL

Inherited from: \Zend_Controller_Request_Http::setBasePath()

Parameters

Name	Type	Description
$basePath	string \| null

Returns

Type	Description
\Zend_Controller_Request_Http

setBaseUrl(mixed $baseUrl = null) : \Zend_Controller_Request_Http

inherited

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

Inherited from: \Zend_Controller_Request_Http::setBaseUrl()

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()\Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::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()\Zend_Controller_Request_Http::setModuleName()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Controller_Request_Abstract

setParam(mixed $key, mixed $value) : \Zend_Controller_Request_Http

inherited

Set a userland parameter

Inherited from: \Zend_Controller_Request_Http::setParam()

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

inherited

Set allowed parameter sources

Inherited from: \Zend_Controller_Request_Http::setParamSources()

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

inherited

Set parameters

Inherited from: \Zend_Controller_Request_Http::setParams()

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

inherited

Set the PATH_INFO string

Inherited from: \Zend_Controller_Request_Http::setPathInfo()

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

inherited

Set POST values

Inherited from: \Zend_Controller_Request_Http::setPost()

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

inherited

Set GET values

Inherited from: \Zend_Controller_Request_Http::setQuery()

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/Apache404.php

\Zend_Controller_Request_Apache404jump to top

Constants

Properties

Methods

\Zend_Controller_Request_Apache404
jump to top