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

Référence de la classe php_text_cache

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

Liste de tous les membres

Fonctions membres publiques

Attributs publics


Documentation des fonctions membres

php_text_cache::establishConnection ( url)

Establishes a connection, given an url

Paramètres:
stringThe url of the data

Références $host, $url, php_http_connection::formatHost(), et php_http_connector::setConnection().

Référencé par fromURL().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

php_text_cache::fromCache ( cacheFile)

Get text from cache file

Paramètres:
stringThe file path
Renvoie:
string The text contained in the file, or an empty string

Références fromFile().

Référencé par getData().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

php_text_cache::fromFile ( filename)

Get text from an url or file

Paramètres:
stringThe url or file path
Renvoie:
string The text contained in the url or file, or an empty string

Références $filename, et php_file_utilities::getDataFromFile().

Référencé par fromCache(), et fromURL().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

php_text_cache::fromURL ( url,
cacheFile 
)

Gets data from an url and caches a copy of the data

Paramètres:
stringThe url for the data
stringThe cache file path
Renvoie:
string The contents of the url

Références $url, establishConnection(), fromFile(), et php_file_utilities::putDataToFile().

Référencé par getData().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

php_text_cache::getCacheFileName ( url)

Given an url, returns the path to the cache file

Uses an md5 hash of the url. This can be overridden if a different approach is required

Paramètres:
stringThe url of the data
Renvoie:
string The cache file name

Références $url.

Référencé par getData().

Voici le graphe d'appel pour cette fonction :

php_text_cache::getData ( url)

Gets data from an url, or its cache file

Paramètres:
stringThe url of the data
Renvoie:
string The data at the specified url

Références $url, fromCache(), fromURL(), et getCacheFileName().

Voici le graphe d'appel pour cette fonction :

php_text_cache::php_text_cache ( cacheDir = './',
cacheTime = -1,
timeout = 0 
)

Constructor

Paramètres:
stringDirectory in which to store the cache files
intExpiry time for cache file (-1 signifies no expiry limit)
intTime in seconds to disconnect after attempting an http connection

Références $cacheDir, et $cacheTime.

php_text_cache::setTimeout ( timeout)

Specifies the default timeout value for connecting to a host

Paramètres:
intThe number of seconds to timeout when attempting to connect to a server
php_text_cache::useHTTPClient ( truthVal)

Specifies whether an HTTP client should be used to establish a connection

Paramètres:
booleanTrue if an HTTP client is to be used to establish the connection

Documentation des données membres

php_text_cache::$cacheDir

Référencé par php_text_cache().

php_text_cache::$cacheTime

Référencé par php_text_cache().

php_text_cache::$doUseHTTPClient
php_text_cache::$httpTimeout

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