Zend_Http_ClientZend_Http_Client is an implemetation 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 persistance (using a Zend_Http_CookieJar object)
Located in /Zend/Http/Client.php (line 43)
static string
encodeFormData
(string $boundary, string $name, mixed $value, [string $filename = null], [array $headers = array()])
Zend_Http_Client
__construct
([Zend_Uri_Http|string $uri = null], [ $config = null], array $headers)
Zend_Http_Client
setAuth
(string|false $user, [string $password = ''], [string $type = self::AUTH_BASIC])
Zend_Http_Client
setFileUpload
(string $filename, string $formname, [string $data = null], [string $ctype = null])
Zend_Http_Client_Adapter_Interface
$adapter
= null (line 96)
The adapter used to preform the actual connection to the server
array|null
$auth
(line 159)
HTTP Authentication settings
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.
unknown_type
$config
= array(Configuration array, set using the constructor or using ::setConfig()
Zend_Http_CookieJar
$cookiejar
= null (line 176)
The client's cookie jar
string
$enctype
= null (line 138)
Request body content type (for POST requests)
array
$files
= array() (line 169)
File upload arrays (used in POST requests)
An associative array, where each element is of the format: 'name' => array('filename.txt', 'text/plain', 'This is the actual file contents')
array
$headers
= array() (line 110)
Associative array of request headers
string
$last_request
= null (line 183)
The last HTTP request sent by the client, as string
Zend_Http_Response
$last_response
= null (line 190)
The last HTTP response received by the client
string
$method
= self::GET (line 117)
HTTP request method
array
$paramsGet
= array() (line 124)
Associative array of GET parameters
array
$paramsPost
= array() (line 131)
Assiciative array of POST parameters
string
$raw_post_data
= null (line 145)
The raw post data to send. Could be set by setRawData($data, $enctype).
int
$redirectCounter
= 0 (line 197)
Redirection counter
Zend_Uri_Http
$uri
(line 103)
Request URI
static encodeAuthHeader (line 1022)
Create a HTTP authentication "Authorization:" header according to the specified user, password and authentication method.
static encodeFormData (line 995)
Encode data to a multipart/form-data part suitable for a POST request.
Constructor __construct (line 206)
Contructor method. Will create a new HTTP client. Accepts the target URL and optionally and array of headers.
getCookieJar (line 520)
Return the current cookie jar or null if none.
getHeader (line 359)
Get the value of a specific header
Note that if the header has more than one value, an array will be returned.
getLastRequest (line 676)
Get the last HTTP request as string
getLastResponse (line 689)
Get the last HTTP response received by this client
If $config['storeresponse'] is set to false, or no response was stored yet, will return null
getRedirectionsCount (line 439)
Get the number of redirections done on the last request
getUri (line 244)
Get the URI for the next request
loadAdapter (line 964)
Load the connection adapter
While this method is not called more than one for a client, it is seperated from ->request() to preserve logic and readability
prepare_body (line 862)
Prepare the request body (for POST and PUT requests)
prepare_headers (line 800)
Prepare the request headers
request (line 700)
Send the HTTP request and return an HTTP response object
resetParameters (line 656)
Clear all GET and POST parameters
Should be used to reset the request parameters if the client is used for several concurrent requests.
setAuth (line 466)
Set HTTP authentication parameters
$type should be one of the supported types - see the self::AUTH_* constants.
To enable authentication:
To disable authentication:
setConfig (line 259)
Set configuration parameters for this HTTP client
setCookie (line 533)
Add a cookie to the request. If the client has no Cookie Jar, the cookies will be added directly to the headers array as "Cookie" headers.
setCookieJar (line 497)
Set the HTTP client's cookie jar.
A cookie jar is an object that holds and maintains cookies across HTTP requests and responses.
setEncType (line 621)
Set the encoding type for POST data
setFileUpload (line 597)
Set a file to upload (using a POST request)
Can be used in two ways:
setHeaders (line 313)
Set one or more request headers
This function can be used in several ways to set the client's request headers:
setMethod (line 280)
Set the next request's method
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.
setParameterGet (line 376)
Set a GET parameter for the request. Wrapper around _setParameter
setParameterPost (line 395)
Set a POST parameter for the request. Wrapper around _setParameter
setRawData (line 640)
Set the raw (already encoded) POST data.
This function is here for two reasons:
_getParametersRecursive (line 932)
Helper method that gets a possibly multi-level parameters array (get or post) and flattens it.
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.
_setParameter (line 414)
Set a GET or POST parameter - used by SetParameterGet and SetParameterPost
AUTH_BASIC
= 'basic'
(line 60)
Supported HTTP Authentication methods
CONNECT
= 'CONNECT'
(line 55)
DELETE
= 'DELETE'
(line 52)
ENC_FORMDATA
= 'multipart/form-data'
(line 73)
ENC_URLENCODED
= 'application/x-www-form-urlencoded'
(line 72)
POST data encoding methods
GET
= 'GET'
(line 48)
HTTP request methods
HEAD
= 'HEAD'
(line 51)
HTTP_0
= '1.0'
(line 67)
HTTP_1
= '1.1'
(line 66)
HTTP protocol versions
OPTIONS
= 'OPTIONS'
(line 54)
POST
= 'POST'
(line 49)
PUT
= 'PUT'
(line 50)
TRACE
= 'TRACE'
(line 53)
Documentation generated on Wed, 21 Feb 2007 11:46:13 -0800 by phpDocumentor 1.3.1