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_Http
HTTP request object for use with Zend_Controller family.

array
$_paramSources= 'array('_GET''
Allowed parameter sources
array('_GET'
Details
__construct(
string|\Zend_Uri $uri
=
null
)
:
void
Constructor
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
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

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

__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.
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Exception | Description |
---|---|
\Zend_Controller_Request_Exception |

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

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

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
Name | Type | Description |
---|---|---|
$raw |
Type | Description |
---|---|
string |

getClientIp(
boolean $checkProxy
=
true
)
:
string
Get the client's IP addres
Name | Type | Description |
---|---|---|
$checkProxy | boolean |
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.
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
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.
Name | Type | Description |
---|---|---|
$header | string | HTTP header name |
Type | Description |
---|---|
string|false | HTTP header value, or false if not found |
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.
Type | Description |
---|---|
string |

getMethod(
)
:
string
Return the method by which the request was made
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 {@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 |

getParams(
)
:
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).
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.
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.
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
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
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
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.
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 |

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

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

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

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

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.
Name | Type | Description |
---|---|---|
$key | mixed | |
$value | mixed |
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'.
Name | Type | Description |
---|---|---|
$paramSources |
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.
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
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
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
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 |