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:
In each case, the URL to check against is found in REDIRECT_URL, not REQUEST_URI.
| uses | |
|---|---|
| package | Zend_Controller |
| subpackage | Request |
| inherited_from | \Zend_Controller_Request_Http |
__construct(string|\Zend_Uri $uri = null) : void
If a $uri is passed, the object will attempt to populate itself using that information.
string\Zend_Uri
\Zend_Controller_Request_Exception |
when invalid URI passed |
|---|
__get(string $key) : mixed
__isset(string $key) : boolean
string
boolean__set(string $key, mixed $value) : void
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.
string
mixed
\Zend_Controller_Request_Exception |
|---|
clearParams() : \Zend_Controller_Request_Abstract
\Zend_Controller_Request_Abstractget(string $key) : mixed
string
mixedgetActionKey() : string
stringgetActionName() : string
stringgetAlias(string $name) : string | null
Retrieve the actual key represented by the alias $name.
string
stringnullReturns null when no alias existsgetAliases() : array
arraygetBasePath() : string
stringgetBaseUrl($raw = false) : string
stringgetClientIp(boolean $checkProxy = true) : string
boolean
stringgetControllerKey() : string
stringgetControllerName() : string
stringgetCookie(string $key= null, mixed $default= null) : mixed
If no $key is passed, returns the entire $_COOKIE array.
| todo | How to retrieve from nested arrays |
|---|
string
mixedDefault value to use if key not found
mixedReturns null if key does not existgetEnv(string $key= null, mixed $default= null) : mixed
If no $key is passed, returns the entire $_ENV array.
string
mixedDefault value to use if key not found
mixedReturns null if key does not existgetHeader(string $header) : string | false
stringHTTP header name
\Zend_Controller_Request_Exception |
|---|
stringfalseHTTP header value, or false if not foundgetHttpHost() : string
"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.
stringgetMethod() : string
stringgetModuleKey() : string
stringgetModuleName() : string
stringgetParam(string $key, mixed $default = null) : mixed
string
mixedDefault value to use if key not found
mixedgetParamSources() : array
arraygetParams() : array
arraygetPathInfo() : string
This value is calculated instead of reading PATH_INFO directly from $_SERVER due to cross-platform differences.
stringgetPost(string $key= null, mixed $default= null) : mixed
If no $key is passed, returns the entire $_POST array.
| todo | How to retrieve from nested arrays |
|---|
string
mixedDefault value to use if key not found
mixedReturns null if key does not existgetQuery(string $key= null, mixed $default= null) : mixed
If no $key is passed, returns the entire $_GET array.
| todo | How to retrieve from nested arrays |
|---|
string
mixedDefault value to use if key not found
mixedReturns null if key does not existgetRawBody() : string | false
stringfalseRaw body, or false if not presentgetRequestUri() : string
stringgetScheme() : string
stringgetServer(string $key= null, mixed $default= null) : mixed
If no $key is passed, returns the entire $_SERVER array.
string
mixedDefault value to use if key not found
mixedReturns null if key does not existgetUserParam(string $key, string $default = null) : mixed
string
stringDefault value to use if key not found
mixedgetUserParams() : array
arrayhas(string $key) : boolean
string
booleanisDelete() : boolean
booleanisDispatched() : boolean
booleanisFlashRequest() : boolean
booleanisGet() : boolean
booleanisHead() : boolean
booleanisOptions() : boolean
booleanisPatch() : boolean
booleanisPost() : boolean
booleanisPut() : boolean
booleanisSecure() : boolean
booleanisXmlHttpRequest() : boolean
Should work with Prototype/Script.aculo.us, possibly others.
booleanset(string $key, mixed $value) : void
string
mixed
setActionKey(string $key) : \Zend_Controller_Request_Abstract
string
\Zend_Controller_Request_AbstractsetActionName(string $value) : \Zend_Controller_Request_Abstract
string
\Zend_Controller_Request_AbstractsetAlias(string $name, string $target) : \Zend_Controller_Request_Http
Set an alias used for key lookups. $name specifies the alias, $target specifies the actual key to use.
string
string
\Zend_Controller_Request_HttpsetBasePath(string|null $basePath = null) : \Zend_Controller_Request_Http
stringnull
\Zend_Controller_Request_HttpsetBaseUrl(mixed $baseUrl = null) : \Zend_Controller_Request_Http
E.g.:
Do not use the full URI when providing the base. The following are examples of what not to use:
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.
mixed
\Zend_Controller_Request_HttpsetControllerKey(string $key) : \Zend_Controller_Request_Abstract
string
\Zend_Controller_Request_AbstractsetControllerName(string $value) : \Zend_Controller_Request_Abstract
string
\Zend_Controller_Request_AbstractsetDispatched(boolean $flag = true) : \Zend_Controller_Request_Abstract
boolean
\Zend_Controller_Request_AbstractsetModuleKey(string $key) : \Zend_Controller_Request_Abstract
string
\Zend_Controller_Request_AbstractsetModuleName(string $value) : \Zend_Controller_Request_Abstract
string
\Zend_Controller_Request_AbstractsetParam(string $key, mixed $value) : \Zend_Controller_Request_Abstract
A $value of null will unset the $key if it exists
string
mixed
\Zend_Controller_Request_AbstractsetParamSources(array $paramSources = array()) : \Zend_Controller_Request_Http
Can be empty array, or contain one or more of '_GET' or '_POST'.
\Zend_Controller_Request_HttpsetParams(array $array) : \Zend_Controller_Request_Abstract
Null values will unset the associated key.
array
\Zend_Controller_Request_AbstractsetPathInfo(string|null $pathInfo = null) : \Zend_Controller_Request_Http
stringnull
\Zend_Controller_Request_HttpsetPost(string|array $spec, null|mixed $value = null) : \Zend_Controller_Request_Http
stringarray
nullmixed
\Zend_Controller_Request_HttpsetQuery(string|array $spec, null|mixed $value = null) : \Zend_Controller_Request_Http
stringarray
nullmixed
\Zend_Controller_Request_HttpsetRequestUri(string $requestUri = null)
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'].
| inherited_from | \Zend_Controller_Request_Http::setRequestUri() |
|---|
setRequestUri(string $requestUri = null) : \Zend_Controller_Request_Http
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'].
string
\Zend_Controller_Request_Http$_action : string
$_actionKey : string
'action'$_aliases : array
array()$_basePath : string
null$_baseUrl : string
null$_controller : string
$_controllerKey : string
'controller'$_dispatched : boolean
false$_module : string
$_moduleKey : string
'module'$_paramSources : array
array('_GET', '_POST')$_params : array
array()$_pathInfo : string
''$_rawBody : string | false
$_requestUri : \string;
SCHEME_HTTP = 'http'
SCHEME_HTTPS = 'https'