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.
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.

__construct(
string|\Zend_Uri $uri
=
null
)
:
void
Constructor
Inherited from: \Zend_Controller_Request_Http::__construct()If a $uri is passed, the object will attempt to populate itself using that information.
Name | Type | Description |
---|---|---|
$uri | string|\Zend_Uri |
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
Inherited from: \Zend_Controller_Request_Http::__get()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

__isset(
string $key
)
:
boolean
Check to see if a property is set
Inherited from: \Zend_Controller_Request_Http::__isset()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
boolean |

__set(
string $key, mixed $value
)
:
void
Set values
Inherited from: \Zend_Controller_Request_Http::__set()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.
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Exception | Description |
---|---|
\Zend_Controller_Request_Exception |

clearParams(
)
:
\Zend_Controller_Request_Abstract
Unset all user parameters
Inherited from: \Zend_Controller_Request_Abstract::clearParams()Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

get(
string $key
)
:
mixed
Alias to __get
Inherited from: \Zend_Controller_Request_Http::get()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getActionKey(
)
:
string
Retrieve the action key
Inherited from: \Zend_Controller_Request_Abstract::getActionKey()Type | Description |
---|---|
string |

getActionName(
)
:
string
Retrieve the action name
Inherited from: \Zend_Controller_Request_Abstract::getActionName()Type | Description |
---|---|
string |

getAlias(
string $name
)
:
string|null
Retrieve an alias
Inherited from: \Zend_Controller_Request_Http::getAlias()Retrieve the actual key represented by the alias $name.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
stringnull | Returns null when no alias exists |

getAliases(
)
:
array
Retrieve the list of all aliases
Inherited from: \Zend_Controller_Request_Http::getAliases()Type | Description |
---|---|
array |

getBasePath(
)
:
string
Everything in REQUEST_URI before PATH_INFO not including the filename
Type | Description |
---|---|
string |

getBaseUrl(
$raw
=
false
)
:
string
Everything in REQUEST_URI before PATH_INFO
Inherited from: \Zend_Controller_Request_Http::getBaseUrl()Name | Type | Description |
---|---|---|
$raw |
Type | Description |
---|---|
string |

getClientIp(
boolean $checkProxy
=
true
)
:
string
Get the client's IP addres
Inherited from: \Zend_Controller_Request_Http::getClientIp()Name | Type | Description |
---|---|---|
$checkProxy | boolean |
Type | Description |
---|---|
string |

getControllerKey(
)
:
string
Retrieve the controller key
Inherited from: \Zend_Controller_Request_Abstract::getControllerKey()Type | Description |
---|---|
string |

getControllerName(
)
:
string
Retrieve the controller name
Inherited from: \Zend_Controller_Request_Abstract::getControllerName()Type | Description |
---|---|
string |

getCookie(
string $key
=
null, mixed $default
=
null
)
:
mixed
Retrieve a member of the $_COOKIE superglobal
Inherited from: \Zend_Controller_Request_Http::getCookie()If no $key is passed, returns the entire $_COOKIE array.
Name | Type | Description |
---|---|---|
$key | string | |
$default | mixed | Default value to use if key not found |
Type | Description |
---|---|
mixed | Returns null if key does not exist |

getEnv(
string $key
=
null, mixed $default
=
null
)
:
mixed
Retrieve a member of the $_ENV superglobal
Inherited from: \Zend_Controller_Request_Http::getEnv()If no $key is passed, returns the entire $_ENV array.
Name | Type | Description |
---|---|---|
$key | string | |
$default | mixed | Default value to use if key not found |
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.
Inherited from: \Zend_Controller_Request_Http::getHeader()Name | Type | Description |
---|---|---|
$header | string | HTTP header name |
Type | Description |
---|---|
stringfalse | HTTP header value, or false if not found |
Exception | Description |
---|---|
\Zend_Controller_Request_Exception |

getHttpHost(
)
:
string
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.
Type | Description |
---|---|
string |

getMethod(
)
:
string
Return the method by which the request was made
Inherited from: \Zend_Controller_Request_Http::getMethod()Type | Description |
---|---|
string |

getModuleKey(
)
:
string
Retrieve the module key
Inherited from: \Zend_Controller_Request_Abstract::getModuleKey()Type | Description |
---|---|
string |

getModuleName(
)
:
string
Retrieve the module name
Inherited from: \Zend_Controller_Request_Abstract::getModuleName()Type | Description |
---|---|
string |

getParam(
mixed $key, mixed $default
=
null
)
:
mixed
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 {@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.
Name | Type | Description |
---|---|---|
$key | mixed | |
$default | mixed | Default value to use if key not found |
Type | Description |
---|---|
mixed |

getParamSources(
)
:
array
Get list of allowed parameter sources
Inherited from: \Zend_Controller_Request_Http::getParamSources()Type | Description |
---|---|
array |

getParams(
)
:
array
Retrieve an array of parameters
Inherited from: \Zend_Controller_Request_Http::getParams()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).
Type | Description |
---|---|
array |

getPathInfo(
)
:
string
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.
Type | Description |
---|---|
string |

getPost(
string $key
=
null, mixed $default
=
null
)
:
mixed
Retrieve a member of the $_POST superglobal
Inherited from: \Zend_Controller_Request_Http::getPost()If no $key is passed, returns the entire $_POST array.
Name | Type | Description |
---|---|---|
$key | string | |
$default | mixed | Default value to use if key not found |
Type | Description |
---|---|
mixed | Returns null if key does not exist |

getQuery(
string $key
=
null, mixed $default
=
null
)
:
mixed
Retrieve a member of the $_GET superglobal
Inherited from: \Zend_Controller_Request_Http::getQuery()If no $key is passed, returns the entire $_GET array.
Name | Type | Description |
---|---|---|
$key | string | |
$default | mixed | Default value to use if key not found |
Type | Description |
---|---|
mixed | Returns null if key does not exist |

getRawBody(
)
:
string|false
Return the raw body of the request, if present
Inherited from: \Zend_Controller_Request_Http::getRawBody()Type | Description |
---|---|
stringfalse | Raw body, or false if not present |

getRequestUri(
)
:
string
Returns the REQUEST_URI taking into account platform differences between Apache and IIS
Inherited from: \Zend_Controller_Request_Http::getRequestUri()Type | Description |
---|---|
string |

getScheme(
)
:
string
Get the request URI scheme
Inherited from: \Zend_Controller_Request_Http::getScheme()Type | Description |
---|---|
string |

getServer(
string $key
=
null, mixed $default
=
null
)
:
mixed
Retrieve a member of the $_SERVER superglobal
Inherited from: \Zend_Controller_Request_Http::getServer()If no $key is passed, returns the entire $_SERVER array.
Name | Type | Description |
---|---|---|
$key | string | |
$default | mixed | Default value to use if key not found |
Type | Description |
---|---|
mixed | Returns null if key does not exist |

getUserParam(
string $key, string $default
=
null
)
:
mixed
Retrieve a single user param (i.e, a param specific to the object and not the environment)
Inherited from: \Zend_Controller_Request_Abstract::getUserParam()Name | Type | Description |
---|---|---|
$key | string | |
$default | string | Default value to use if key not found |
Type | Description |
---|---|
mixed |

getUserParams(
)
:
array
Retrieve only user params (i.e, any param specific to the object and not the environment)
Inherited from: \Zend_Controller_Request_Abstract::getUserParams()Type | Description |
---|---|
array |

has(
string $key
)
:
boolean
Alias to __isset()
Inherited from: \Zend_Controller_Request_Http::has()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
boolean |

isDelete(
)
:
boolean
Was the request made by DELETE?
Inherited from: \Zend_Controller_Request_Http::isDelete()Type | Description |
---|---|
boolean |

isDispatched(
)
:
boolean
Determine if the request has been dispatched
Inherited from: \Zend_Controller_Request_Abstract::isDispatched()Type | Description |
---|---|
boolean |

isFlashRequest(
)
:
boolean
Is this a Flash request?
Inherited from: \Zend_Controller_Request_Http::isFlashRequest()Type | Description |
---|---|
boolean |

isGet(
)
:
boolean
Was the request made by GET?
Inherited from: \Zend_Controller_Request_Http::isGet()Type | Description |
---|---|
boolean |

isHead(
)
:
boolean
Was the request made by HEAD?
Inherited from: \Zend_Controller_Request_Http::isHead()Type | Description |
---|---|
boolean |

isOptions(
)
:
boolean
Was the request made by OPTIONS?
Inherited from: \Zend_Controller_Request_Http::isOptions()Type | Description |
---|---|
boolean |

isPost(
)
:
boolean
Was the request made by POST?
Inherited from: \Zend_Controller_Request_Http::isPost()Type | Description |
---|---|
boolean |

isPut(
)
:
boolean
Was the request made by PUT?
Inherited from: \Zend_Controller_Request_Http::isPut()Type | Description |
---|---|
boolean |

isSecure(
)
:
boolean
Is https secure request
Inherited from: \Zend_Controller_Request_Http::isSecure()Type | Description |
---|---|
boolean |

isXmlHttpRequest(
)
:
boolean
Is the request a Javascript XMLHttpRequest?
Inherited from: \Zend_Controller_Request_Http::isXmlHttpRequest()Should work with Prototype/Script.aculo.us, possibly others.
Type | Description |
---|---|
boolean |

set(
string $key, mixed $value
)
:
void
Alias to __set()
Inherited from: \Zend_Controller_Request_Http::set()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |

setActionKey(
string $key
)
:
\Zend_Controller_Request_Abstract
Set the action key
Inherited from: \Zend_Controller_Request_Abstract::setActionKey()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setActionName(
string $value
)
:
\Zend_Controller_Request_Abstract
Set the action name
Inherited from: \Zend_Controller_Request_Abstract::setActionName()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setAlias(
string $name, string $target
)
:
\Zend_Controller_Request_Http
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.
Name | Type | Description |
---|---|---|
$name | string | |
$target | string |
Type | Description |
---|---|
\Zend_Controller_Request_Http |

setBasePath(
string|null $basePath
=
null
)
:
\Zend_Controller_Request_Http
Set the base path for the URL
Inherited from: \Zend_Controller_Request_Http::setBasePath()Name | Type | Description |
---|---|---|
$basePath | string|null |
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
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.
Name | Type | Description |
---|---|---|
$baseUrl | mixed |
Type | Description |
---|---|
\Zend_Controller_Request_Http |

setControllerKey(
string $key
)
:
\Zend_Controller_Request_Abstract
Set the controller key
Inherited from: \Zend_Controller_Request_Abstract::setControllerKey()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setControllerName(
string $value
)
:
\Zend_Controller_Request_Abstract
Set the controller name to use
Inherited from: \Zend_Controller_Request_Abstract::setControllerName()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setDispatched(
boolean $flag
=
true
)
:
\Zend_Controller_Request_Abstract
Set flag indicating whether or not request has been dispatched
Inherited from: \Zend_Controller_Request_Abstract::setDispatched()Name | Type | Description |
---|---|---|
$flag | boolean |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setModuleKey(
string $key
)
:
\Zend_Controller_Request_Abstract
Set the module key
Inherited from: \Zend_Controller_Request_Abstract::setModuleKey()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setModuleName(
string $value
)
:
\Zend_Controller_Request_Abstract
Set the module name to use
Inherited from: \Zend_Controller_Request_Abstract::setModuleName()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |

setParam(
mixed $key, mixed $value
)
:
\Zend_Controller_Request_Http
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.
Name | Type | Description |
---|---|---|
$key | mixed | |
$value | mixed |
Type | Description |
---|---|
\Zend_Controller_Request_Http |

setParamSources(
$paramSources
=
array
)
:
\Zend_Controller_Request_Http
Set allowed parameter sources
Inherited from: \Zend_Controller_Request_Http::setParamSources()Can be empty array, or contain one or more of '_GET' or '_POST'.
Name | Type | Description |
---|---|---|
$paramSources |
Type | Description |
---|---|
\Zend_Controller_Request_Http |

setParams(
array $params
)
:
\Zend_Controller_Request_Http
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.
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Controller_Request_Http |

setPathInfo(
string|null $pathInfo
=
null
)
:
\Zend_Controller_Request_Http
Set the PATH_INFO string
Inherited from: \Zend_Controller_Request_Http::setPathInfo()Name | Type | Description |
---|---|---|
$pathInfo | string|null |
Type | Description |
---|---|
\Zend_Controller_Request_Http |

setPost(
string|array $spec, null|mixed $value
=
null
)
:
\Zend_Controller_Request_Http
Set POST values
Inherited from: \Zend_Controller_Request_Http::setPost()Name | Type | Description |
---|---|---|
$spec | string|array | |
$value | null|mixed |
Type | Description |
---|---|
\Zend_Controller_Request_Http |

setQuery(
string|array $spec, null|mixed $value
=
null
)
:
\Zend_Controller_Request_Http
Set GET values
Inherited from: \Zend_Controller_Request_Http::setQuery()Name | Type | Description |
---|---|---|
$spec | string|array | |
$value | null|mixed |
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'].
Name | Type | Description |
---|---|---|
$requestUri | string |
Type | Description |
---|---|
\Zend_Controller_Request_Http |