Microsoft_Http |
![]() |
[ class tree: Microsoft_Http ] [ index: Microsoft_Http ] [ all elements ] |
![]() |
Packages: Microsoft_WindowsAzure Microsoft Microsoft_Http Microsoft_Log Microsoft_Uri Microsoft_WindowsAzure_Storage Files: subpackage Client subpackage Client_Adapter subpackage Client_Adapter_Exception subpackage Client_Exception subpackage Cookie subpackage CookieJar subpackage Exception subpackage Response Interfaces: Classes: |
[ Top ] $cookiejar = null[line 186] The client's cookie jarTags:
[ Top ] $enctype = null[line 148] Request body content type (for POST requests)Tags:
[ Top ] $files = array()[line 179] 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') Tags:
[ Top ] $headers = array()[line 120] Associative array of request headersTags:
[ Top ] $last_request = null[line 193] The last HTTP request sent by the client, as stringTags:
[ Top ] $last_response = null[line 200] The last HTTP response received by the clientTags:
[ Top ] $method = self::GET[line 127] HTTP request methodTags:
[ Top ] $paramsGet = array()[line 134] Associative array of GET parametersTags:
[ Top ] $paramsPost = array()[line 141] Assiciative array of POST parametersTags:
[ Top ] $raw_post_data = null[line 155] The raw post data to send. Could be set by setRawData($data, $enctype).Tags:
[ Top ] $redirectCounter = 0[line 207] Redirection counterTags:
[ Top ] $uri = null[line 113] Request URITags:
[ Top ] Class Methodsstatic method encodeAuthHeader [line 1350]
Create a HTTP authentication "Authorization:" header according to the specified user, password and authentication method. Tags:
Parameters:
[ Top ]
static method encodeFormData [line 1320]
Encode data to a multipart/form-data part suitable for a POST request. Tags:
Parameters:
[ Top ]
static method _flattenParametersArray [line 1395]
Convert an array of parameters into a flat array of (key, value) pairs 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. Tags:
Parameters:
[ Top ]
constructor __construct [line 226]
Contructor method. Will create a new HTTP client. Accepts the target URL and optionally configuration array. Tags:
Parameters:
[ Top ]
method getAdapter [line 841]
Load the connection adapter Tags:
[ Top ]
method getCookieJar [line 589]
Return the current cookie jar or null if none. Tags:
[ Top ]
method getHeader [line 414]
Get the value of a specific header Note that if the header has more than one value, an array will be returned. Tags:
Parameters:
[ Top ]
method getLastRequest [line 786]method getLastResponse [line 799]
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 Tags:
[ Top ]
method getRedirectionsCount [line 495]
Get the number of redirections done on the last request Tags:
[ Top ]
method getStream [line 862]method getUri [line 276]
Get the URI for the next request Tags:
Parameters:
[ Top ]
method request [line 898]
Send the HTTP request and return an HTTP response object Tags:
Parameters:
[ Top ]
method resetParameters [line 756]
Clear all GET and POST parameters 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_* Tags:
Parameters:
[ Top ]
method setAdapter [line 814]
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 Tags:
Parameters:
[ Top ]
method setAuth [line 523]
Set HTTP authentication parameters $type should be one of the supported types - see the self::AUTH_* constants. To enable authentication: To disable authentication: Tags:
Parameters:
[ Top ]
method setConfig [line 292]
Set configuration parameters for this HTTP client Tags:
Parameters:
[ Top ]
method setCookie [line 603]
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. Tags:
Parameters:
[ Top ]
method setCookieJar [line 563]
Set the HTTP client's cookie jar. A cookie jar is an object that holds and maintains cookies across HTTP requests and responses. Tags:
Parameters:
[ Top ]
method setEncType [line 709]
Set the encoding type for POST data Tags:
Parameters:
[ Top ]
method setFileUpload [line 676]
Set a file to upload (using a POST request) Can be used in two ways:
Tags:
Parameters:
[ Top ]
method setHeaders [line 362]
Set one or more request headers This function can be used in several ways to set the client's request headers:
Tags:
Parameters:
[ Top ]
method setMethod [line 326]
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. Tags:
Parameters:
[ Top ]
method setParameterGet [line 431]
Set a GET parameter for the request. Wrapper around _setParameter Tags:
Parameters:
[ Top ]
method setParameterPost [line 450]
Set a POST parameter for the request. Wrapper around _setParameter Tags:
Parameters:
[ Top ]
method setRawData [line 730]
Set the raw (already encoded) POST data. This function is here for two reasons:
Tags:
Parameters:
[ Top ]
method setStream [line 852]
Set streaming for received data Tags:
Parameters:
[ Top ]
method setUri [line 243]
Set the URI for the next request Tags:
Parameters:
[ Top ]
method _detectFileMimeType [line 1284]
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 Tags:
Parameters:
[ Top ]
method _getParametersRecursive [line 1234]
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. This method is deprecated since Zend Framework 1.9 in favour of self::_flattenParametersArray() and will be dropped in 2.0 Tags:
Parameters:
[ Top ]
method _openTempStream [line 872]method _prepareBody [line 1127]
Prepare the request body (for POST and PUT requests) Tags:
[ Top ]
method _prepareHeaders [line 1046]method _setParameter [line 470]
Set a GET or POST parameter - used by SetParameterGet and SetParameterPost Tags:
Parameters:
[ Top ]
Class ConstantsAUTH_BASIC = 'basic'[line 62] Supported HTTP Authentication methods[ Top ] CONNECT = 'CONNECT'[line 56] [ Top ] CONTENT_LENGTH = 'Content-Length'[line 75] [ Top ] CONTENT_TYPE = 'Content-Type'[line 74] Content attributes[ Top ] DELETE = 'DELETE'[line 53] [ Top ] ENC_FORMDATA = 'multipart/form-data'[line 81] [ Top ] ENC_URLENCODED = 'application/x-www-form-urlencoded'[line 80] POST data encoding methods[ Top ] GET = 'GET'[line 49] HTTP request methods[ Top ] HEAD = 'HEAD'[line 52] [ Top ] HTTP_0 = '1.0'[line 69] [ Top ] HTTP_1 = '1.1'[line 68] HTTP protocol versions[ Top ] MERGE = 'MERGE'[line 57] [ Top ] OPTIONS = 'OPTIONS'[line 55] [ Top ] POST = 'POST'[line 50] [ Top ] PUT = 'PUT'[line 51] [ Top ] TRACE = 'TRACE'[line 54] [ Top ] Documentation generated on Wed, 18 May 2011 12:06:22 +0200 by phpDocumentor 1.4.3 |