Element index for package Microsoft_Http
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
_
- $_fileInfoDb
- in file Client.php, variable Microsoft_Http_Client::$_fileInfoDb
Fileinfo magic database resource
- _detectFileMimeType
- in file Client.php, method Microsoft_Http_Client::_detectFileMimeType()
Attempt to detect the MIME type of a file using available extensions
- _flattenParametersArray
- in file Client.php, method Microsoft_Http_Client::_flattenParametersArray()
Convert an array of parameters into a flat array of (key, value) pairs
- _getParametersRecursive
- in file Client.php, method Microsoft_Http_Client::_getParametersRecursive()
Helper method that gets a possibly multi-level parameters array (get or post) and flattens it.
- _openTempStream
- in file Client.php, method Microsoft_Http_Client::_openTempStream()
Create temporary stream
- _prepareBody
- in file Client.php, method Microsoft_Http_Client::_prepareBody()
Prepare the request body (for POST and PUT requests)
- _prepareHeaders
- in file Client.php, method Microsoft_Http_Client::_prepareHeaders()
Prepare the request headers
- _setParameter
- in file Client.php, method Microsoft_Http_Client::_setParameter()
Set a GET or POST parameter - used by SetParameterGet and SetParameterPost
- __construct
- in file Client.php, method Microsoft_Http_Client::__construct()
Contructor method. Will create a new HTTP client. Accepts the target URL and optionally configuration array.
- $_config
- in file Curl.php, variable Microsoft_Http_Client_Adapter_Curl::$_config
Parameters array
- $_connected_to
- in file Curl.php, variable Microsoft_Http_Client_Adapter_Curl::$_connected_to
What host/port are we connected to?
- $_context
- in file Socket.php, variable Microsoft_Http_Client_Adapter_Socket::$_context
Stream context
- $_curl
- in file Curl.php, variable Microsoft_Http_Client_Adapter_Curl::$_curl
The curl session handle
- $_invalidOverwritableCurlOptions
- in file Curl.php, variable Microsoft_Http_Client_Adapter_Curl::$_invalidOverwritableCurlOptions
List of cURL options that should never be overwritten
- $_response
- in file Curl.php, variable Microsoft_Http_Client_Adapter_Curl::$_response
Response gotten from server
- _checkSocketReadTimeout
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::_checkSocketReadTimeout()
Check if the socket has timed out - if so close connection and throw an exception
- __construct
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::__construct()
Adapter constructor, currently empty. Config is set using setConfig()
- __construct
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::__construct()
Adapter constructor
- __destruct
- in file Proxy.php, method Microsoft_Http_Client_Adapter_Proxy::__destruct()
Destructor: make sure the socket is disconnected
- __destruct
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::__destruct()
Destructor: make sure the socket is disconnected
- __construct
- in file Cookie.php, method Microsoft_Http_Cookie::__construct()
Cookie object constructor
- __toString
- in file Cookie.php, method Microsoft_Http_Cookie::__toString()
Get the cookie as a string, suitable for sending as a "Cookie" header in an HTTP request
- $_rawCookies
- in file CookieJar.php, variable Microsoft_Http_CookieJar::$_rawCookies
The Microsoft_Http_Cookie array
- _flattenCookiesArray
- in file CookieJar.php, method Microsoft_Http_CookieJar::_flattenCookiesArray()
Helper function to recursivly flatten an array. Shoud be used when exporting the cookies array (or parts of it)
- _matchDomain
- in file CookieJar.php, method Microsoft_Http_CookieJar::_matchDomain()
Return a subset of the cookies array matching a specific domain
- _matchPath
- in file CookieJar.php, method Microsoft_Http_CookieJar::_matchPath()
Return a subset of a domain-matching cookies that also match a specified path
- __construct
- in file CookieJar.php, method Microsoft_Http_CookieJar::__construct()
Construct a new CookieJar object
- $_cleanup
- in file Stream.php, variable Microsoft_Http_Response_Stream::$_cleanup
Should we clean up the stream file when this response is closed?
- __construct
- in file Stream.php, method Microsoft_Http_Response_Stream::__construct()
HTTP response constructor
- __construct
- in file Response.php, method Microsoft_Http_Response::__construct()
HTTP response constructor
- __destruct
- in file Stream.php, method Microsoft_Http_Response_Stream::__destruct()
- __toString
- in file Response.php, method Microsoft_Http_Response::__toString()
Implements magic __toString()
top
top
top
c
- $config
- in file Client.php, variable Microsoft_Http_Client::$config
Configuration array, set using the constructor or using ::setConfig()
- $cookiejar
- in file Client.php, variable Microsoft_Http_Client::$cookiejar
The client's cookie jar
- CONNECT
- in file Client.php, class constant Microsoft_Http_Client::CONNECT
- CONTENT_LENGTH
- in file Client.php, class constant Microsoft_Http_Client::CONTENT_LENGTH
- CONTENT_TYPE
- in file Client.php, class constant Microsoft_Http_Client::CONTENT_TYPE
Content attributes
- Client.php
- procedural page Client.php
- $config
- in file Socket.php, variable Microsoft_Http_Client_Adapter_Socket::$config
Parameters array
- $config
- in file Proxy.php, variable Microsoft_Http_Client_Adapter_Proxy::$config
Parameters array
- $connected_to
- in file Socket.php, variable Microsoft_Http_Client_Adapter_Socket::$connected_to
What host/port are we connected to?
- close
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::close()
Close the connection to the server
- close
- in file Proxy.php, method Microsoft_Http_Client_Adapter_Proxy::close()
Close the connection to the server
- close
- in file Interface.php, method Microsoft_Http_Client_Adapter_Interface::close()
Close the connection to the server
- close
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::close()
Close the connection to the server
- connect
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::connect()
Initialize curl
- connect
- in file Proxy.php, method Microsoft_Http_Client_Adapter_Proxy::connect()
Connect to the remote server
- connect
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::connect()
Connect to the remote server
- connect
- in file Interface.php, method Microsoft_Http_Client_Adapter_Interface::connect()
Connect to the remote server
- connectHandshake
- in file Proxy.php, method Microsoft_Http_Client_Adapter_Proxy::connectHandshake()
Preform handshaking with HTTPS proxy using CONNECT method
- Curl.php
- procedural page Curl.php
- Cookie.php
- procedural page Cookie.php
- $cookies
- in file CookieJar.php, variable Microsoft_Http_CookieJar::$cookies
Array storing cookies
- COOKIE_OBJECT
- in file CookieJar.php, class constant Microsoft_Http_CookieJar::COOKIE_OBJECT
Return cookie(s) as a Microsoft_Http_Cookie object
- COOKIE_STRING_ARRAY
- in file CookieJar.php, class constant Microsoft_Http_CookieJar::COOKIE_STRING_ARRAY
Return cookie(s) as a string (suitable for sending in an HTTP request)
- COOKIE_STRING_CONCAT
- in file CookieJar.php, class constant Microsoft_Http_CookieJar::COOKIE_STRING_CONCAT
Return all cookies as one long string (suitable for sending in an HTTP request)
- count
- in file CookieJar.php, method Microsoft_Http_CookieJar::count()
Required by Countable interface
- CookieJar.php
- procedural page CookieJar.php
- $code
- in file Response.php, variable Microsoft_Http_Response::$code
The HTTP response code
top
top
e
- $enctype
- in file Client.php, variable Microsoft_Http_Client::$enctype
Request body content type (for POST requests)
- encodeAuthHeader
- in file Client.php, method Microsoft_Http_Client::encodeAuthHeader()
Create a HTTP authentication "Authorization:" header according to the specified user, password and authentication method.
- encodeFormData
- in file Client.php, method Microsoft_Http_Client::encodeFormData()
Encode data to a multipart/form-data part suitable for a POST request.
- ENC_FORMDATA
- in file Client.php, class constant Microsoft_Http_Client::ENC_FORMDATA
- ENC_URLENCODED
- in file Client.php, class constant Microsoft_Http_Client::ENC_URLENCODED
POST data encoding methods
- Exception.php
- procedural page Exception.php
- Exception.php
- procedural page Exception.php
- $expires
- in file Cookie.php, variable Microsoft_Http_Cookie::$expires
Cookie expiry date
- Exception.php
- procedural page Exception.php
- extractBody
- in file Response.php, method Microsoft_Http_Response::extractBody()
Extract the body from a response string
- extractCode
- in file Response.php, method Microsoft_Http_Response::extractCode()
Extract the response code from a response string
- extractHeaders
- in file Response.php, method Microsoft_Http_Response::extractHeaders()
Extract the headers from a response string
- extractMessage
- in file Response.php, method Microsoft_Http_Response::extractMessage()
Extract the HTTP message from a response
- extractVersion
- in file Response.php, method Microsoft_Http_Response::extractVersion()
Extract the HTTP version from a response
top
top
g
- GET
- in file Client.php, class constant Microsoft_Http_Client::GET
HTTP request methods
- getAdapter
- in file Client.php, method Microsoft_Http_Client::getAdapter()
Load the connection adapter
- getCookieJar
- in file Client.php, method Microsoft_Http_Client::getCookieJar()
Return the current cookie jar or null if none.
- getHeader
- in file Client.php, method Microsoft_Http_Client::getHeader()
Get the value of a specific header
- getLastRequest
- in file Client.php, method Microsoft_Http_Client::getLastRequest()
Get the last HTTP request as string
- getLastResponse
- in file Client.php, method Microsoft_Http_Client::getLastResponse()
Get the last HTTP response received by this client
- getRedirectionsCount
- in file Client.php, method Microsoft_Http_Client::getRedirectionsCount()
Get the number of redirections done on the last request
- getStream
- in file Client.php, method Microsoft_Http_Client::getStream()
Get status of streaming for received data
- getUri
- in file Client.php, method Microsoft_Http_Client::getUri()
Get the URI for the next request
- getConfig
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::getConfig()
Retrieve the array of all configuration options
- getConfig
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::getConfig()
Retrieve the array of all configuration options
- getHandle
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::getHandle()
Get cUrl Handle
- getStreamContext
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::getStreamContext()
Get the stream context for the TCP connection to the server.
- getDomain
- in file Cookie.php, method Microsoft_Http_Cookie::getDomain()
Get cookie domain
- getExpiryTime
- in file Cookie.php, method Microsoft_Http_Cookie::getExpiryTime()
Get the expiry time of the cookie, or null if no expiry time is set
- getName
- in file Cookie.php, method Microsoft_Http_Cookie::getName()
Get Cookie name
- getPath
- in file Cookie.php, method Microsoft_Http_Cookie::getPath()
Get the cookie path
- getValue
- in file Cookie.php, method Microsoft_Http_Cookie::getValue()
Get cookie value
- getAllCookies
- in file CookieJar.php, method Microsoft_Http_CookieJar::getAllCookies()
Get all cookies in the cookie jar as an array
- getCookie
- in file CookieJar.php, method Microsoft_Http_CookieJar::getCookie()
Get a specific cookie according to a URI and name
- getIterator
- in file CookieJar.php, method Microsoft_Http_CookieJar::getIterator()
Required by IteratorAggregate interface
- getMatchingCookies
- in file CookieJar.php, method Microsoft_Http_CookieJar::getMatchingCookies()
Return an array of all cookies matching a specific request according to the request URI, whether session cookies should be sent or not, and the time to consider as "now" when checking cookie expiry time.
- getBody
- in file Stream.php, method Microsoft_Http_Response_Stream::getBody()
Get the response body as string
- getBody
- in file Response.php, method Microsoft_Http_Response::getBody()
Get the response body as string
- getCleanup
- in file Stream.php, method Microsoft_Http_Response_Stream::getCleanup()
Get the cleanup trigger
- getHeader
- in file Response.php, method Microsoft_Http_Response::getHeader()
Get a specific header as string, or null if it is not set
- getHeaders
- in file Response.php, method Microsoft_Http_Response::getHeaders()
Get the response headers
- getHeadersAsString
- in file Response.php, method Microsoft_Http_Response::getHeadersAsString()
Get all headers as string
- getMessage
- in file Response.php, method Microsoft_Http_Response::getMessage()
Return a message describing the HTTP response code (Eg. "OK", "Not Found", "Moved Permanently")
- getRawBody
- in file Response.php, method Microsoft_Http_Response::getRawBody()
Get the raw response body (as transfered "on wire") as string
- getRawBody
- in file Stream.php, method Microsoft_Http_Response_Stream::getRawBody()
Get the raw response body (as transfered "on wire") as string
- getStatus
- in file Response.php, method Microsoft_Http_Response::getStatus()
Get the HTTP response status code
- getStream
- in file Stream.php, method Microsoft_Http_Response_Stream::getStream()
Get the response as stream
- getStreamName
- in file Stream.php, method Microsoft_Http_Response_Stream::getStreamName()
Get file name associated with the stream
- getVersion
- in file Response.php, method Microsoft_Http_Response::getVersion()
Get the HTTP version of the response
top
top
top
top
m
- $method
- in file Client.php, variable Microsoft_Http_Client::$method
HTTP request method
- MERGE
- in file Client.php, class constant Microsoft_Http_Client::MERGE
- Microsoft_Http_Client
- in file Client.php, class Microsoft_Http_Client
Microsoft_Http_Client is an implemetation of an HTTP client in PHP. The client
- Microsoft_Http_Client_Exception
- in file Exception.php, class Microsoft_Http_Client_Exception
- $method
- in file Socket.php, variable Microsoft_Http_Client_Adapter_Socket::$method
Request method - will be set by write() and might be used by read()
- Microsoft_Http_Client_Adapter_Curl
- in file Curl.php, class Microsoft_Http_Client_Adapter_Curl
An adapter class for Microsoft_Http_Client based on the curl extension.
- Microsoft_Http_Client_Adapter_Exception
- in file Exception.php, class Microsoft_Http_Client_Adapter_Exception
- Microsoft_Http_Client_Adapter_Interface
- in file Interface.php, class Microsoft_Http_Client_Adapter_Interface
An interface description for Microsoft_Http_Client_Adapter classes.
- Microsoft_Http_Client_Adapter_Proxy
- in file Proxy.php, class Microsoft_Http_Client_Adapter_Proxy
HTTP Proxy-supporting Microsoft_Http_Client adapter class, based on the default socket based adapter.
- Microsoft_Http_Client_Adapter_Socket
- in file Socket.php, class Microsoft_Http_Client_Adapter_Socket
A sockets based (stream_socket_client) adapter class for Microsoft_Http_Client. Can be used on almost every PHP environment, and does not require any special extensions.
- Microsoft_Http_Client_Adapter_Stream
- in file Stream.php, class Microsoft_Http_Client_Adapter_Stream
An interface description for Microsoft_Http_Client_Adapter_Stream classes.
- match
- in file Cookie.php, method Microsoft_Http_Cookie::match()
Checks whether the cookie should be sent or not in a specific scenario
- matchCookieDomain
- in file Cookie.php, method Microsoft_Http_Cookie::matchCookieDomain()
Check if a cookie's domain matches a host name.
- matchCookiePath
- in file Cookie.php, method Microsoft_Http_Cookie::matchCookiePath()
Check if a cookie's path matches a URL path
- Microsoft_Http_Cookie
- in file Cookie.php, class Microsoft_Http_Cookie
Microsoft_Http_Cookie is a class describing an HTTP cookie and all it's parameters.
- Microsoft_Http_CookieJar
- in file CookieJar.php, class Microsoft_Http_CookieJar
A Microsoft_Http_CookieJar object is designed to contain and maintain HTTP cookies, and should be used along with Microsoft_Http_Client in order to manage cookies across HTTP requests and responses.
- Microsoft_Http_Exception
- in file Exception.php, class Microsoft_Http_Exception
- $message
- in file Response.php, variable Microsoft_Http_Response::$message
The HTTP response code as string (e.g. 'Not Found' for 404 or 'Internal Server Error' for 500)
- $messages
- in file Response.php, variable Microsoft_Http_Response::$messages
List of all known HTTP response codes - used by responseCodeAsText() to translate numeric codes to messages.
- Microsoft_Http_Response
- in file Response.php, class Microsoft_Http_Response
Microsoft_Http_Response represents an HTTP 1.0 / 1.1 response message. It includes easy access to all the response's different elemts, as well as some convenience methods for parsing and validating HTTP responses.
- Microsoft_Http_Response_Stream
- in file Stream.php, class Microsoft_Http_Response_Stream
Microsoft_Http_Response represents an HTTP 1.0 / 1.1 response message. It includes easy access to all the response's different elemts, as well as some convenience methods for parsing and validating HTTP responses.
top
top
top
top
r
- $raw_post_data
- in file Client.php, variable Microsoft_Http_Client::$raw_post_data
The raw post data to send. Could be set by setRawData($data, $enctype).
- $redirectCounter
- in file Client.php, variable Microsoft_Http_Client::$redirectCounter
Redirection counter
- request
- in file Client.php, method Microsoft_Http_Client::request()
Send the HTTP request and return an HTTP response object
- resetParameters
- in file Client.php, method Microsoft_Http_Client::resetParameters()
Clear all GET and POST parameters
- read
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::read()
Read response from server
- read
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::read()
Return read response from server
- read
- in file Interface.php, method Microsoft_Http_Client_Adapter_Interface::read()
Read response from server
- readHeader
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::readHeader()
Header reader function for CURL
- READ_TIMEOUT
- in file Exception.php, class constant Microsoft_Http_Client_Adapter_Exception::READ_TIMEOUT
- reset
- in file CookieJar.php, method Microsoft_Http_CookieJar::reset()
Empties the cookieJar of any cookie
- Response.php
- procedural page Response.php
- readStream
- in file Stream.php, method Microsoft_Http_Response_Stream::readStream()
Read stream content and return it as string
- responseCodeAsText
- in file Response.php, method Microsoft_Http_Response::responseCodeAsText()
A convenience function that returns a text representation of HTTP response codes. Returns 'Unknown' for unknown codes.
top
s
- setAdapter
- in file Client.php, method Microsoft_Http_Client::setAdapter()
Load the connection adapter
- setAuth
- in file Client.php, method Microsoft_Http_Client::setAuth()
Set HTTP authentication parameters
- setConfig
- in file Client.php, method Microsoft_Http_Client::setConfig()
Set configuration parameters for this HTTP client
- setCookie
- in file Client.php, method Microsoft_Http_Client::setCookie()
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
- in file Client.php, method Microsoft_Http_Client::setCookieJar()
Set the HTTP client's cookie jar.
- setEncType
- in file Client.php, method Microsoft_Http_Client::setEncType()
Set the encoding type for POST data
- setFileUpload
- in file Client.php, method Microsoft_Http_Client::setFileUpload()
Set a file to upload (using a POST request)
- setHeaders
- in file Client.php, method Microsoft_Http_Client::setHeaders()
Set one or more request headers
- setMethod
- in file Client.php, method Microsoft_Http_Client::setMethod()
Set the next request's method
- setParameterGet
- in file Client.php, method Microsoft_Http_Client::setParameterGet()
Set a GET parameter for the request. Wrapper around _setParameter
- setParameterPost
- in file Client.php, method Microsoft_Http_Client::setParameterPost()
Set a POST parameter for the request. Wrapper around _setParameter
- setRawData
- in file Client.php, method Microsoft_Http_Client::setRawData()
Set the raw (already encoded) POST data.
- setStream
- in file Client.php, method Microsoft_Http_Client::setStream()
Set streaming for received data
- setUri
- in file Client.php, method Microsoft_Http_Client::setUri()
Set the URI for the next request
- $socket
- in file Socket.php, variable Microsoft_Http_Client_Adapter_Socket::$socket
The socket for server connection
- Socket.php
- procedural page Socket.php
- Stream.php
- procedural page Stream.php
- setConfig
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::setConfig()
Set the configuration array for the adapter
- setConfig
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::setConfig()
Set the configuration array for the adapter
- setConfig
- in file Interface.php, method Microsoft_Http_Client_Adapter_Interface::setConfig()
Set the configuration array for the adapter
- setCurlOption
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::setCurlOption()
Direct setter for cURL adapter related options.
- setOutputStream
- in file Stream.php, method Microsoft_Http_Client_Adapter_Stream::setOutputStream()
Set output stream
- setOutputStream
- in file Curl.php, method Microsoft_Http_Client_Adapter_Curl::setOutputStream()
Set output stream for the response
- setOutputStream
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::setOutputStream()
Set output stream for the response
- setStreamContext
- in file Socket.php, method Microsoft_Http_Client_Adapter_Socket::setStreamContext()
Set the stream context for the TCP connection to the server
- $secure
- in file Cookie.php, variable Microsoft_Http_Cookie::$secure
Whether the cookie is secure or not
- $stream
- in file Stream.php, variable Microsoft_Http_Response_Stream::$stream
Response as stream
- $stream_name
- in file Stream.php, variable Microsoft_Http_Response_Stream::$stream_name
The name of the file containing the stream
- Stream.php
- procedural page Stream.php
- setCleanup
- in file Stream.php, method Microsoft_Http_Response_Stream::setCleanup()
Set the cleanup trigger
- setStream
- in file Stream.php, method Microsoft_Http_Response_Stream::setStream()
Set the response stream
- setStreamName
- in file Stream.php, method Microsoft_Http_Response_Stream::setStreamName()
Set file name associated with the stream
top
top
top
top
top
|
|