[ class tree: ] [ index: ] [ all elements ]
Packages:
XML_XPath

Index of all elements

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ p ] [ q ] [ r ] [ s ] [ t ] [ x ]

a

appendChild
in file common.php, method XML_XPath_common::appendChild()
    Adds the node or document fragment to the end of the list of children. If the node is already in the tree it is first removed (not sure if this works yet)
appendData
in file common.php, method XML_XPath_common::appendData()
    Will append data to end of text node.
top

b

$bookmark
in file common.php, variable XML_XPath_common::$bookmark
    domxml node bookmark used for holding a place in the xml document
top

c

$ctx
in file result.php, variable XML_XPath_result::$ctx
    xpath context object for the current domxml object
$ctx
in file XPath.php, variable XML_XPath::$ctx
childNodes
in file common.php, method XML_XPath_common::childNodes()
    Retrieves the child nodes from the element node as an XML_XPath_result object
cloneNode
in file common.php, method XML_XPath_common::cloneNode()
    Clones the node and return the node as a result object
current
in file result.php, method XML_XPath_result::current()
    Retrieve current pointer
common.php
procedural page common.php
top

d

$data
in file result.php, variable XML_XPath_result::$data
    either array of nodesets, string, boolean or number from xpath/DOM query
deleteData
in file common.php, method XML_XPath_common::deleteData()
    Will delete data at offset and for count for a text node.
documentElement
in file common.php, method XML_XPath_common::documentElement()
    Move to the document element
dumpChildren
in file common.php, method XML_XPath_common::dumpChildren()
    Returns all the contents of an element node, regardless of type, as is.
top

e

$error
in file XPath.php, variable XML_XPath::$error
$error_message_prefix
in file error.php, variable XML_XPath_Error::$error_message_prefix
    Message in front of the error message
end
in file result.php, method XML_XPath_result::end()
    Move to last result node, if this is an XPATH_NODESET
errorMessage
in file XPath.php, method XML_XPath::errorMessage()
    Return a textual error message for an XML_XPath error code.
evaluate
in file common.php, method XML_XPath_common::evaluate()
    Evaluate the xpath expression on the loaded xml document.
error.php
procedural page error.php
top

f

firstChild
in file common.php, method XML_XPath_common::firstChild()
    Moves the pointer to the first child of this node or returns the first node.
free
in file XPath.php, method XML_XPath::free()
    Kill the class object to free memory. Not really sure how necessary this is, but xml documents can be pretty big. This will kill everything, so only use it when you are done
free
in file result.php, method XML_XPath_result::free()
    Free the result object in order to save memory.
top

g

getAttribute
in file common.php, method XML_XPath_common::getAttribute()
    Retrieves an attribute value by name from the element node at the current pointer.
getAttributes
in file common.php, method XML_XPath_common::getAttributes()
    Return an associative array of attribute names as the keys and attribute values as the values. This is not a DOM function, but is a convenient addition.
getData
in file result.php, method XML_XPath_result::getData()
    Return the data from the xpath query. This function will be used mostly for xpath queries that result in scalar results, but in the case of nodesets, returns size
getElementsByTagName
in file common.php, method XML_XPath_common::getElementsByTagName()
    Create an XML_XPath_result object with the elements with the specified tagname
getIndex
in file result.php, method XML_XPath_result::getIndex()
    Return the index of the result nodeset.
getNodePath
in file common.php, method XML_XPath_common::getNodePath()
    Resolve the xpath location of the current node
getOne
in file common.php, method XML_XPath_common::getOne()
    A quick version of the evaluate, where the results are returned immediately. This function is equivalent to xsl:value-of select in every way.
getPointer
in file common.php, method XML_XPath_common::getPointer()
    Get the current pointer in the xml document.
top

h

hasAttribute
in file common.php, method XML_XPath_common::hasAttribute()
    Returns true when an attribute with a given name is specified on this element false otherwise.
hasAttributes
in file common.php, method XML_XPath_common::hasAttributes()
    Returns whether this node has any attributes.
hasChildNodes
in file common.php, method XML_XPath_common::hasChildNodes()
    Returns whether this node has any children.
top

i

$isRewound
in file result.php, variable XML_XPath_result::$isRewound
    determines if we have counted the first node of the result nodeset
insertBefore
in file common.php, method XML_XPath_common::insertBefore()
    Inserts the node before the current pointer.
insertData
in file common.php, method XML_XPath_common::insertData()
    Will insert data at offset for a text node.
isError
in file XPath.php, method XML_XPath::isError()
    Tell whether a result code from a XML_XPath method is an error.
is_a_php_class
in file common.php, function is_a_php_class()
    is_a is only defined in php for user functions, so I implemented its functionality for php objects until they fix (or never fix) this problem
top

l

$loaded
in file XPath.php, variable XML_XPath::$loaded
lastChild
in file common.php, method XML_XPath_common::lastChild()
    Moves the pointer to the last child of this node or returns the last child.
load
in file XPath.php, method XML_XPath::load()
    Load the xml document on which we will execute queries and modifications. This xml document can be loaded from a previously existing xmldom object, a string or a file.
top

m

microtime_float
in file XML_XPath_example.php, function microtime_float()
top

n

next
in file result.php, method XML_XPath_result::next()
    Move to the next node in the nodeset of results. This can be used inside of a while loop, so that it is possible to step through the nodes one by one.
nextByNodeName
in file result.php, method XML_XPath_result::nextByNodeName()
    Move to the next node in the nodeset of results where the node has the name provided.
nextByNodeType
in file result.php, method XML_XPath_result::nextByNodeType()
    Move to the next node in the nodeset of results where the node has the type provided.
nextSibling
in file common.php, method XML_XPath_common::nextSibling()
    Moves the internal pointer to the next sibling of the current node, or returns the pointer.
nodeName
in file common.php, method XML_XPath_common::nodeName()
    Return the name of this node, depending on its type, according to the DOM recommendation
nodeType
in file common.php, method XML_XPath_common::nodeType()
    Returns the integer value constant corresponding to the DOM node type
numResults
in file result.php, method XML_XPath_result::numResults()
    Return the number of nodes if the result is a nodeset or 1 for scalar results.
top

p

$pointer
in file common.php, variable XML_XPath_common::$pointer
    domxml node of the current location in the xml document
$pointer
in file XPath.php, variable XML_XPath::$pointer
parentNode
in file common.php, method XML_XPath_common::parentNode()
    Moves the internal pointer to the parent of the current node or returns the pointer.
previousSibling
in file common.php, method XML_XPath_common::previousSibling()
    Moves the internal pointer to the previous sibling of the current node or returns the pointer.
top

q

$query
in file result.php, variable XML_XPath_result::$query
    original xpath query, stored when we need to sort
top

r

registerNamespace
in file XPath.php, method XML_XPath::registerNamespace()
    This function is sort of temporary hack for registering namespace prefixes
removeAttribute
in file common.php, method XML_XPath_common::removeAttribute()
    Remove the attribute by name.
removeChild
in file common.php, method XML_XPath_common::removeChild()
    Removes the child node at the current pointer and returns it.
replaceChild
in file common.php, method XML_XPath_common::replaceChild()
    Replaces the old child with the new child. If the new child is already in the document, it is first removed (not implemented yet). If the new child is a document fragment, then all of the nodes are inserted in the location of the old child.
replaceChildren
in file common.php, method XML_XPath_common::replaceChildren()
    Not in the DOM specification, but certainly a convenient function. Allows you to pass in an xml document fragment which will be parsed into an xml object and merged into the xml document, replacing all the previous children of the node. It does this by shallow cloning the node, restoring the attributes and then adding the parsed children.
replaceData
in file common.php, method XML_XPath_common::replaceData()
    Will replace data at offset and for count with content
reset
in file XPath.php, method XML_XPath::reset()
    Resets the object so it is possible to load another xml document.
resultType
in file result.php, method XML_XPath_result::resultType()
    Retrieve the type of result that was returned by the xpath query.
rewind
in file result.php, method XML_XPath_result::rewind()
    Reset the result index back to the beginning, if this is an XPATH_NODESET
result.php
procedural page result.php
top

s

$skipBlanks
in file common.php, variable XML_XPath_common::$skipBlanks
    when working with the xml document, ignore the presence of blank nodes (white space)
setAttribute
in file common.php, method XML_XPath_common::setAttribute()
    Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter.
setPointer
in file common.php, method XML_XPath_common::setPointer()
    Set the pointer in the xml document
sort
in file result.php, method XML_XPath_result::sort()
    Sort the nodeset in this result. The sort can be either ascending or descending, and the comparisons can be text, number or natural (see the constants above). The sort axis is provided as an xpath query and is the location path relative to the node given.
substringData
in file common.php, method XML_XPath_common::substringData()
    Extracts a range of data from the node. Takes an offset and a count, which are optional and will default to retrieving the whole string. If an XML_ELEMENT_NODE provided, then it first concats all the adjacent text nodes recusively and works on those.
top

t

$type
in file result.php, variable XML_XPath_result::$type
    The type of result that the query generated
toFile
in file common.php, method XML_XPath_common::toFile()
    Exports the xml document to a file. Only works for the whole document right now.
toString
in file common.php, method XML_XPath_common::toString()
    Export the xml document to a string, beginning from the pointer.
top

x

$xml
in file XPath.php, variable XML_XPath::$xml
$xml
in file result.php, variable XML_XPath_result::$xml
    domxml object, need for many common functions
$xmllint
in file common.php, variable XML_XPath_common::$xmllint
    path to xmllint used for reformating the xml output
XML_DUPLICATE_ROOT
in file XPath.php, constant XML_DUPLICATE_ROOT
XML_PARSE_ERROR
in file XPath.php, constant XML_PARSE_ERROR
XML_XPath
in file XPath.php, class XML_XPath
    The main "XML_XPath" class is simply a container class with some methods for creating DOM xml objects and preparing error codes
XML_Xpath
in file XPath.php, method XML_XPath::XML_Xpath()
XML_XPath_example.php
procedural page XML_XPath_example.php
XPath.php
procedural page XPath.php
XML_XPATH_ALREADY_EXISTS
in file XPath.php, constant XML_XPATH_ALREADY_EXISTS
XML_XPath_common
in file common.php, class XML_XPath_common
    The XML_XPath_common class contains the DOM functions used to manipulate
XML_XPath_Error
in file error.php, class XML_XPath_Error
    Error class for the XML_XPath interface, which just prepares some variables and spawns PEAR_Error
XML_XPATH_ERROR
in file XPath.php, constant XML_XPATH_ERROR
XML_XPATH_FILE_NOT_WRITABLE
in file XPath.php, constant XML_XPATH_FILE_NOT_WRITABLE
XML_XPATH_INDEX_SIZE
in file XPath.php, constant XML_XPATH_INDEX_SIZE
XML_XPATH_INVALID_DOCUMENT
in file XPath.php, constant XML_XPATH_INVALID_DOCUMENT
XML_XPATH_INVALID_INDEX
in file XPath.php, constant XML_XPATH_INVALID_INDEX
XML_XPATH_INVALID_NODESET
in file XPath.php, constant XML_XPATH_INVALID_NODESET
XML_XPATH_INVALID_NODETYPE
in file XPath.php, constant XML_XPATH_INVALID_NODETYPE
XML_XPATH_INVALID_QUERY
in file XPath.php, constant XML_XPATH_INVALID_QUERY
XML_XPATH_NODE_REQUIRED
in file XPath.php, constant XML_XPATH_NODE_REQUIRED
XML_XPATH_NOT_LOADED
in file XPath.php, constant XML_XPATH_NOT_LOADED
XML_XPATH_NO_DOM
in file XPath.php, constant XML_XPATH_NO_DOM
XML_XPATH_NULL_POINTER
in file XPath.php, constant XML_XPATH_NULL_POINTER
XML_XPATH_OK
in file XPath.php, constant XML_XPATH_OK
XML_XPath_result
in file result.php, method XML_XPath_result::XML_XPath_result()
XML_XPath_result
in file result.php, class XML_XPath_result
    Interface for an XML_XPath result so that one can cycle through the result set and manipulate the main tree with DOM methods using a seperate pointer then the original class.
XML_XPATH_SORT_NATURAL_ASCENDING
in file result.php, constant XML_XPATH_SORT_NATURAL_ASCENDING
XML_XPATH_SORT_NATURAL_DESCENDING
in file result.php, constant XML_XPATH_SORT_NATURAL_DESCENDING
XML_XPATH_SORT_NUMBER_ASCENDING
in file result.php, constant XML_XPATH_SORT_NUMBER_ASCENDING
XML_XPATH_SORT_NUMBER_DESCENDING
in file result.php, constant XML_XPATH_SORT_NUMBER_DESCENDING
XML_XPATH_SORT_TEXT_ASCENDING
in file result.php, constant XML_XPATH_SORT_TEXT_ASCENDING
XML_XPATH_SORT_TEXT_DESCENDING
in file result.php, constant XML_XPATH_SORT_TEXT_DESCENDING
top
Documentation generated on Mon, 11 Mar 2019 14:44:41 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.