Zend_Http_Client is an implementation of an HTTP client in PHP. The client supports basic features like sending different HTTP requests and handling redirections, as well as more advanced features like proxy settings, HTTP authentication and cookie persistence (using a Zend_Http_CookieJar object)
| category | Zend |
|---|---|
| package | Zend_Oauth |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
| inherited_from | \Zend_Http_Client |
__call(string $method, array $args) : mixed
string
array
\Zend_Oauth_Exception |
if method does not exist in config object |
|---|
mixed__construct(array|\Zend_Config $oauthOptions, string $uri= null, array|\Zend_Config $config= null) : void
| inherited_from | \Zend_Http_Client::__construct() |
|---|
array\Zend_Config
string
array\Zend_Config
__construct(\Zend_Uri_Http|string $uri= null, array $config= null)
\Zend_Uri_Httpstring
arrayConfiguration key-value pairs.
encodeAuthHeader(string $user, string $password, string $type = self::AUTH_BASIC) : string
encodeFormData(string $boundary, string $name, mixed $value, string $filename= null, array $headers= array()) : string
string
string
mixed
string
arrayAssociative array of optional headers @example ("Content-Transfer-Encoding" => "binary")
stringgetAdapter() : \Zend_Http_Client_Adapter_Interface
\Zend_Http_Client_Adapter_Interface$adaptergetCookieJar() : \Zend_Http_CookieJar | null
\Zend_Http_CookieJarnull
getHeader(string $key) : string | array | null
Note that if the header has more than one value, an array will be returned.
string
stringarraynullThe header value or null if it is not setgetLastRequest() : string
stringgetLastResponse() : \Zend_Http_Response
If $config['storeresponse'] is set to false, or no response was stored yet, will return null
\Zend_Http_Responseor null if nonegetRedirectionsCount() : integer
integergetStream() : boolean | string
booleanstring
getStreamingRequest() : boolean
booleanTrue if yes, false otherwise.getUnmaskStatus() : boolean
booleangetUri(boolean $as_string = false) : \Zend_Uri_Http | string
booleanIf true, will return the URI as a string
\Zend_Uri_Httpstring
prepareOauth() : void
This primarily means taking a request, correctly encoding and signing all parameters, and applying the correct OAuth scheme to the method being used.
\Zend_Oauth_Exception |
If POSTBODY scheme requested, but GET request method used; or if invalid request scheme provided |
|---|
request(string $method = null) : \Zend_Http_Response
| inherited_from | \Zend_Http_Client::request() |
|---|
string
\Zend_Http_Responserequest(string $method = null) : \Zend_Http_Response
string
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ResponseresetParameters(boolean $clearAll = false) : \Zend_Http_Client
Should be used to reset the request parameters if the client is used for several concurrent requests.
clearAll parameter controls if we clean just parameters or also headers and last_*
| inherited_from | \Zend_Http_Client::resetParameters() |
|---|
\Zend_Http_ClientresetParameters(boolean $clearAll = false) : \Zend_Http_Client
Should be used to reset the request parameters if the client is used for several concurrent requests.
clearAll parameter controls if we clean just parameters or also headers and last_*
booleanShould all data be cleared?
\Zend_Http_ClientsetAdapter(\Zend_Http_Client_Adapter_Interface $adapter) : void
While this method is not called more than one for a client, it is seperated from ->request() to preserve logic and readability
| inherited_from | \Zend_Http_Client::setAdapter() |
|---|
\Zend_Http_Client_Adapter_Interface
setAdapter(\Zend_Http_Client_Adapter_Interface|string $adapter) : null
While this method is not called more than one for a client, it is seperated from ->request() to preserve logic and readability
\Zend_Http_Client_Adapter_Interfacestring
\Zend_Http_Client_Exception |
|---|
nullsetAuth(string|false $user, string $password= '', string $type= self::AUTH_BASIC) : \Zend_Http_Client
$type should be one of the supported types - see the self::AUTH_* constants.
To enable authentication:
$this->setAuth('shahar', 'secret', Zend_Http_Client::AUTH_BASIC);
To disable authentication:
$this->setAuth(false);
| see |
|---|
stringfalseUser name or false disable authentication
stringPassword
stringAuthentication type
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ClientsetConfig($config = array()) : \Zend_Http_Client
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ClientsetCookie(\Zend_Http_Cookie|string $cookie, string|null $value = null) : \Zend_Http_Client
\Zend_Http_Cookiestring
stringnullIf "cookie" is a string, this is the cookie value.
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ClientsetCookieJar(\Zend_Http_CookieJar|boolean $cookiejar = true) : \Zend_Http_Client
A cookie jar is an object that holds and maintains cookies across HTTP requests and responses.
\Zend_Http_CookieJarbooleanExisting cookiejar object, true to create a new one, false to disable
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ClientsetEncType(string $enctype = self::ENC_URLENCODED) : \Zend_Http_Client
string
\Zend_Http_ClientsetFileUpload(string $filename, string $formname, string $data= null, string $ctype= null) : \Zend_Http_Client
Can be used in two ways:
stringName of file to upload, or name to save as
stringName of form element to send as
stringData to send (if null, $filename is read and sent)
stringContent type to use (if $data is set and $ctype is null, will be application/octet-stream)
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ClientsetHeaders(string|array $name, mixed $value = null) : \Zend_Http_Client
This function can be used in several ways to set the client's request headers:
stringarrayHeader name, full header string ('Header: value') or an array of headers
mixedHeader value or null
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ClientsetMethod(string $method = self::GET) : \Zend_Http_Client
Might be defunct and removed in a later iteration.
| inherited_from | \Zend_Http_Client::setMethod() |
|---|
string
\Zend_Http_ClientsetMethod(string $method = self::GET) : \Zend_Http_Client
Validated the passed method and sets it. If we have files set for POST requests, and the new method is not POST, the files are silently dropped.
string
\Zend_Http_Client_Exception |
|---|
\Zend_Http_ClientsetParameterGet(string|array $name, string $value = null) : \Zend_Http_Client
stringarray
string
\Zend_Http_ClientsetParameterPost(string|array $name, string $value = null) : \Zend_Http_Client
stringarray
string
\Zend_Http_ClientsetRawData(string|resource $data, string $enctype = null) : \Zend_Http_Client
This function is here for two reasons:
$data can also be stream (such as file) from which the data will be read.
stringresource
string
\Zend_Http_ClientsetRawDataStream(string $data, string $enctype = null) : \Zend_Http_Client
This is used to support POSTing from open file handles without caching the entire body into memory. It is a wrapper around Zend_Http_Client::setRawData().
stringThe request data
stringThe encoding type
\Zend_Http_ClientsetStream(string|boolean $streamfile = true) : \Zend_Http_Client
stringbooleanStream file, true for temp file, false/null for no streaming
\Zend_Http_ClientsetStreamingRequest(boolean $value) : void
booleanThe value to set.
setUnmaskStatus(boolean $status = true) : \Zend_Http_Client
Example: foo%5B0%5D=a&foo%5B1%5D=b becomes foo=a&foo=b
This is usefull for some services
boolean
\Zend_Http_ClientsetUri(\Zend_Uri_Http|string $uri) : \Zend_Http_Client
\Zend_Uri_Httpstring
\Zend_Http_Client_Exception |
|---|
\Zend_Http_Client_detectFileMimeType(string $file) : string
This method will try to detect the MIME type of a file. If the fileinfo extension is available, it will be used. If not, the mime_magic extension which is deprected but is still available in many PHP setups will be tried.
If neither extension is available, the default application/octet-stream MIME type will be returned
stringFile path
stringMIME type_flattenParametersArray(array $parray, string $prefix = null) : array
Will flatten a potentially multi-dimentional array of parameters (such as POST parameters) into a flat array of (key, value) paris. In case of multi-dimentional arrays, square brackets ([]) will be added to the key to indicate an array.
| since | 1.9 |
|---|
array
string
array_getParametersRecursive(array $parray, boolean $urlencode = false) : array
The method returns an array of (key, value) pairs (because keys are not necessarily unique. If one of the parameters in as array, it will also add a [] suffix to the key.
This method is deprecated since Zend Framework 1.9 in favour of self::_flattenParametersArray() and will be dropped in 2.0
| deprecated | since 1.9 |
|---|
arrayThe parameters array
booleanWhether to urlencode the name and value
array_getSignableParametersAsQueryString() : array
array_openTempStream() : resource
resource_prepareBody() : string
| inherited_from | \Zend_Http_Client::_prepareBody() |
|---|
\Zend_Http_Client_Exception |
|---|
string_prepareBody() : string
\Zend_Http_Client_Exception |
|---|
string_prepareHeaders() : array
array_setParameter(string $type, string $name, string $value) : null
stringGET or POST
string
string
null_validateHeaderValue(string|object|array $value, boolean $recurse = true)
$supportsRevisionA
false$_config : \Zend_Oauth_Config
null$_fileInfoDb : resource
nullThis variable is populated the first time _detectFileMimeType is called and is then reused on every call to this method
$_queryBracketsEscaped : boolean
true$_streamingRequest : boolean
null$_unmaskStatus : boolean
false$adapter : \Zend_Http_Client_Adapter_Interface
null$auth : array | null
Expected to be an associative array with this structure: $this->auth = array('user' => 'username', 'password' => 'password', 'type' => 'basic') Where 'type' should be one of the supported authentication types (see the AUTH_* constants), for example 'basic' or 'digest'.
If null, no authentication will be used.
$body_field_order : array
array()An associative array, where each element is of the format:
'
$config : array
array('maxredirects' => 5, 'strictredirects' => false, 'useragent' => 'Zend_Http_Client', 'timeout' => 10, 'adapter' => 'Zend_Http_Client_Adapter_Socket', 'httpversion' => self::HTTP_1, 'keepalive' => false, 'storeresponse' => true, 'strict' => true, 'output_stream' => false, 'encodecookies' => true, 'rfc3986_strict' => false)$enctype : string
null$files : array
array()An associative array, where each element is of the format: 'name' => array('filename.txt', 'text/plain', 'This is the actual file contents')
$headers : array
array()$last_request : string
null$last_response : \Zend_Http_Response
null$method : string
self::GET$paramsGet : array
array()$paramsPost : array
array()$raw_post_data : string
null$redirectCounter : integer
0$uri : \Zend_Uri_Http
nullAUTH_BASIC = 'basic'
CONNECT = 'CONNECT'
CONTENT_LENGTH = 'Content-Length'
CONTENT_TYPE = 'Content-Type'
DELETE = 'DELETE'
ENC_FORMDATA = 'multipart/form-data'
ENC_URLENCODED = 'application/x-www-form-urlencoded'
GET = 'GET'
HEAD = 'HEAD'
HTTP_0 = '1.0'
HTTP_1 = '1.1'
MERGE = 'MERGE'
OPTIONS = 'OPTIONS'
PATCH = 'PATCH'
POST = 'POST'
PUT = 'PUT'
TRACE = 'TRACE'
VTYPE_FILE = 'FILE'
VTYPE_SCALAR = 'SCALAR'