Controller/Request/Http.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
version: $Id: Http.php 20984 2010-02-08 16:25:08Z matthew $
Classes: Zend_Controller_Request_Http

Description

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
jump to top

Extends from: Zend_Controller_Request_Abstract
package: Zend_Controller
subpackage: Request
uses: Zend_Controller_Request_Abstract
Constants: SCHEME_HTTP; SCHEME_HTTPS
Properties: $_paramSources; $_requestUri; $_baseUrl; $_basePath; $_pathInfo; $_params; $_rawBody; $_aliases
Methods: __construct; __get; get; __set; set; __isset; has; setQuery; getQuery; setPost; getPost; getCookie; getServer; getEnv; setRequestUri; getRequestUri; setBaseUrl; getBaseUrl; setBasePath; getBasePath; setPathInfo; getPathInfo; setParamSources; getParamSources; setParam; getParam; getParams; setParams; setAlias; getAlias; getAliases; getMethod; isPost; isGet; isPut; isDelete; isHead; isOptions; isXmlHttpRequest; isFlashRequest; isSecure; getRawBody; getHeader; getScheme; getHttpHost; getClientIp

Description

Zend_Controller_Request_Http

HTTP request object for use with Zend_Controller family.

Constants

SCHEME_HTTP
jump to class

 SCHEME_HTTP = 'http'

Scheme for http

Details

value: http

SCHEME_HTTPS
jump to class

 SCHEME_HTTPS = 'https'

Scheme for https

Details

value: https

Properties

$_aliases
jump to class

array $_aliases = 'array'

Alias keys for request parameters

Details

$_aliases: array
visibility: protected
default: array
final: false
static: false

$_basePath
jump to class

string $_basePath = 'null'

Base path of request

Details

$_basePath: string
visibility: protected
default: null
final: false
static: false

$_baseUrl
jump to class

string $_baseUrl = 'null'

Base URL of request

Details

$_baseUrl: string
visibility: protected
default: null
final: false
static: false

$_paramSources
jump to class

array $_paramSources = 'array'

Allowed parameter sources

Details

$_paramSources: array
visibility: protected
default: array
final: false
static: false

$_params
jump to class

array $_params = 'array'

Instance parameters

Details

$_params: array
visibility: protected
default: array
final: false
static: false

$_pathInfo
jump to class

string $_pathInfo = ''

PATH_INFO

Details

$_pathInfo: string
visibility: protected
default
final: false
static: false

$_rawBody
jump to class

string|false $_rawBody = ''

Raw request body

Details

$_rawBody: string|false
visibility: protected
default
final: false
static: false

$_requestUri
jump to class

string; $_requestUri = ''

REQUEST_URI

Details

$_requestUri: string;
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

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

Constructor

If a $uri is passed, the object will attempt to populate itself using that information.

Arguments

$uri: stringZend_Uri

Details

visibility: public
final: false
static: false
throws: when invalid URI passed

__get
jump to class

__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

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false
see: http://msdn.microsoft.com/en-us/library/system.web.httprequest.item.aspx

__isset
jump to class

__isset(
          string $key
          )
        
        :
        boolean

Check to see if a property is set

Arguments

$key: string

Output

boolean

Details

visibility: public
final: false
static: false

__set
jump to class

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

Arguments

$key: string
$value: mixed

Details

visibility: public
final: false
static: false
throws

get
jump to class

get(
          string $key
          )
        
        :
        mixed

Alias to __get

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

getAlias
jump to class

getAlias(
          string $name
          )
        
        :
        string|null

Retrieve an alias

Retrieve the actual key represented by the alias $name.

Arguments

$name: string

Output

string|null: Returns null when no alias exists

Details

visibility: public
final: false
static: false

getAliases
jump to class

getAliases(
          
          )
        
        :
        array

Retrieve the list of all aliases

Output

array

Details

visibility: public
final: false
static: false

getBasePath
jump to class

getBasePath(
          
          )
        
        :
        string

Everything in REQUEST_URI before PATH_INFO not including the filename <img src="<?=$basePath?>/images/zend.png"/>

Output

string

Details

visibility: public
final: false
static: false

getBaseUrl
jump to class

getBaseUrl(
          
          )
        
        :
        string

Everything in REQUEST_URI before PATH_INFO <form action="<?=$baseUrl?>/news/submit" method="POST"/>

Output

string

Details

visibility: public
final: false
static: false

getClientIp
jump to class

getClientIp(
          boolean $checkProxy
              =
              true
          )
        
        :
        string

Get the client's IP addres

Arguments

$checkProxy: boolean

Output

string

Details

visibility: public
final: false
static: false

getCookie
jump to class

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.

Arguments

$key: string
$default: mixed
Default value to use if key not found

Output

mixed: Returns null if key does not exist

Details

visibility: public
final: false
static: false
todo: How to retrieve from nested arrays

getEnv
jump to class

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.

Arguments

$key: string
$default: mixed
Default value to use if key not found

Output

mixed: Returns null if key does not exist

Details

visibility: public
final: false
static: false

getHeader
jump to class

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.

Arguments

$header: string
HTTP header name

Output

string|false: HTTP header value, or false if not found

Details

visibility: public
final: false
static: false
throws

getHttpHost
jump to class

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.

Output

string

Details

visibility: public
final: false
static: false

getMethod
jump to class

getMethod(
          
          )
        
        :
        string

Return the method by which the request was made

Output

string

Details

visibility: public
final: false
static: false

getParam
jump to class

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.

Arguments

$key: mixed
$default: mixed
Default value to use if key not found

Output

mixed

Details

visibility: public
final: false
static: false

getParamSources
jump to class

getParamSources(
          
          )
        
        :
        array

Get list of allowed parameter sources

Output

array

Details

visibility: public
final: false
static: false

getParams
jump to class

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

Output

array

Details

visibility: public
final: false
static: false

getPathInfo
jump to class

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.

Output

string

Details

visibility: public
final: false
static: false

getPost
jump to class

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.

Arguments

$key: string
$default: mixed
Default value to use if key not found

Output

mixed: Returns null if key does not exist

Details

visibility: public
final: false
static: false
todo: How to retrieve from nested arrays

getQuery
jump to class

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.

Arguments

$key: string
$default: mixed
Default value to use if key not found

Output

mixed: Returns null if key does not exist

Details

visibility: public
final: false
static: false
todo: How to retrieve from nested arrays

getRawBody
jump to class

getRawBody(
          
          )
        
        :
        string|false

Return the raw body of the request, if present

Output

string|false: Raw body, or false if not present

Details

visibility: public
final: false
static: false

getRequestUri
jump to class

getRequestUri(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

getScheme
jump to class

getScheme(
          
          )
        
        :
        string

Get the request URI scheme

Output

string

Details

visibility: public
final: false
static: false

getServer
jump to class

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.

Arguments

$key: string
$default: mixed
Default value to use if key not found

Output

mixed: Returns null if key does not exist

Details

visibility: public
final: false
static: false

has
jump to class

has(
          string $key
          )
        
        :
        boolean

Alias to __isset()

Arguments

$key: string

Output

boolean

Details

visibility: public
final: false
static: false

isDelete
jump to class

isDelete(
          
          )
        
        :
        boolean

Was the request made by DELETE?

Output

boolean

Details

visibility: public
final: false
static: false

isFlashRequest
jump to class

isFlashRequest(
          
          )
        
        :
        boolean

Is this a Flash request?

Output

boolean

Details

visibility: public
final: false
static: false

isGet
jump to class

isGet(
          
          )
        
        :
        boolean

Was the request made by GET?

Output

boolean

Details

visibility: public
final: false
static: false

isHead
jump to class

isHead(
          
          )
        
        :
        boolean

Was the request made by HEAD?

Output

boolean

Details

visibility: public
final: false
static: false

isOptions
jump to class

isOptions(
          
          )
        
        :
        boolean

Was the request made by OPTIONS?

Output

boolean

Details

visibility: public
final: false
static: false

isPost
jump to class

isPost(
          
          )
        
        :
        boolean

Was the request made by POST?

Output

boolean

Details

visibility: public
final: false
static: false

isPut
jump to class

isPut(
          
          )
        
        :
        boolean

Was the request made by PUT?

Output

boolean

Details

visibility: public
final: false
static: false

isSecure
jump to class

isSecure(
          
          )
        
        :
        boolean

Is https secure request

Output

boolean

Details

visibility: public
final: false
static: false

isXmlHttpRequest
jump to class

isXmlHttpRequest(
          
          )
        
        :
        boolean

Is the request a Javascript XMLHttpRequest?

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

Output

boolean

Details

visibility: public
final: false
static: false

set
jump to class

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

Alias to __set()

Arguments

$key: string
$value: mixed

Details

visibility: public
final: false
static: false

setAlias
jump to class

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.

Arguments

$name: string
$target: string

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setBasePath
jump to class

setBasePath(
          string|null $basePath
              =
              null
          )
        
        :
        Zend_Controller_Request_Http

Set the base path for the URL

Arguments

$basePath: stringnull

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setBaseUrl
jump to class

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.

Arguments

$baseUrl: mixed

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setParam
jump to class

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.

Arguments

$key: mixed
$value: mixed

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setParamSources
jump to class

setParamSources(
           $paramSources
              =
              array
          )
        
        :
        Zend_Controller_Request_Http

Set allowed parameter sources

Can be empty array, or contain one or more of '_GET' or '_POST'.

Arguments

$paramSources

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setParams
jump to class

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.

Arguments

$params: array

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setPathInfo
jump to class

setPathInfo(
          string|null $pathInfo
              =
              null
          )
        
        :
        Zend_Controller_Request_Http

Set the PATH_INFO string

Arguments

$pathInfo: stringnull

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setPost
jump to class

setPost(
          string|array $spec, null|mixed $value
              =
              null
          )
        
        :
        Zend_Controller_Request_Http

Set POST values

Arguments

$spec: stringarray
$value: nullmixed

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setQuery
jump to class

setQuery(
          string|array $spec, null|mixed $value
              =
              null
          )
        
        :
        Zend_Controller_Request_Http

Set GET values

Arguments

$spec: stringarray
$value: nullmixed

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

setRequestUri
jump to class

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

Arguments

$requestUri: string

Output

Zend_Controller_Request_Http

Details

visibility: public
final: false
static: false

API Documentation

Controller/Request/Http.php

Description

Zend_Controller_Request_Httpjump to top

Description

Constants

SCHEME_HTTPjump to class

Details

SCHEME_HTTPSjump to class

Details

Properties

$_aliasesjump to class

Details

$_basePathjump to class

Details

$_baseUrljump to class

Details

$_paramSourcesjump to class

Details

$_paramsjump to class

Details

$_pathInfojump to class

Details

$_rawBodyjump to class

Details

$_requestUrijump to class

Details

Methods

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

getjump to class

Arguments

Output

Details

getAliasjump to class

Arguments

Output

Details

getAliasesjump to class

Output

Details

getBasePathjump to class

Output

Details

getBaseUrljump to class

Output

Details

getClientIpjump to class

Arguments

Output

Details

getCookiejump to class

Arguments

Output

Details

getEnvjump to class

Arguments

Output

Details

getHeaderjump to class

Arguments

Output

Details

getHttpHostjump to class

Output

Details

getMethodjump to class

Output

Zend_Controller_Request_Http
jump to top

SCHEME_HTTP
jump to class

SCHEME_HTTPS
jump to class

$_aliases
jump to class

$_basePath
jump to class

$_baseUrl
jump to class

$_paramSources
jump to class

$_params
jump to class

$_pathInfo
jump to class

$_rawBody
jump to class

$_requestUri
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

get
jump to class

getAlias
jump to class

getAliases
jump to class

getBasePath
jump to class

getBaseUrl
jump to class

getClientIp
jump to class

getCookie
jump to class

getEnv
jump to class

getHeader
jump to class

getHttpHost
jump to class

getMethod
jump to class

getParam
jump to class

getParamSources
jump to class

getParams
jump to class

getPathInfo
jump to class

getPost
jump to class

getQuery
jump to class

getRawBody
jump to class

getRequestUri
jump to class

getScheme
jump to class

getServer
jump to class

has
jump to class

isDelete
jump to class

isFlashRequest
jump to class

isGet
jump to class

isHead
jump to class

isOptions
jump to class

isPost
jump to class

isPut
jump to class

isSecure
jump to class

isXmlHttpRequest
jump to class

set
jump to class

setAlias
jump to class