Index of All Elements

Package Indexes

SAFOX

[ a ] [ c ] [ d ] [ e ] [ g ] [ h ] [ l ] [ o ] [ p ] [ r ] [ s ] [ t ] [ v ] [ w ] [ x ]

[Top]

a

addItem: in file safox_g_rss.cls.php, method RSSDoc::addItem()
The addItem method is used to add items to the channel.
addNode: in file safox_g.cls.php, method xmlDoc::addNode()
addNode Adds a Node to the Main part of the xmlDoc;
addNode: in file safox_g.cls.php, method xmlNode::addNode()
addNode - Adds a child node to the current Object (Node) and returns a reference to childNode
addNodeAfter: in file safox_g.cls.php, method xmlDoc::addNodeAfter()
Adds a new Node to the Document directly *after* a specified node, whereas addNode() method adds a node to the end of the Document
addNodeAfter: in file safox_g.cls.php, method xmlNode::addNodeAfter()
Adds a new Node to the Node directly *after* a specified ChildNode, whereas addNode() method adds a node to the end of the Node
addNodeBefore: in file safox_g.cls.php, method xmlDoc::addNodeBefore()
Adds a new Node to the Document directly *before* a specified node, whereas addNode() method adds a node to the end of the Document
addNodeBefore: in file safox_g.cls.php, method xmlNode::addNodeBefore()
Adds a new Node to the Node directly *before* a specified ChildNode, whereas addNode() method adds a node to the end of the Node

[Top]

c

cleanUp: in file safox_g.cls.php, method xmlDoc::cleanUp()
Cleans up internal data arrays from removed nodes and rebuilts the ID Referencing Array
cleanUp: in file safox_g.cls.php, method xmlNode::cleanUp()
Cleans up internal data arrays from removed nodes and rebuilts the ID Referencing Array
convertString2Entities: in file safox_g.cls.php, method xmlNode::convertString2Entities()
convertString2Entities - returns a string that represents a well formed xml-string to be used as CDATA based on setEntityConversion() converts the parameter into into HT/XML-Entities or encapsulates in <![CDATA[]]>
createRSSDoc: in file safox.cls.php, method SAFOX::createRSSDoc()
creates a RSSDoc (RSS 2.0) Generation object and returns a reference to this. automatically loads necessary files
createRSSParser: in file safox.cls.php, method SAFOX::createRSSParser()
creates a RSSParser (RSS 2.0) object and returns a reference to this. automatically loads necessary files
createXMLDoc: in file safox.cls.php, method SAFOX::createXMLDoc()
creates a XMLDoc Generation object and returns a reference to this. automatically loads necessary files
createXMLParser: in file safox.cls.php, method SAFOX::createXMLParser()
creates a XMLParser object and returns a reference to this. automatically loads necessary files

[Top]

d

delete: in file safox_g.cls.php, method xmlNode::delete()
Alias to destroy - Deletes a node and all childnodes, if the optional parameter clean is set true (default), a call to the cleanUp Method of the XMLDOC Object is made automatically.
destroy: in file safox_p.cls.php, method xmlParser::destroy()
Destructor
destroy: in file safox_g.cls.php, method xmlNode::destroy()
Deletes a node and all childnodes, if the optional parameter clean is set true (default), a call to the cleanUp Method of the XMLDOC Object is made automatically.
destroy: in file safox_g.cls.php, method xmlDoc::destroy()
Destructor- empties internal data

[Top]

e

$EntityConversion: in file safox_g.cls.php, variable xmlNode::$EntityConversion
EntityConversion - flag used to determine whether or not special characters in CDATA should be converted into HT/XML-Entities (e.g.
$EntityConversion: in file safox_g.cls.php, variable xmlDoc::$EntityConversion
Constructor

[Top]

g

getAllItems: in file safox_g_rss.cls.php, method RSSDoc::getAllItems()
getAllItems returns a reference to an array containing the references to all RSSItem Objects of the current document
getAttribute: in file safox_g.cls.php, method xmlNode::getAttribute()
getAttribute returns the value of an attribute
getAuthor: in file safox_g_rss.cls.php, method RSSItem::getAuthor()
method returns the value of the author tag of the Item
getCategory: in file safox_g_rss.cls.php, method RSSItem::getCategory()
method returns the value of the category tag of the Item
getCData: in file safox_g.cls.php, method xmlNode::getCData()
setCData - returns the CData content of a node
getChannelObject: in file safox_g_rss.cls.php, method RSSDoc::getChannelObject()
getChannelObject returns a refence to the Channel node of the RSS document
getChildNodeByTagName: in file safox_g.cls.php, method xmlNode::getChildNodeByTagName()
getChildNodeByTagName - returns a reference to specific ChildNode of current Node -- suggested by Cristiano
getChildNodeByTagName: in file safox_g.cls.php, method xmlDoc::getChildNodeByTagName()
getChildNodeByTagName - direct reference to xmlNode Object if only one tag found, array of xmlNode Object references if more found, or boolean false -- suggested by Cristiano
getChildNodeByType: in file safox_g.cls.php, method xmlNode::getChildNodeByType()
alias to getChildNodeByTagName - returns a reference to specific ChildNode of current Node -- suggested by Cristiano
getComments: in file safox_g_rss.cls.php, method RSSItem::getComments()
method returns the value of the comments tag of the Item
getDescription: in file safox_g_rss.cls.php, method RSSItem::getDescription()
method returns the value of the description tag of the Item
getError: in file safox_p.cls.php, method xmlParser::getError()
returns the last occured error or false when all errors have been returned
getErrors: in file safox_p.cls.php, method xmlParser::getErrors()
Returns Array of Errors occured or false
getFirstItem: in file safox_g_rss.cls.php, method RSSDoc::getFirstItem()
getFirstItem returns a reference to the first Item.
getId: in file safox_g.cls.php, method xmlNode::getId()
getId -- return the Unique ID attribute value
getId: in file safox_g.cls.php, method xmlDoc::getId()
return Id (Constant SAFOXDOC) This function returns the mixed returns the UIDA (Unique ID Attribute) Value of current node, for the XMLDOC returns SAFOXDOC (constant)
getLastItem: in file safox_g_rss.cls.php, method RSSDoc::getLastItem()
getLastItem returns a reference to the last Item.
getLink: in file safox_g_rss.cls.php, method RSSItem::getLink()
method returns the value of the link tag of the Item
getNextItem: in file safox_g_rss.cls.php, method RSSDoc::getNextItem()
getNextItem returns a reference to the current(first) (when not called before) or next Item.
getNextNode: in file safox_g.cls.php, method xmlNode::getNextNode()
getNextNode - returns a reference to the Next ChildNode of current Node
getNextNode: in file safox_g.cls.php, method xmlDoc::getNextNode()
Returns next Reference to Child Node or False;
getNodeById: in file safox_g.cls.php, method xmlDoc::getNodeById()
Return a xmlNodeObject or False
getParent: in file safox_g.cls.php, method xmlNode::getParent()
getParent - Returns a reference to the Parent NodeObject or null
getPrevItem: in file safox_g_rss.cls.php, method RSSDoc::getPrevItem()
getPrevItem returns a reference to previous Item.
getPubDate: in file safox_g_rss.cls.php, method RSSItem::getPubDate()
method returns the value of the pubDate tag of the Item
getRSSDoc: in file safox_p_rss.cls.php, method RSSParser::getRSSDoc()
getRSSDoc returns a reference to the parsed RSS Document object
getSource: in file safox_g_rss.cls.php, method RSSItem::getSource()
method returns the value of the source tag of the Item
getTitle: in file safox_g_rss.cls.php, method RSSItem::getTitle()
method returns the value of the title tag of the Item
getType: in file safox_g.cls.php, method xmlNode::getType()
getType returns the type/TagName of a xml node
getVersion: in file safox.cls.php, method SAFOX::getVersion()
returns the current version of the SAFOX API
getXmlDoc: in file safox_p.cls.php, method xmlParser::getXmlDoc()
return the XMLDOC Object if succesfully parsed otherwise false

[Top]

h

hasChildren: in file safox_g.cls.php, method xmlNode::hasChildren()
hasChildren - Returns true if childNodes exist or false
hasParent: in file safox_g.cls.php, method xmlNode::hasParent()
hasParent - Returns true if a reference to a parent node exists

[Top]

l

loadFile: in file safox_p_rss.cls.php, method RSSParser::loadFile()
loadFile return true if remote/local rss-file has been loaded (was found)
loadFile: in file safox_p.cls.php, method xmlParser::loadFile()
Load a String to be parsed from a xml Document File

[Top]

o

onParseCDATA: in file safox_p.cls.php, function onParseCDATA()
OnParseCDATA - is registered in Class XMLPARSER as a PreProcessing EventHandler for CDATA-Strings called when the XPE_ON_PARSE_CDT event is fired

[Top]

p

parse: in file safox_p_rss.cls.php, method RSSParser::parse()
parse method alias to parseRSS which makes necessary calls to the SAFOX Parser and returns boolean success message
parse: in file safox_p.cls.php, method xmlParser::parse()
Parse the String and create an xmlDoc Object
parseRSS: in file safox_p_rss.cls.php, method RSSParser::parseRSS()
parseRSS makes necessary calls to the SAFOX Parser and returns boolean success message
printRSS: in file safox_g_rss.cls.php, method RSSDoc::printRSS()
prints RSS Documents to output

[Top]

r

$rssDoc: in file safox_g_rss.cls.php, variable RSSItem::$rssDoc
registerEvent: in file safox_p.cls.php, method xmlParser::registerEvent()
registerEvent - registers a functionname to be exucted when event is fired
remove: in file safox_g.cls.php, method xmlNode::remove()
Alias to destroy - Deletes a node and all childnodes, if the optional parameter clean is set true (default), a call to the cleanUp Method of the XMLDOC Object is made automatically.
RSSDoc: in file safox_g_rss.cls.php, class RSSDoc
class RSSDoc
RSSDoc: in file safox_g_rss.cls.php, method RSSDoc::RSSDoc()
RSSDOC constructor
RSSItem: in file safox_g_rss.cls.php, method RSSItem::RSSItem()
constructor of the RSSItem Class
RSSItem: in file safox_g_rss.cls.php, class RSSItem
RSSItem is class representing the item nodes of an RSS channel
RSSParser: in file safox_p_rss.cls.php, method RSSParser::RSSParser()
RSS Parser Constructor
RSSParser: in file safox_p_rss.cls.php, class RSSParser
class RSSParser

[Top]

s

$self: in file safox_g_rss.cls.php, variable RSSItem::$self
SAFOX: in file safox.cls.php, class SAFOX
SAFOX a wrapper class for the SAFOX API
SAFOX: in file safox.cls.php, method SAFOX::SAFOX()
SAFOX constructor
SAFOXDOC: in file safox_g.cls.php, constant SAFOXDOC
SAFOXVERSION: in file safox.cls.php, constant SAFOXVERSION
SAFOXVERSIONRSS: in file safox_g_rss.cls.php, constant SAFOXVERSIONRSS
safox.cls.php: procedural page safox.cls.php
SAFOX_G: in file safox_g.cls.php, constant SAFOX_G
safox_g.cls.php: procedural page safox_g.cls.php
SAFOX_G_RSS: in file safox_g_rss.cls.php, constant SAFOX_G_RSS
safox_g_rss.cls.php: procedural page safox_g_rss.cls.php
SAFOX_P: in file safox_p.cls.php, constant SAFOX_P
Event identifiers & constants
safox_p.cls.php: procedural page safox_p.cls.php
SAFOX_P_RSS: in file safox_p_rss.cls.php, constant SAFOX_P_RSS
safox_p_rss.cls.php: procedural page safox_p_rss.cls.php
setAttribute: in file safox_g.cls.php, method xmlNode::setAttribute()
setAttribute sets an Attribute
setAuthor: in file safox_g_rss.cls.php, method RSSItem::setAuthor()
method sets/changes the optional author tag of the Item
setCategory: in file safox_g_rss.cls.php, method RSSItem::setCategory()
method sets/changes the optional category tag of the Item
setCData: in file safox_g.cls.php, method xmlNode::setCData()
setCData - sets the CData content of a node
setChannelCategory: in file safox_g_rss.cls.php, method RSSDoc::setChannelCategory()
This method allows to set/change the value of the category tag (subelement to channel)
setChannelCopyright: in file safox_g_rss.cls.php, method RSSDoc::setChannelCopyright()
This method allows to set/change the value of the copyright tag (subelement to channel)
setChannelData: in file safox_g_rss.cls.php, method RSSDoc::setChannelData()
setChannelData used to set optional/required sub elements of the channel tag.
setChannelDescription: in file safox_g_rss.cls.php, method RSSDoc::setChannelDescription()
This method allows to set/change the value of the Description tag (subelement to channel)
setChannelDocs: in file safox_g_rss.cls.php, method RSSDoc::setChannelDocs()
This method allows to set/change the value of the docs tag (subelement to channel)
setChannelGenerator: in file safox_g_rss.cls.php, method RSSDoc::setChannelGenerator()
This method allows to set/change the value of the generator tag (subelement to channel)
setChannelImage: in file safox_g_rss.cls.php, method RSSDoc::setChannelImage()
This method allows to set/change the values of the optional channel image tag (subelement to channel)
setChannelLanguage: in file safox_g_rss.cls.php, method RSSDoc::setChannelLanguage()
This method allows to set/change the value of the Language tag (subelement to channel)
setChannelLastBuildDate: in file safox_g_rss.cls.php, method RSSDoc::setChannelLastBuildDate()
This method allows to set/change the value of the lastbuilddate tag (subelement to channel)
setChannelLink: in file safox_g_rss.cls.php, method RSSDoc::setChannelLink()
This method allows to set/change the value of the Link tag (subelement to channel)
setChannelManagingEditor: in file safox_g_rss.cls.php, method RSSDoc::setChannelManagingEditor()
This method allows to set/change the value of the managingEditor tag (subelement to channel)
setChannelPubDate: in file safox_g_rss.cls.php, method RSSDoc::setChannelPubDate()
This method allows to set/change the value of the pubDate tag (subelement to channel)
setChannelRating: in file safox_g_rss.cls.php, method RSSDoc::setChannelRating()
This method allows to set/change the value of the rating tag (subelement to channel)
setChannelTitle: in file safox_g_rss.cls.php, method RSSDoc::setChannelTitle()
setChannelTitle allows to set/change the value of the title tag (subelement to channel)
setChannelTTL: in file safox_g_rss.cls.php, method RSSDoc::setChannelTTL()
This method allows to set/change the value of the ttl tag (subelement to channel)
setChannelWebMaster: in file safox_g_rss.cls.php, method RSSDoc::setChannelWebMaster()
This method allows to set/change the value of the webMaster tag (subelement to channel)
setComments: in file safox_g_rss.cls.php, method RSSItem::setComments()
method sets/changes the optional comments tag of the Item
setDescription: in file safox_g_rss.cls.php, method RSSItem::setDescription()
method sets/changes the description tag of the Item
setEnclosure: in file safox_g_rss.cls.php, method RSSItem::setEnclosure()
method sets/changes the optional enclosure tag of the Item
setEncoding: in file safox_g.cls.php, method xmlDoc::setEncoding()
Set the XML-Document Encoding Attribute
setEntityConversion: in file safox_g.cls.php, method xmlDoc::setEntityConversion()
setEntityConversion is a function that specifies whether or not special characters in CDATA should be converted into HT/XML-Entities (e.g.
setEntityConversion: in file safox_g.cls.php, method xmlNode::setEntityConversion()
setEntityConversion is a function that specifies whether or not special characters in CDATA should be converted into HT/XML-Entities (e.g.
setGuid: in file safox_g_rss.cls.php, method RSSItem::setGuid()
method sets/changes the optional guid tag of the Item
setId: in file safox_g.cls.php, method xmlNode::setId()
setId sets the Unique ID Attribute defined by xmlDoc->setUida or "ID"
setLink: in file safox_g_rss.cls.php, method RSSItem::setLink()
method sets/changes the link tag of the Item
setParent: in file safox_g.cls.php, method xmlNode::setParent()
setParent - Sets the ParentNode (usually used internally or if moved)
setPubDate: in file safox_g_rss.cls.php, method RSSItem::setPubDate()
method sets/changes the optional PubDate tag of the Item
setSource: in file safox_g_rss.cls.php, method RSSItem::setSource()
method sets/changes the optional source tag of the Item
setStandAlone: in file safox_g.cls.php, method xmlDoc::setStandAlone()
Sets the XML Document StandAlone Attribute
setString: in file safox_p_rss.cls.php, method RSSParser::setString()
setString may be used to set a rss-file manually without loading a file.
setString: in file safox_p.cls.php, method xmlParser::setString()
Set String to be parsed
setTitle: in file safox_g_rss.cls.php, method RSSItem::setTitle()
method sets/changes the title tag of the Item
setType: in file safox_g.cls.php, method xmlNode::setType()
setType Sets the type of a xml node/tag
setUida: in file safox_g.cls.php, method xmlDoc::setUida()
Set the "Unique ID Attribute"-name (usually ID)
setUida: in file safox_p.cls.php, method xmlParser::setUida()
setUida - sets the "unique ID Attribute"-name
setVersion: in file safox_g.cls.php, method xmlDoc::setVersion()
Sets the XML-Document Version-Attribute

[Top]

t

takeOverXML: in file safox_g_rss.cls.php, method RSSDoc::takeOverXML()
The takeOver XML is semi-public.

[Top]

v

ver: in file safox.cls.php, method SAFOX::ver()
alias to getVersion() - returns the current version of the SAFOX API

[Top]

w

writeRSS: in file safox_g_rss.cls.php, method RSSDoc::writeRSS()
method returns the xml string of the RSS Document
writeToFile: in file safox_g.cls.php, method xmlDoc::writeToFile()
Writing an XML Document to File
writeToFile: in file safox_g_rss.cls.php, method RSSDoc::writeToFile()
Writes the xml string of the RSS Document to a file
writeXML: in file safox_g.cls.php, method xmlNode::writeXML()
returns a string containing the wellformed xml of current Node/tag
writeXML: in file safox_g.cls.php, method xmlDoc::writeXML()
returns a string of the XML Document

[Top]

x

xmlDoc: in file safox_g.cls.php, class xmlDoc
class xmlDoc
xmlDoc: in file safox_g.cls.php, method xmlDoc::xmlDoc()
xmlNode: in file safox_g.cls.php, method xmlNode::xmlNode()
Constructor
xmlNode: in file safox_g.cls.php, class xmlNode
class xmlNode
xmlParser: in file safox_p.cls.php, method xmlParser::xmlParser()
Constructor
xmlParser: in file safox_p.cls.php, class xmlParser
class xmlParser
XML_MAX_LINE_SIZE: in file safox_p.cls.php, constant XML_MAX_LINE_SIZE
XPE_ON_PARSE_ATT: in file safox_p.cls.php, constant XPE_ON_PARSE_ATT
XPE_ON_PARSE_CDT: in file safox_p.cls.php, constant XPE_ON_PARSE_CDT
XPE_ON_PARSE_CMT: in file safox_p.cls.php, constant XPE_ON_PARSE_CMT
XPE_ON_PARSE_DEF: in file safox_p.cls.php, constant XPE_ON_PARSE_DEF
XPE_ON_PARSE_DTD: in file safox_p.cls.php, constant XPE_ON_PARSE_DTD
XPE_ON_PARSE_NOD: in file safox_p.cls.php, constant XPE_ON_PARSE_NOD
XPE_ON_PARSE_TAG: in file safox_p.cls.php, constant XPE_ON_PARSE_TAG
XPE_ON_PARSE_XSP: in file safox_p.cls.php, constant XPE_ON_PARSE_XSP

Documentation generated on Thu, 9 Feb 2006 13:55:06 +0100 by phpDocumentor 1.3.0RC3

	SAFOX

[ class tree: SAFOX ] [ index: SAFOX ] [ all elements ]