Class xml_domit_rss_base

Description

The base class of all DOMIT! RSS objects

Located in /includes/domit/xml_domit_rss_shared.php (line 49)


	
			
Direct descendents
Class Description
xml_domit_rss_elementindexer Provides indexing functionality to RSS classes
Variable Summary
Object $node
Method Summary
string getAttribute (string $attr)
Object getNode ()
boolean hasAttribute (string $attr)
boolean isRSSDefined (string $elementName)
boolean isSimpleRSSElement (string $elementName)
string toNormalizedString ([boolean $htmlSafe = false], [boolean $subEntities = false])
string toString ([boolean $htmlSafe = false], [boolean $subEntities = false])
Variables
Object $node = null (line 51)
  • var: The underlying DOMIT! node of the element
array $rssDefinedElements = array() (line 53)
  • var: A list of valid RSS defined child elements
Methods
getAttribute (line 68)

Retrieves the text of the named attribute, checking first if the attribute exists

  • return: The attribute value, or an empty string
string getAttribute (string $attr)
  • string $attr: The attribute name
getNode (line 59)

Retrieves the underlying DOMIT node

  • return: The underlying DOMIT node
Object getNode ()

Redefined in descendants as:
hasAttribute (line 81)

Checks whether the named attribute exists

  • return: True if the attribute exists
boolean hasAttribute (string $attr)
  • string $attr: The attribute name
isRSSDefined (line 90)

Tests whether the named element is predefined by the RSS spec

  • return: True if the element is predefined by the RSS spec
boolean isRSSDefined (string $elementName)
  • string $elementName: The element name
isSimpleRSSElement (line 108)

Tests whether the named element has a single child text node

  • return: True if the named element has a single child text node
boolean isSimpleRSSElement (string $elementName)
  • string $elementName: The element name
toNormalizedString (line 135)

Generates a normalized (formatted for readability) representation of the node and its children

  • return: The formatted string representation
string toNormalizedString ([boolean $htmlSafe = false], [boolean $subEntities = false])
  • boolean $htmlSafe: True if HTML readable output is desired
  • boolean $subEntities: True if illegal xml characters in text nodes and attributes should be converted to entities
toString (line 125)

Generates a string representation of the node and its children

  • return: The string representation
string toString ([boolean $htmlSafe = false], [boolean $subEntities = false])
  • boolean $htmlSafe: True if HTML readable output is desired
  • boolean $subEntities: True if illegal xml characters in text nodes and attributes should be converted to entities

Documentation generated on Fri, 4 Mar 2005 13:57:57 +1000 by phpDocumentor 1.3.0RC3