Graphe d'héritage de DOMIT_Document:

Graphe de collaboration de DOMIT_Document:

Fonctions membres publiques

DOMIT_Document ()
resolveErrors ($truthVal)
setNamespaceAwareness ($truthVal)
preserveWhitespace ($truthVal)
setConnection ($host, $path= '/', $port=80, $timeout=0, $user=null, $password=null)
setAuthorization ($user, $password)
setProxyConnection ($host, $path= '/', $port=80, $timeout=0, $user=null, $password=null)
setProxyAuthorization ($user, $password)
useHTTPClient ($truthVal)
getErrorCode ()
getErrorString ()
expandEmptyElementTags ($truthVal, $expandEmptyElementExceptions=false)
& setDocumentElement (&$node)
& importNode (&$importedNode, $deep=true)
& _importNode (&$parentNode, &$sourceNode, $deep)
& appendChild (&$node)
& replaceChild (&$newChild, &$oldChild)
& insertBefore (&$newChild, &$refChild)
& removeChild (&$oldChild)
& createDocumentFragment ()
& createAttribute ($name)
& createAttributeNS ($namespaceURI, $qualifiedName)
& createElement ($tagName)
& createElementNS ($namespaceURI, $qualifiedName)
& createTextNode ($data)
& createCDATASection ($data)
& createComment ($text)
& createProcessingInstruction ($target, $data)
& getElementsByTagName ($tagName)
& getElementsByTagNameNS ($namespaceURI, $localName)
& getElementByID ($elementID, $isStrict=true)
& getElementsByPath ($pattern, $nodeIndex=0)
& getElementsByAttributePath ($pattern, $nodeIndex=0)
& getNodesByNodeType ($type, &$contextNode)
& getNodesByNodeValue ($value, &$contextNode)
parseXML ($xmlText, $useSAXY=true, $preserveCDATA=true, $fireLoadEvent=false)
loadXML ($filename, $useSAXY=true, $preserveCDATA=true, $fireLoadEvent=false)
establishConnection ($url)
getTextFromFile ($filename)
saveXML ($filename, $normalized=false)
saveTextToFile ($filename, $text)
parsedBy ()
getText ()
getDocType ()
getXMLDeclaration ()
& getDOMImplementation ()
load (&$contextNode)
getVersion ()
appendEntityTranslationTable ($table)
toArray ()
& cloneNode ($deep=false)
toString ($htmlSafe=false, $subEntities=false)

Attributs publics

Documentation des fonctions membres

& DOMIT_Document::_importNode	(	&$	parentNode,
		&$	sourceNode,
		$	deep
	)

Imports a node (and optionally its children) from another DOM Document

Paramètres:

object	A reference to the parent of the node to be imported
object	A reference to the node to be imported
boolean	True if the children of the imported node are also to be imported

Renvoie:: object The imported node if it is the top level node, otherwise null

Références $i, $total, createAttribute(), createAttributeNS(), createCDATASection(), createComment(), createDocumentFragment(), createElement(), createElementNS(), createProcessingInstruction(), createTextNode(), et DOMIT_DOMException::raiseException().

Référencé par importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::appendChild ( &$ node )

Appends a node to the childNodes list of the current node

Paramètres:

Object The node to be appended

Renvoie:: Object The appended node

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

Références $i, $total, DOMIT_DOMException::raiseException(), et setDocumentElement().

Référencé par setDocumentElement().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::appendEntityTranslationTable ( $ table )

Appends an array of entity mappings to the existing translation table

Intended mainly to facilitate the conversion of non-ASCII entities into equivalent characters

Paramètres:

array A list of entity mappings in the format: array('&' => '&');

& DOMIT_Document::cloneNode ( $ deep = false )

Copies a node and/or its children

Paramètres:

boolean True if all child nodes are also to be cloned

Renvoie:: Object A copy of the node and/or its children

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

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

& DOMIT_Document::createAttribute ( $ name )

Creates a new DOMIT_Attr node

Paramètres:

string The name of the attribute

Renvoie:: Object The new attribute node

Références $name.

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createAttributeNS	(	$	namespaceURI,
		$	qualifiedName
	)

Creates a new DOMIT_Attr node (namespace aware)

Paramètres:

string	The namespaceURI of the attribute
string	The qualifiedName of the attribute

Renvoie:: Object The new attribute node

Références DOMIT_Node::$namespaceURI.

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createCDATASection ( $ data )

Creates a new DOMIT_CDataSection node

Paramètres:

string The text of the CDATASection

Renvoie:: Object The new CDATASection node

Références $data.

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createComment ( $ text )

Creates a new DOMIT_Comment node

Paramètres:

string The comment text

Renvoie:: Object The new comment node

Références $text.

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createDocumentFragment ( )

Creates a new DOMIT_DocumentFragment node

Renvoie:: Object The new document fragment node

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createElement ( $ tagName )

Creates a new DOMIT_Element node

Paramètres:

string The tag name of the element

Renvoie:: Object The new element

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createElementNS	(	$	namespaceURI,
		$	qualifiedName
	)

Creates a new DOMIT_Element node (namespace aware)

Paramètres:

string	The namespaceURI of the element
string	The qualifiedName of the element

Renvoie:: Object The new element

Références DOMIT_Node::$namespaceURI.

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createProcessingInstruction	(	$	target,
		$	data
	)

Creates a new DOMIT_ProcessingInstruction node

Paramètres:

string	The target of the processing instruction
string	The data of the processing instruction

Renvoie:: Object The new processing instruction node

Références $data, et $target.

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::createTextNode ( $ data )

Creates a new DOMIT_Text node

Paramètres:

string The text of the node

Renvoie:: Object The new text node

Références $data.

Référencé par _importNode().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::DOMIT_Document ( )

DOM Document constructor

Références DOMIT_Node::_constructor().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::establishConnection ( $ url )

Establishes a connection, given an url

Paramètres:

string The 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 :

DOMIT_Document::expandEmptyElementTags	(	$	truthVal,
		$	expandEmptyElementExceptions = `false`
	)

Specifies whether elements tags will be rendered to string as <element></element> rather than <element>

Paramètres:

boolean	True if the expanded form is to be used
mixed	An array of tag names that should be excepted from expandEmptyElements rule (optional)

Références $expandEmptyElementExceptions.

DOMIT_Document::getDocType ( )

Returns a doctype object

Renvoie:: mixed The doctype object, or null if none exists

& DOMIT_Document::getDOMImplementation ( )

Returns a reference to the DOMIT_DOMImplementation object

Renvoie:: Object A reference to the DOMIT_DOMImplementation object

& DOMIT_Document::getElementByID	(	$	elementID,
		$	isStrict = `true`
	)

Returns the element whose ID is given by elementId.

Paramètres:

string	The id of the matching element
boolean	True if XML spec is to be strictly adhered to (only attributes xml:id are considered valid)

Renvoie:: Object The found element or null

Références DOMIT_DOMException::raiseException().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::getElementsByAttributePath	(	$	pattern,
		$	nodeIndex = `0`
	)

Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like attribute expression (NOT YET IMPLEMENTED!)

Paramètres:

string	The query pattern
int	If a single node is to be returned (rather than the entire NodeList) the index of that node

Renvoie:: mixed A NodeList or single node that matches the pattern

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

& DOMIT_Document::getElementsByPath	(	$	pattern,
		$	nodeIndex = `0`
	)

Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like expression.

Paramètres:

string	The query pattern
int	If a single node is to be returned (rather than the entire NodeList) the index of that node

Renvoie:: mixed A NodeList or single node that matches the pattern

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

& DOMIT_Document::getElementsByTagName ( $ tagName )

Retrieves a NodeList of child elements with the specified tag name

Paramètres:

string The matching element tag name

Renvoie:: Object A NodeList of found elements

& DOMIT_Document::getElementsByTagNameNS	(	$	namespaceURI,
		$	localName
	)

Retrieves a NodeList of child elements with the specified namespaceURI and localName

Paramètres:

string	The matching namespaceURI
string	The matching localName

Renvoie:: Object A NodeList of found elements

Références DOMIT_Node::$localName, et DOMIT_Node::$namespaceURI.

DOMIT_Document::getErrorCode ( )

Returns the error code from the underlying SAX parser

Renvoie:: int The error code

DOMIT_Document::getErrorString ( )

Returns the error string from the underlying SAX parser

Renvoie:: string The error string

& DOMIT_Document::getNodesByNodeType	(	$	type,
		&$	contextNode
	)

Retrieves all child nodes of the specified nodeType

Paramètres:

string	The nodeType of matching nodes
Object	The root node of the search

Renvoie:: Object A NodeList containing found nodes

Références $type.

& DOMIT_Document::getNodesByNodeValue	(	$	value,
		&$	contextNode
	)

Retrieves all child nodes of the specified nodeValue

Paramètres:

string	The nodeValue of matching nodes
Object	The root node of the search

Renvoie:: Object A NodeList containing found nodes

DOMIT_Document::getText ( )

Returns the concatented text of the current node and its children

Renvoie:: string The concatented text of the current node and its children

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

DOMIT_Document::getTextFromFile ( $ filename )

Retrieves text from a file

Paramètres:

string The file path

Renvoie:: string The text contained in the file

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

Référencé par loadXML().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::getVersion ( )

Returns the current version of DOMIT!

Renvoie:: Object The current version of DOMIT!

DOMIT_Document::getXMLDeclaration ( )

Returns the xml declaration processing instruction

Renvoie:: mixed The xml declaration processing instruction, or null if none exists

& DOMIT_Document::importNode	(	&$	importedNode,
		$	deep = `true`
	)

Imports a node (and optionally its children) from another DOM Document

Paramètres:

object	A reference to the node to be imported
boolean	True if the children of the imported node are also to be imported

Renvoie:: object The imported node (and, if specified, its children)

Références DOMIT_Node::$parentNode, et _importNode().

Voici le graphe d'appel pour cette fonction :

& DOMIT_Document::insertBefore	(	&$	newChild,
		&$	refChild
	)

Inserts a node to the childNodes list of the current node

Paramètres:

Object	The node to be inserted
Object	The node before which the insertion is to occur

Renvoie:: Object The inserted node

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

Références $i, $total, $type, DOMIT_DOMException::raiseException(), et setDocumentElement().

Référencé par replaceChild().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::load ( &$ contextNode )

Manages the firing of the onLoad() event

Paramètres:

Object The parent node of the current recursion

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

Référencé par parseXML().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::loadXML	(	$	filename,
		$	useSAXY = `true`,
		$	preserveCDATA = `true`,
		$	fireLoadEvent = `false`
	)

Parses an xml file

Paramètres:

string	The xml file to be parsed
boolean	True if SAXY is to be used instead of Expat
boolean	False if CDATA Section are to be generated as Text nodes
boolean	True if onLoad is to be called on each node after parsing

Renvoie:: boolean True if parsing is successful

Références $filename, getTextFromFile(), et parseXML().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::parsedBy ( )

Indicates the SAX parser used to parse the current document

Renvoie:: string Either "SAXY" or "EXPAT"

DOMIT_Document::parseXML	(	$	xmlText,
		$	useSAXY = `true`,
		$	preserveCDATA = `true`,
		$	fireLoadEvent = `false`
	)

Parses an xml string

Paramètres:

string	The xml text to be parsed
boolean	True if SAXY is to be used instead of Expat
boolean	False if CDATA Section are to be generated as Text nodes
boolean	True if onLoad is to be called on each node after parsing

Renvoie:: boolean True if parsing is successful

Références load(), et DOMIT_Utilities::validateXML().

Référencé par loadXML().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::preserveWhitespace ( $ truthVal )

Specifies whether DOMIT! preserves whitespace when parsing

Paramètres:

boolean True if whitespace is to be preserved

& DOMIT_Document::removeChild ( &$ oldChild )

Removes a node from the childNodes list of the current node

Paramètres:

Object The node to be removed

Renvoie:: Object The removed node

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

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

& DOMIT_Document::replaceChild	(	&$	newChild,
		&$	oldChild
	)

Replaces a node with another

Paramètres:

Object	The new node
Object	The old node

Renvoie:: Object The new node

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

Références $i, $total, insertBefore(), DOMIT_DOMException::raiseException(), et setDocumentElement().

Référencé par setDocumentElement().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::resolveErrors ( $ truthVal )

Specifies whether DOMIT! will try to fix invalid XML before parsing begins

Paramètres:

boolean True if errors are to be resolved

DOMIT_Document::saveTextToFile	(	$	filename,
		$	text
	)

Saves text to a file

Paramètres:

string	The file path
string	The text to be saved

Renvoie:: boolean True if the save is successful

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

Référencé par saveXML().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::saveXML	(	$	filename,
		$	normalized = `false`
	)

Saves the current DOM document as an xml file

Paramètres:

string	The path of the xml file
boolean	True if xml text is to be normalized before saving

Renvoie:: boolean True if save is successful

Références $filename, saveTextToFile(), DOMIT_Node::toNormalizedString(), et toString().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::setAuthorization	(	$	user,
		$	password
	)

Specifies basic authentication for an http connection

Paramètres:

string	The user name
string	The password

Références $user.

DOMIT_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:

string	The ip address or domain name of the connection
string	The path of the connection
int	The port that the connection is listening on
int	The timeout value for the connection
string	The user name, if authentication is required
string	The 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 :

& DOMIT_Document::setDocumentElement ( &$ node )

Set the specified node as document element

Paramètres:

Object The node that is to become document element

Renvoie:: Object The new document element

Références appendChild(), DOMIT_DOMException::raiseException(), et replaceChild().

Référencé par appendChild(), insertBefore(), et replaceChild().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::setNamespaceAwareness ( $ truthVal )

Specifies whether DOMIT! processes namespace information

Paramètres:

boolean True if namespaces are to be processed

DOMIT_Document::setProxyAuthorization	(	$	user,
		$	password
	)

Specifies basic authentication for the proxy

Paramètres:

string	The user name
string	The password

Références $user.

DOMIT_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:

string	The ip address or domain name of the proxy
string	The path to the proxy
int	The port that the proxy is listening on
int	The timeout value for the connection
string	The user name, if authentication is required
string	The password, if authentication is required

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

DOMIT_Document::toArray ( )

Generates an array representation of the node and its children

Renvoie:: Array A representation of the node and its children

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

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

DOMIT_Document::toString	(	$	htmlSafe = `false`,
		$	subEntities = `false`
	)

Generates a string representation of the node and its children

Paramètres:

boolean	True if HTML readable output is desired
boolean	True if illegal xml characters in text nodes and attributes should be converted to entities

Renvoie:: string The string representation

Références $i, $total, et DOMIT_Node::forHTML().

Référencé par saveXML().

Voici le graphe d'appel pour cette fonction :

DOMIT_Document::useHTTPClient ( $ truthVal )

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

Paramètres:

boolean True if an HTTP client is to be used to establish the connection

Documentation des données membres

DOMIT_Document::$definedEntities = array()

DOMIT_Document::$doctype

DOMIT_Document::$documentElement

DOMIT_Document::$doExpandEmptyElementTags = false

DOMIT_Document::$doResolveErrors = false

DOMIT_Document::$doUseHTTPClient = false

DOMIT_Document::$errorCode = 0

DOMIT_Document::$errorString = ''

DOMIT_Document::$expandEmptyElementExceptions = array()

Référencé par expandEmptyElementTags().

DOMIT_Document::$httpConnection = null

DOMIT_Document::$implementation

DOMIT_Document::$isModified

DOMIT_Document::$isNamespaceAware = false

DOMIT_Document::$namespaceURIMap = array()

DOMIT_Document::$parser

DOMIT_Document::$preserveWhitespace = false

DOMIT_Document::$xmlDeclaration

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

xml_domit_parser.php

Référence de la classe DOMIT_Document

Fonctions membres publiques

Attributs publics

Documentation des fonctions membres

Documentation des données membres