API Joomla 1.5.26
Documentation des API du CMS Joomla en version 1.5

Référence de la classe php_http_client_generic

Graphe d'héritage de php_http_client_generic:
Graphe de collaboration de php_http_client_generic:

Liste de tous les membres

Fonctions membres publiques

Attributs publics


Documentation des fonctions membres

php_http_client_generic::connect ( )

Establishes a client connection

Références headers, et php_http_request::setHeader().

Référencé par get(), head(), et post().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::decodeChunkedData ( data)

Decodes data if transfer encoding chunked

Paramètres:
stringThe encoded data
Renvoie:
string The decoded data

Références $data.

Référencé par normalizeResponseIfChunked().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::defaultHTTPEventHandler ( data)

The default http event handler; fired if no custom handler has been registered

Paramètres:
stringThe event data

Références $data, et printHTML().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::disconnect ( )

Disconnects the current client connection if one exists

php_http_client_generic::fireEvent ( target,
data 
)

Fires an http event that has been registered

Paramètres:
stringThe name of the event, e.g., onRead
stringThe data to be passed to the event

Références $data, et $target.

Référencé par send().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::generateResponseHeadersAsObject ( responseHeadersAsObject)

Specifies that the response headers array should be generated

Paramètres:
booleanTrue if the response headers array should be built

Références $responseHeadersAsObject.

& php_http_client_generic::get ( url)

Performs an HTTP GET

Paramètres:
stringThe target url
Renvoie:
object An HTTP response object

Références $url, connect(), get_custom(), send(), php_http_request::setRequestMethod(), et php_http_request::setRequestPath().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::get_custom ( url)

Handler for customizing the HTTP GET call

Paramètres:
stringThe target url

Réimplémentée dans php_http_proxy.

Référencé par get().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::getHTTPEvent ( option)

Evaluates whether the specified http event option is active

Paramètres:
stringThe http event option to evaluate
Renvoie:
boolean True if the specified option is active

Références $option.

& php_http_client_generic::head ( url)

Performs an HTTP HEAD

Paramètres:
stringThe target url
Renvoie:
object An HTTP response object

Références $url, connect(), head_custom(), send(), et php_http_request::setRequestMethod().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::head_custom ( url)

Handler for customizing the HTTP HEAD call

Paramètres:
stringThe target url

Référencé par head().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::isConnected ( )

Evaluated whether the current client is connected

Renvoie:
boolean True if a connection exists
php_http_client_generic::normalizeResponseIfChunked ( )

Determines if response data is transfer encoding chunked, then decodes

Références decodeChunkedData().

Référencé par send().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::php_http_client_generic ( host = '',
path = '/',
port = 80,
timeout = 0 
)

HTTP Client constructor

Paramètres:
stringThe client connection host name, with or without its protocol prefix
stringThe client connection path, not including the host name
intThe port to establish the client connection on
intThe timeout value for the client connection

Références $host, $path, headers, et php_http_request::setHeaders().

Référencé par php_http_proxy::php_http_proxy().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

& php_http_client_generic::post ( data)

Performs an HTTP POST

Paramètres:
stringThe posted data
Renvoie:
object An HTTP response object

Références $data, connect(), post_custom(), send(), php_http_request::setHeader(), et php_http_request::setRequestMethod().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::post_custom ( data)

Handler for customizing the HTTP POST call

Paramètres:
stringThe post data

Référencé par post().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::printHTML ( html)

Prints the data to the browser as preformatted, htmlentified output

Paramètres:
stringThe data to be printed

Référencé par defaultHTTPEventHandler().

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::send ( message)

Sends data through the client connection

Paramètres:
stringThe message to be sent
Renvoie:
string The http response

Références $data, php_http_request::$headers, $response, fireEvent(), headers, normalizeResponseIfChunked(), et HTTPExceptions::raiseException().

Référencé par get(), head(), et post().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

php_http_client_generic::setHTTPEvent ( option,
truthVal,
customHandler = null 
)

Sets which http events are to be fired

Paramètres:
stringThe http event option to be set
stringTrue if the event is to be fired
objectA reference to a custom handler for the http event data

Références $option.


Documentation des données membres

php_http_client_generic::$connection
php_http_client_generic::$events
Valeur initiale :
 array('onRequest' => null, 'onRead' => null,
                                                'onResponse' => null, 'onResponseHeaders' => null,
                                                'onResponseBody' => null)
php_http_client_generic::$response = null

Référencé par send().

php_http_client_generic::$responseHeadersAsObject = false

La documentation de cette classe a été générée à partir du fichier suivant :