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

Référence de la classe xml_domit_rss_base_document

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

Liste de tous les membres

Fonctions membres publiques

Attributs publics


Documentation des fonctions membres

xml_domit_rss_base_document::createDefaultCache ( cacheDir = './',
cacheTime = 3600 
)

Instantiates a default cache (php_text_cache)

Paramètres:
stringDirectory for cache files
intExpiration time for a cache file

Références $cacheDir.

Référencé par loadRSS(), parseRSS(), useCacheLite(), et xml_domit_rss_base_document().

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::createDocument ( )

Creates an empty DOMIT! document to contain the RSS nodes

Référencé par xml_domit_rss_base_document().

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::disableCache ( )

Disables caching mechanism

xml_domit_rss_base_document::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 setConnection().

Référencé par getTextFromFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

& xml_domit_rss_base_document::fromFile ( filename)

Reads in RSS text from a file and parses it

Paramètres:
stringThe file path
Renvoie:
boolean True if parsing is successful

Références $filename.

& xml_domit_rss_base_document::fromString ( rssText)

Reads in RSS text from a string and parses it

Paramètres:
stringThe RSS text
Renvoie:
boolean True if parsing is successful

Référencé par parseRSSData().

Voici le graphe d'appel pour cette fonction :

& xml_domit_rss_base_document::getChannel ( index)

Returns a reference to the channel located at the specified index

Renvoie:
Object A reference to the channel located at the specified index
xml_domit_rss_base_document::getChannelCount ( )

Returns the number of channels in the document

Renvoie:
int The number of channels in the document
xml_domit_rss_base_document::getDataFromCache ( url)

Retrieves the RSS data from the url/cache file

Paramètres:
stringThe url for the RSS data
Renvoie:
string The RSS data

Références $url, getTextFromFile(), et useCacheLite().

Référencé par loadRSSData().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

& xml_domit_rss_base_document::getDocument ( )

Gets a reference to the underlying DOM document

Renvoie:
Object A reference to the underlying DOM document
& xml_domit_rss_base_document::getNode ( )

Gets a reference to the root DOM element

Renvoie:
Object A reference to the root DOM element

Réimplémentée à partir de xml_domit_rss_base.

xml_domit_rss_base_document::getRSSVersion ( )

Returns the version of RSS used to format the data

Renvoie:
string The version of RSS used to format the data

Références $i, $total, et $version.

xml_domit_rss_base_document::getTextFromFile ( 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, establishConnection(), et php_file_utilities::getDataFromFile().

Référencé par getDataFromCache(), loadRSS(), et xml_domit_rss_base_document().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::handleChannelElementsEmbedded ( )

Forces channel elements that are external to a channel to be referenced as subelements of that channel

Référencé par xml_domit_rss_document_lite::_init(), et xml_domit_rss_document::_init().

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::loadRSS ( url)

Loads and parses the RSS at the specified url

Paramètres:
stringThe url of the RSS feed
Renvoie:
boolean True if parsing is successful

Références $url, xml_domit_rss_elementindexer::_init(), createDefaultCache(), getTextFromFile(), loadRSSData(), et parseRSS().

Référencé par xml_domit_rss_base_document().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::loadRSSData ( url)

Retrieves the RSS data from the url/cache file and parses

Paramètres:
stringThe url for the RSS data
Renvoie:
boolean True if parsing is successful

Références $url, getDataFromCache(), et parseRSSData().

Référencé par loadRSS().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::parsedBy ( )

Returns the name of the parser

Renvoie:
string Either 'DOMIT_RSS' or 'DOMIT_RSS_LITE'
xml_domit_rss_base_document::parseRSS ( rssText)

Parses the RSS text provided

Paramètres:
stringThe RSS text
Renvoie:
boolean True if parsing is successful

Références xml_domit_rss_elementindexer::_init(), createDefaultCache(), et parseRSSData().

Référencé par loadRSS(), et xml_domit_rss_base_document().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::parseRSSData ( rssText)

Parses the RSS data provided

Paramètres:
stringThe the RSS data
Renvoie:
boolean True if parsing is successful

Références fromString().

Référencé par loadRSSData(), et parseRSS().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::setAuthorization ( user,
password 
)

Specifies basic authentication for an http connection

Paramètres:
stringThe user name
stringThe password

Références $user.

xml_domit_rss_base_document::setConnection ( host,
path = '/',
port = 80,
timeout = 0,
user = null,
password = null 
)

Specifies the parameters of the http conection used to obtain the xml data

Paramètres:
stringThe ip address or domain name of the connection
stringThe path of the connection
intThe port that the connection is listening on
intThe timeout value for the connection
stringThe user name, if authentication is required
stringThe password, if authentication is required

Références $host, $path, et $user.

Référencé par establishConnection().

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::setProxyAuthorization ( user,
password 
)

Specifies a user name and password for the proxy

Paramètres:
stringThe user name
stringThe password

Références $user.

xml_domit_rss_base_document::setProxyConnection ( host,
path = '/',
port = 80,
timeout = 0,
user = null,
password = null 
)

Specifies that a proxy is to be used to obtain the xml data

Paramètres:
stringThe ip address or domain name of the proxy
stringThe path to the proxy
intThe port that the proxy is listening on
intThe timeout value for the connection
stringThe user name, if authentication is required
stringThe password, if authentication is required

Références $host, $path, et $user.

xml_domit_rss_base_document::setRSSTimeout ( rssTimeout)

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

Références $rssTimeout, et useCacheLite().

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::useCacheLite ( doUseCacheLite,
pathToLibrary = './Lite.php',
cacheDir = './',
cacheTime = 3600 
)

Substitutes PEAR::Cache_Lite for the default php_text_cache

Paramètres:
booleanTrue if Cache Lite is to be used
stringAbsolute or relative path to the Cache Lite library
stringDirectory for cache files
intExpiration time for a cache file

Références $cacheDir, et createDefaultCache().

Référencé par getDataFromCache(), et setRSSTimeout().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

xml_domit_rss_base_document::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
xml_domit_rss_base_document::xml_domit_rss_base_document ( url = '',
cacheDir = './',
cacheTime = 3600 
)

Constructor

Paramètres:
stringPath to the rss file
stringDirectory in which cache files are to be stored
intExpiration time (in seconds) for the cache file
Renvoie:
mixed Null if an url was not provided, true if an url was provided and parsing was successful, false otherwise

Références $cacheDir, $url, createDefaultCache(), createDocument(), getTextFromFile(), loadRSS(), et parseRSS().

Référencé par xml_domit_rss_document::xml_domit_rss_document(), et xml_domit_rss_document_lite::xml_domit_rss_document_lite().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :


Documentation des données membres

xml_domit_rss_base_document::$cache
xml_domit_rss_base_document::$cacheEnabled = true
xml_domit_rss_base_document::$domit_rss_categories = array()
xml_domit_rss_base_document::$domit_rss_channels = array()
xml_domit_rss_base_document::$domit_rss_items = array()
xml_domit_rss_base_document::$doUseHTTPClient = false
xml_domit_rss_base_document::$httpConnection = null
xml_domit_rss_base_document::$parser
xml_domit_rss_base_document::$rssTimeout = 0

Référencé par setRSSTimeout().

xml_domit_rss_base_document::$useCacheLite = false

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