| [ Index ] |
|
Code source de Joomla 1.0.13 |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Author: | John Heinstein <johnkarl@nbnet.nb.ca> |
| Copyright: | (C) 2004 John Heinstein. All rights reserved |
| License: | http://www.gnu.org/copyleft/lesser.html LGPL License |
| Version: | 0.51 |
| Poids: | 1026 lignes (31 kb) |
| Inclus ou requis: | 2 fois |
| Référencé: | 0 fois |
| Nécessite: | 7 fichiers includes/domit/php_http_exceptions.php includes/domit/php_file_utilities.php includes/domit/php_text_cache.php includes/domit/xml_domit_include.php includes/domit/xml_domit_shared.php includes/domit/php_http_proxy.php includes/domit/php_http_client_generic.php |
xml_domit_rss_base:: (7 méthodes):
getNode()
getAttribute()
hasAttribute()
isRSSDefined()
isSimpleRSSElement()
get()
toNormalizedString()
xml_domit_rss_collection:: (5 méthodes):
addElement()
getElementAt()
getElement()
getElementCount()
getElementText()
xml_domit_rss_elementindexer:: (13 méthodes):
_init()
addIndexedElement()
isCollection()
isNode()
isCustomRSSElement()
getElementList()
hasElement()
getElement()
getElementAt()
indexNumerically()
getElementText()
getElementTextAt()
_getElementText()
xml_domit_rss_base_document:: (27 méthodes):
xml_domit_rss_base_document()
setRSSTimeout()
setConnection()
setAuthorization()
setProxyConnection()
setProxyAuthorization()
useHTTPClient()
parsedBy()
createDocument()
useCacheLite()
createDefaultCache()
disableCache()
loadRSS()
parseRSS()
loadRSSData()
getDataFromCache()
parseRSSData()
fromFile()
fromString()
establishConnection()
getTextFromFile()
getDocument()
getNode()
handleChannelElementsEmbedded()
getRSSVersion()
getChannelCount()
getChannel()
xml_domit_rss_simpleelement:: (2 méthodes):
xml_domit_rss_simpleelement()
getElementText()
xml_domit_rss_exception:: (4 méthodes):
raiseException()
setErrorHandler()
setErrorMode()
setErrorLog()
Classe: xml_domit_rss_base - X-Ref
The base class of all DOMIT! RSS objects| getNode() X-Ref |
| Retrieves the underlying DOMIT node return: Object The underlying DOMIT node |
| getAttribute($attr) X-Ref |
| Retrieves the text of the named attribute, checking first if the attribute exists param: string The attribute name return: string The attribute value, or an empty string |
| hasAttribute($attr) X-Ref |
| Checks whether the named attribute exists param: string The attribute name return: boolean True if the attribute exists |
| isRSSDefined($elementName) X-Ref |
| Tests whether the named element is predefined by the RSS spec param: string The element name return: boolean True if the element is predefined by the RSS spec |
| isSimpleRSSElement($elementName) X-Ref |
| Tests whether the named element has a single child text node param: string The element name return: boolean True if the named element has a single child text node |
| get($htmlSafe = false, $subEntities = false) X-Ref |
| Generates a string representation of the node and its children param: boolean True if HTML readable output is desired param: boolean True if illegal xml characters in text nodes and attributes should be converted to entities return: string The string representation |
| toNormalizedString($htmlSafe = false, $subEntities = false) X-Ref |
| Generates a normalized (formatted for readability) representation of the node and its children param: boolean True if HTML readable output is desired param: boolean True if illegal xml characters in text nodes and attributes should be converted to entities return: string The formatted string representation |
Classe: xml_domit_rss_collection - X-Ref
Represents a collection of custom RSS elements, e.g. a set of dc:creator entries| addElement(&$node) X-Ref |
| Adds a custom RSS element (DOM node) to the collection param: Object A DOM node representing a custom RSS element |
| getElementAt($index) X-Ref |
| Retrieves the element at the specified index param: int The index of the requested custom RSS element return: Object The DOMIT node representing the requested element |
| getElement($index) X-Ref |
| Retrieves the element at the specified index (alias for getElementAt) param: int The index of the requested custom RSS element return: Object The DOMIT node representing the requested element |
| getElementCount() X-Ref |
| Returns the number of elements in the collection return: int The number of members in the collection |
| getElementText() X-Ref |
| Gets a text representation of the collection (applies the toString method to each member and concatenates) return: string The element text |
Classe: xml_domit_rss_elementindexer - X-Ref
Provides indexing functionality to RSS classes| _init() X-Ref |
| Performs generic initialization of elements |
| addIndexedElement(&$node) X-Ref |
| Adds a custom element (one not defined by the RSS specs, e..g., dc:creator) to the indexer param: Object A DOMIT! node representing the custom element |
| isCollection($elementName) X-Ref |
| Indicates whether the requested element is actually a collection of elements of the same type param: string The name of the requested element return: boolean True if a collection of elements exists |
| isNode($elementName) X-Ref |
| Indicates whether the requested element is a DOMIT! node param: string The name of the requested element return: boolean True if the requested element is a DOMIT! node |
| isCustomRSSElement($elementName) X-Ref |
| Indicates whether the requested element is a DOMIT! node (alias for isNode) param: string The name of the requested element return: boolean True if the requested element is a DOMIT! node |
| getElementList() X-Ref |
| Gets a named list of existing elements as a child of the current element return: array A named list of existing elements |
| hasElement($elementName) X-Ref |
| Indicates whether a particular element exists param: string The name of the requested element return: boolean True if an element with the specified name exists |
| getElement($elementName) X-Ref |
| Gets a reference to an element with the specified name param: string The name of the requested element return: mixed A reference to an element with the specified name, or the text of the element if it is a text node |
| getElementAt($index) X-Ref |
| Gets a reference to an element at the specified index param: int The index of the requested element return: mixed A reference to an element at the specified index, or the text of the element if it is a text node |
| indexNumerically() X-Ref |
| Populates an integer-based index for elements if one isn't already present. |
| getElementText($elementName) X-Ref |
| Gets the text of the specified element param: string The name of the requested element return: string The element text, or an empty string |
| getElementTextAt($index) X-Ref |
| Gets the text at the specified index param: int The index of the requested element return: string The element text, or an empty string |
| _getElementText($index, &$myArray) X-Ref |
| Gets the text at the specified index param: mixed The index or name of the requested element param: array The indexing array from which to extract data return: string The element text, or an empty string |
Classe: xml_domit_rss_base_document - X-Ref
A base class for DOMIT! RSS and DOMIT! RSS Lite documents| xml_domit_rss_base_document($url = '', $cacheDir = './', $cacheTime = 3600) X-Ref |
| Constructor param: string Path to the rss file param: string Directory in which cache files are to be stored param: int Expiration time (in seconds) for the cache file return: mixed Null if an url was not provided, true if an url was provided and parsing was successful, false otherwise |
| setRSSTimeout($rssTimeout) X-Ref |
| Specifies the default timeout value for connecting to a host param: int The number of seconds to timeout when attempting to connect to a server |
| setConnection($host, $path = '/', $port = 80, $timeout = 0, $user = null, $password = null) X-Ref |
| Specifies the parameters of the http conection used to obtain the xml data param: string The ip address or domain name of the connection param: string The path of the connection param: int The port that the connection is listening on param: int The timeout value for the connection param: string The user name, if authentication is required param: string The password, if authentication is required |
| setAuthorization($user, $password) X-Ref |
| Specifies basic authentication for an http connection param: string The user name param: string The password |
| setProxyConnection($host, $path = '/', $port = 80, $timeout = 0, $user = null, $password = null) X-Ref |
| Specifies that a proxy is to be used to obtain the xml data param: string The ip address or domain name of the proxy param: string The path to the proxy param: int The port that the proxy is listening on param: int The timeout value for the connection param: string The user name, if authentication is required param: string The password, if authentication is required |
| setProxyAuthorization($user, $password) X-Ref |
| Specifies a user name and password for the proxy param: string The user name param: string The password |
| useHTTPClient($truthVal) X-Ref |
| Specifies whether an HTTP client should be used to establish a connection param: boolean True if an HTTP client is to be used to establish the connection |
| parsedBy() X-Ref |
| Returns the name of the parser return: string Either 'DOMIT_RSS' or 'DOMIT_RSS_LITE' |
| createDocument() X-Ref |
| Creates an empty DOMIT! document to contain the RSS nodes |
| useCacheLite($doUseCacheLite, $pathToLibrary = './Lite.php', $cacheDir = './', $cacheTime = 3600) X-Ref |
| Substitutes PEAR::Cache_Lite for the default php_text_cache param: boolean True if Cache Lite is to be used param: string Absolute or relative path to the Cache Lite library param: string Directory for cache files param: int Expiration time for a cache file |
| createDefaultCache($cacheDir = './', $cacheTime = 3600) X-Ref |
| Instantiates a default cache (php_text_cache) param: string Directory for cache files param: int Expiration time for a cache file |
| disableCache() X-Ref |
| Disables caching mechanism |
| loadRSS($url) X-Ref |
| Loads and parses the RSS at the specified url param: string The url of the RSS feed return: boolean True if parsing is successful |
| parseRSS($rssText) X-Ref |
| Parses the RSS text provided param: string The RSS text return: boolean True if parsing is successful |
| loadRSSData($url) X-Ref |
| Retrieves the RSS data from the url/cache file and parses param: string The url for the RSS data return: boolean True if parsing is successful |
| getDataFromCache($url) X-Ref |
| Retrieves the RSS data from the url/cache file param: string The url for the RSS data return: string The RSS data |
| parseRSSData($rssText) X-Ref |
| Parses the RSS data provided param: string The the RSS data return: boolean True if parsing is successful |
| fromFile($filename) X-Ref |
| Reads in RSS text from a file and parses it param: string The file path return: boolean True if parsing is successful |
| fromString($rssText) X-Ref |
| Reads in RSS text from a string and parses it param: string The RSS text return: boolean True if parsing is successful |
| establishConnection($url) X-Ref |
| Establishes a connection, given an url param: string The url of the data |
| getTextFromFile($filename) X-Ref |
| Get text from an url or file param: string The url or file path return: string The text contained in the url or file, or an empty string |
| getDocument() X-Ref |
| Gets a reference to the underlying DOM document return: Object A reference to the underlying DOM document |
| getNode() X-Ref |
| Gets a reference to the root DOM element return: Object A reference to the root DOM element |
| handleChannelElementsEmbedded() X-Ref |
| Forces channel elements that are external to a channel to be referenced as subelements of that channel |
| getRSSVersion() X-Ref |
| Returns the version of RSS used to format the data return: string The version of RSS used to format the data |
| getChannelCount() X-Ref |
| Returns the number of channels in the document return: int The number of channels in the document |
| getChannel($index) X-Ref |
| Returns a reference to the channel located at the specified index return: Object A reference to the channel located at the specified index |
Classe: xml_domit_rss_simpleelement - X-Ref
Represents a simple RSS element, without attributes and only a single child text node| xml_domit_rss_simpleelement(&$element) X-Ref |
| Constructor param: Object A DOM node containing element data |
| getElementText() X-Ref |
| Gets the text of the element return: string The element text |
Classe: xml_domit_rss_exception - X-Ref
A DOMIT! RSS exception handling class| raiseException($errorNum, $errorString) X-Ref |
| Raises the specified exception param: int The error number param: string A string explanation of the error |
| setErrorHandler($method) X-Ref |
| custom handler for DOM RSS errors param: object A reference to the custom error handler |
| setErrorMode($mode) X-Ref |
| Set error mode param: int The DOMIT RSS error mode |
| setErrorLog($doLogErrors, $logfile) X-Ref |
| Set error mode param: boolean True if errors should be logged param: string Absolute or relative path to log file |
| Généré le : Wed Nov 21 14:43:32 2007 | par Balluche grâce à PHPXref 0.7 |
|
|