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 /Http/Client.php (line 61)
| Class | Description |
|---|---|
Zend_Gdata_HttpClient
|
Gdata Http Client object. |
static string
encodeFormData
(string $boundary, string $name, mixed $value, [string $filename = null], [array $headers = array()])
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])
static resource
$_fileInfoDb
= null (line 226)
Fileinfo magic database resource
This varaiable is populated the first time _detectFileMimeType is called and is then reused on every call to this method
Zend_Http_Client_Adapter_Interface
$adapter
= null (line 115)
The adapter used to preform the actual connection to the server
array|null
$auth
(line 178)
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.
array
$config
= array(Configuration array, set using the constructor or using ::setConfig()
Zend_Http_CookieJar
$cookiejar
= null (line 195)
The client's cookie jar
string
$enctype
= null (line 157)
Request body content type (for POST requests)
array
$files
= array() (line 188)
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 129)
Associative array of request headers
string
$last_request
= null (line 202)
The last HTTP request sent by the client, as string
Zend_Http_Response
$last_response
= null (line 209)
The last HTTP response received by the client
string
$method
= self::GET (line 136)
HTTP request method
array
$paramsGet
= array() (line 143)
Associative array of GET parameters
array
$paramsPost
= array() (line 150)
Assiciative array of POST parameters
string
$raw_post_data
= null (line 164)
The raw post data to send. Could be set by setRawData($data, $enctype).
int
$redirectCounter
= 0 (line 216)
Redirection counter
Zend_Uri_Http
$uri
(line 122)
Request URI
static encodeAuthHeader (line 1156)
Create a HTTP authentication "Authorization:" header according to the specified user, password and authentication method.
static encodeFormData (line 1128)
Encode data to a multipart/form-data part suitable for a POST request.
Constructor __construct (line 235)
Contructor method. Will create a new HTTP client. Accepts the target URL and optionally configuration array.
getCookieJar (line 571)
Return the current cookie jar or null if none.
getHeader (line 402)
Get the value of a specific header
Note that if the header has more than one value, an array will be returned.
getLastRequest (line 734)
Get the last HTTP request as string
getLastResponse (line 747)
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 483)
Get the number of redirections done on the last request
getUri (line 276)
Get the URI for the next request
request (line 795)
Send the HTTP request and return an HTTP response object
resetParameters (line 714)
Clear all GET and POST parameters
Should be used to reset the request parameters if the client is used for several concurrent requests.
setAdapter (line 762)
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
setAuth (line 511)
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 292)
Set configuration parameters for this HTTP client
setCookie (line 585)
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 546)
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 679)
Set the encoding type for POST data
setFileUpload (line 653)
Set a file to upload (using a POST request)
Can be used in two ways:
setHeaders (line 353)
Set one or more request headers
This function can be used in several ways to set the client's request headers:
setMethod (line 317)
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 419)
Set a GET parameter for the request. Wrapper around _setParameter
setParameterPost (line 438)
Set a POST parameter for the request. Wrapper around _setParameter
setRawData (line 698)
Set the raw (already encoded) POST data.
This function is here for two reasons:
_detectFileMimeType (line 1092)
Attempt to detect the MIME type of a file using available extensions
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
_getParametersRecursive (line 1054)
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.
_prepareBody (line 978)
Prepare the request body (for POST and PUT requests)
_prepareHeaders (line 902)
Prepare the request headers
_setParameter (line 458)
Set a GET or POST parameter - used by SetParameterGet and SetParameterPost
AUTH_BASIC
= 'basic'
(line 78)
Supported HTTP Authentication methods
CONNECT
= 'CONNECT'
(line 73)
DELETE
= 'DELETE'
(line 70)
ENC_FORMDATA
= 'multipart/form-data'
(line 91)
ENC_URLENCODED
= 'application/x-www-form-urlencoded'
(line 90)
POST data encoding methods
GET
= 'GET'
(line 66)
HTTP request methods
HEAD
= 'HEAD'
(line 69)
HTTP_0
= '1.0'
(line 85)
HTTP_1
= '1.1'
(line 84)
HTTP protocol versions
OPTIONS
= 'OPTIONS'
(line 72)
POST
= 'POST'
(line 67)
PUT
= 'PUT'
(line 68)
TRACE
= 'TRACE'
(line 71)
Documentation generated on Mon, 15 Sep 2008 00:15:13 +0400 by phpDocumentor 1.4.2