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


Tutorials/Manuals:
Package-level: Files:
Core.php
FluentDOM.php
Handler.php
Iterator.php
Style.php

subpackage Loaders
DOMDocument.php
DOMNode.php
FileHTML.php
FileXML.php
Loader.php
PDO.php
SimpleXMLElement.php
StringHTML.php
StringJSON.php
StringXML.php

Interfaces:
Loaders
   FluentDOMLoader
Classes:
FluentDOM
FluentDOMCore
FluentDOMHandler
FluentDOMIterator
FluentDOMStyle
Loaders
   FluentDOMLoaderDOMDocument
   FluentDOMLoaderDOMNode
   FluentDOMLoaderFileHTML
   FluentDOMLoaderFileXML
   FluentDOMLoaderPDO
   FluentDOMLoaderSimpleXMLElement
   FluentDOMLoaderStringHTML
   FluentDOMLoaderStringJSON
   FluentDOMLoaderStringXML

Element index for package FluentDOM

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ x ] [ _ ]

_

$_array
in file Core.php, variable FluentDOMCore::$_array
    Seleted element and text nodes
$_contentType
in file Core.php, variable FluentDOMCore::$_contentType
    Content type for output (xml, text/xml, html, text/html).
$_document
in file Core.php, variable FluentDOMCore::$_document
    Associated DOMDocument object.
$_loaders
in file Core.php, variable FluentDOMCore::$_loaders
    Document loader list.
$_namespaces
in file Core.php, variable FluentDOMCore::$_namespaces
    List of namespaces to be registered for xpath expressions
$_owner
in file Iterator.php, variable FluentDOMIterator::$_owner
    owner (object) of the iterator
$_parent
in file Core.php, variable FluentDOMCore::$_parent
    Parent FluentDOM object (previous selection in chain).
$_position
in file Iterator.php, variable FluentDOMIterator::$_position
    internal position pointer variable
$_useDocumentContext
in file Core.php, variable FluentDOMCore::$_useDocumentContext
    Use document context for expression (not selected nodes).
$_xpath
in file Core.php, variable FluentDOMCore::$_xpath
    XPath object used to execute selectors
_applyContentToNodes
in file Core.php, method FluentDOMCore::_applyContentToNodes()
    Use a handler callback to apply a content argument to each node $targetNodes. The content argument can be an easy setter function
_cloneNodes
in file FluentDOM.php, method FluentDOM::_cloneNodes()
    Clone matched DOM Elements and select the clones.
_compareCSSProperties
in file Style.php, method FluentDOMStyle::_compareCSSProperties()
    compare to css property names
_decodeStyleAttribute
in file Style.php, method FluentDOMStyle::_decodeStyleAttribute()
    decode style attribute to css properties array
_emptyNodes
in file FluentDOM.php, method FluentDOM::_emptyNodes()
    Remove all child nodes from the set of matched elements.
_encodeStyleAttribute
in file Style.php, method FluentDOMStyle::_encodeStyleAttribute()
    encode css options array for the style string
_executeEasySetter
in file Core.php, method FluentDOMCore::_executeEasySetter()
    Execute the easy setter function for a node and return the new elements
_getContentElement
in file Core.php, method FluentDOMCore::_getContentElement()
    Convert $content to a DOMElement. If $content contains several elements use the first.
_getContentFragment
in file Core.php, method FluentDOMCore::_getContentFragment()
    Convert a given content xml string into and array of nodes
_getContentNodes
in file Core.php, method FluentDOMCore::_getContentNodes()
    Convert a given content into and array of nodes
_getContextNodes
in file Core.php, method FluentDOMCore::_getContextNodes()
_getCSSPropertyElements
in file Style.php, method FluentDOMStyle::_getCSSPropertyElements()
    decodes the css property name into an compareable array
_getHandler
in file Core.php, method FluentDOMCore::_getHandler()
    Get the class/object providing the handler functions
_getInnerXml
in file Core.php, method FluentDOMCore::_getInnerXml()
    Get the inner xml of a given node or in other words the xml of all children.
_getTargetNodes
in file Core.php, method FluentDOMCore::_getTargetNodes()
    Get the target nodes from a given $selector.
_initLoaders
in file Core.php, method FluentDOMCore::_initLoaders()
    Initialize default loaders if they are not already initialized
_inList
in file Core.php, method FluentDOMCore::_inList()
    Check if object is already in internal list
_isCallback
in file Core.php, method FluentDOMCore::_isCallback()
    check if parameter is a valid callback function
_isCSSProperty
in file Style.php, method FluentDOMStyle::_isCSSProperty()
    check if string is an valid css property name
_isNCName
in file Core.php, method FluentDOMCore::_isNCName()
    Validate string as qualified node name part (namespace or local name)
_isNode
in file Core.php, method FluentDOMCore::_isNode()
    Check if the DOMNode is DOMElement or DOMText with content
_isNodeList
in file Core.php, method FluentDOMCore::_isNodeList()
    Check if $elements is a iterateable node list
_isQName
in file Core.php, method FluentDOMCore::_isQName()
    Validate string as qualified node name
_match
in file Core.php, method FluentDOMCore::_match()
    Match XPath expression agains context and return matched elements.
_removeNodes
in file Core.php, method FluentDOMCore::_removeNodes()
    Remove nodes from document tree
_setContentType
in file Core.php, method FluentDOMCore::_setContentType()
    Setter for FluentDOM::_contentType property
_test
in file Core.php, method FluentDOMCore::_test()
    Test xpath expression against context and return true/false
_uniqueSort
in file Core.php, method FluentDOMCore::_uniqueSort()
    Sorts the selected nodes, with the duplicates removed.
_wrap
in file FluentDOM.php, method FluentDOM::_wrap()
    Wrap $content around a set of elements
_xpath
in file Core.php, method FluentDOMCore::_xpath()
    Get a XPath object associated with the internal DOMDocument and register default namespaces from the document element if availiable.
__call
in file FluentDOM.php, method FluentDOM::__call()
    declaring an empty() or clone() method will crash the parser so we use some magic
__construct
in file Iterator.php, method FluentDOMIterator::__construct()
    Remember the owner object (the FluentDOMCore object this iterator interates)
__construct
in file Core.php, method FluentDOMCore::__construct()
    Constructor
__get
in file Core.php, method FluentDOMCore::__get()
    implement dynamic properties using magic methods
__isset
in file Core.php, method FluentDOMCore::__isset()
    support isset for dynamic properties length and document
__set
in file Core.php, method FluentDOMCore::__set()
    block changes of dynamic readonly property length
__toString
in file Core.php, method FluentDOMCore::__toString()
    Return the XML output of the internal dom document
$_tagNameRecord
in file PDO.php, variable FluentDOMLoaderPDO::$_tagNameRecord
    record element name
$_tagNameRoot
in file PDO.php, variable FluentDOMLoaderPDO::$_tagNameRoot
    root element name
_addElement
in file StringJSON.php, method FluentDOMLoaderStringJSON::_addElement()
    Add new element, sanitize tag name if nessesary
_getNodeType
in file PDO.php, method FluentDOMLoaderPDO::_getNodeType()
    get node type (attribute or element)
_normalizeColumnName
in file PDO.php, method FluentDOMLoaderPDO::_normalizeColumnName()
    normalize column for tag name use
_toDom
in file StringJSON.php, method FluentDOMLoaderStringJSON::_toDom()
    Convert a JSON object structure to a DOMDocument
top

a

add
in file FluentDOM.php, method FluentDOM::add()
    Adds more elements, matched by the given expression, to the set of matched elements.
addClass
in file FluentDOM.php, method FluentDOM::addClass()
    Adds the specified class(es) to each of the set of matched elements.
after
in file FluentDOM.php, method FluentDOM::after()
    Insert content after each of the matched elements.
andSelf
in file FluentDOM.php, method FluentDOM::andSelf()
    Add the previous selection to the current selection.
append
in file FluentDOM.php, method FluentDOM::append()
    Append content to the inside of every matched element.
appendChildren
in file Handler.php, method FluentDOMHandler::appendChildren()
    Append nodes into target.
appendTo
in file FluentDOM.php, method FluentDOM::appendTo()
    Append all of the matched elements to another, specified, set of elements.
attr
in file FluentDOM.php, method FluentDOM::attr()
    Access a property on the first matched element or set the attribute(s) of all matched elements
ATTRIBUTE_VALUE
in file PDO.php, class constant FluentDOMLoaderPDO::ATTRIBUTE_VALUE
    Element type attribute
top

b

before
in file FluentDOM.php, method FluentDOM::before()
    Insert content before each of the matched elements.
top

c

children
in file FluentDOM.php, method FluentDOM::children()
    Get a set of elements containing of the unique immediate childnodes including only elements (not textnodes) of each of the matched set of elements.
closest
in file FluentDOM.php, method FluentDOM::closest()
    Get a set of elements containing the closest parent element that matches the specified selector, the starting element included.
contents
in file FluentDOM.php, method FluentDOM::contents()
    Get a set of elements containing all of the unique immediate childnodes including elements and textnodes of each of the matched set of elements.
count
in file Core.php, method FluentDOMCore::count()
    Get element count (Countable interface)
css
in file Style.php, method FluentDOMStyle::css()
    get or set CSS values in style attributes
current
in file Iterator.php, method FluentDOMIterator::current()
    Get current iterator element
Core.php
procedural page Core.php
top

d

DOMDocument.php
procedural page DOMDocument.php
DOMNode.php
procedural page DOMNode.php
top

e

each
in file FluentDOM.php, method FluentDOM::each()
    Execute a function within the context of every matched element.
end
in file FluentDOM.php, method FluentDOM::end()
    Revert the most recent traversing operation, changing the set of matched elements to its previous state.
eq
in file FluentDOM.php, method FluentDOM::eq()
    Reduce the set of matched elements to a single element.
evaluate
in file Core.php, method FluentDOMCore::evaluate()
    Gives access to an xpath evaluate on the current document
ELEMENT_VALUE
in file PDO.php, class constant FluentDOMLoaderPDO::ELEMENT_VALUE
    Element type value
top

f

filter
in file FluentDOM.php, method FluentDOM::filter()
    Removes all elements from the set of matched elements that do not match the specified expression(s).
find
in file FluentDOM.php, method FluentDOM::find()
    Searches for descendent elements that match the specified expression.
first
in file FluentDOM.php, method FluentDOM::first()
    Get a set of elements containing only the first of the currently selected elements.
FluentDOM
in file FluentDOM.php, class FluentDOM
    FluentDOM implements a jQuery like replacement for DOMNodeList
FluentDOM
in file FluentDOM.php, function FluentDOM()
    Function to create a new FluentDOM instance and loads data into it if a valid $source is provided.
FluentDOM.php
procedural page FluentDOM.php
FluentDOMCore
in file Core.php, class FluentDOMCore
    FluentDOMCore implements the core and interface functions for FluentDOM
FluentDOMHandler
in file Handler.php, class FluentDOMHandler
    FluentDOMHandler provides dom manipulation functions
FluentDOMIterator
in file Iterator.php, class FluentDOMIterator
    FluentDOMIterator is the Iterator class for FluentDOMCore objects
FluentDOMStyle
in file Style.php, function FluentDOMStyle()
    Function to create a new FluentDOMStyleinstance and loads data into it if a valid $source is provided.
FluentDOMStyle
in file Style.php, class FluentDOMStyle
    FluentDOMStyle extends the FluentDOM class with a function to edit the style attribute of html tags
formatOutput
in file Core.php, method FluentDOMCore::formatOutput()
    Formats the current document, resets internal node array and other properties.
FileHTML.php
procedural page FileHTML.php
FileXML.php
procedural page FileXML.php
FluentDOMLoader
in file Loader.php, class FluentDOMLoader
    Interface for FluentDOM loaders
FluentDOMLoaderDOMDocument
in file DOMDocument.php, class FluentDOMLoaderDOMDocument
    Load FluentDOM from DOMDocument
FluentDOMLoaderDOMNode
in file DOMNode.php, class FluentDOMLoaderDOMNode
    Load FluentDOM from DOMDocument
FluentDOMLoaderFileHTML
in file FileHTML.php, class FluentDOMLoaderFileHTML
    Load FluentDOM from HTML file
FluentDOMLoaderFileXML
in file FileXML.php, class FluentDOMLoaderFileXML
    Load FluentDOM from XML file
FluentDOMLoaderPDO
in file PDO.php, class FluentDOMLoaderPDO
    Load FluentDOM from pdo result
FluentDOMLoaderSimpleXMLElement
in file SimpleXMLElement.php, class FluentDOMLoaderSimpleXMLElement
    Load FluentDOM from SimpleXMLElement
FluentDOMLoaderStringHTML
in file StringHTML.php, class FluentDOMLoaderStringHTML
    Load FluentDOM from HTML string
FluentDOMLoaderStringJSON
in file StringJSON.php, class FluentDOMLoaderStringJSON
    Load FluentDOM from JSON encoded string
FluentDOMLoaderStringXML
in file StringXML.php, class FluentDOMLoaderStringXML
    Load FluentDOM from XML string
top

g

get
in file FluentDOM.php, method FluentDOM::get()
    Retrieve the matched DOM elements in an array. A negative position will be counted from the end.
getChildren
in file Iterator.php, method FluentDOMIterator::getChildren()
    Get children of the current iterator element
getIterator
in file Core.php, method FluentDOMCore::getIterator()
    Get an iterator for this object.
top

h

Handler.php
procedural page Handler.php
has
in file FluentDOM.php, method FluentDOM::has()
    Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.
hasChildren
in file Iterator.php, method FluentDOMIterator::hasChildren()
    Check if the current iterator element has children
hasClass
in file FluentDOM.php, method FluentDOM::hasClass()
    Returns true if the specified class is present on at least one of the set of matched elements.
top

i

Iterator.php
procedural page Iterator.php
index
in file FluentDOM.php, method FluentDOM::index()
    Search for a given element from among the matched elements.
insertAfter
in file FluentDOM.php, method FluentDOM::insertAfter()
    Insert all of the matched elements after another, specified, set of elements.
insertBefore
in file FluentDOM.php, method FluentDOM::insertBefore()
    Insert all of the matched elements before another, specified, set of elements.
insertChildrenBefore
in file Handler.php, method FluentDOMHandler::insertChildrenBefore()
    Insert nodes into target as first childs.
insertNodesAfter
in file Handler.php, method FluentDOMHandler::insertNodesAfter()
    Insert nodes after the target node.
insertNodesBefore
in file Handler.php, method FluentDOMHandler::insertNodesBefore()
    Insert nodes before the target node.
is
in file FluentDOM.php, method FluentDOM::is()
    Checks the current selection against an expression and returns true, if at least one element of the selection fits the given expression.
item
in file Core.php, method FluentDOMCore::item()
    The item() method is used to access elements in the node list, like in a DOMNodelist.
top

j

$jsonErrors
in file StringJSON.php, variable FluentDOMLoaderStringJSON::$jsonErrors
    JSON errors
top

k

key
in file Iterator.php, method FluentDOMIterator::key()
    Get current iterator pointer
top

l

last
in file FluentDOM.php, method FluentDOM::last()
    Get a set of elements containing only the last of the currently selected elements.
load
in file Core.php, method FluentDOMCore::load()
    Load a $source. The type of the source depends on the loaders. If no explicit loaders are set FluentDOM will use a set of default loaders for xml/html and DOM.
Loader.php
procedural page Loader.php
load
in file SimpleXMLElement.php, method FluentDOMLoaderSimpleXMLElement::load()
    Select DOMNode representation of an existing SimpleXMLElement
load
in file StringHTML.php, method FluentDOMLoaderStringHTML::load()
    load DOMDocument from html string
load
in file StringJSON.php, method FluentDOMLoaderStringJSON::load()
    Load DOMDocument from local XML file
load
in file StringXML.php, method FluentDOMLoaderStringXML::load()
    Load DOMDocument from xml string
load
in file PDO.php, method FluentDOMLoaderPDO::load()
    Load DOMDocument from xml string
load
in file Loader.php, method FluentDOMLoader::load()
    load FluentDOM document data from a source
load
in file DOMNode.php, method FluentDOMLoaderDOMNode::load()
    attach existing DOMNode->ownerdocument and select the DOMNode
load
in file FileHTML.php, method FluentDOMLoaderFileHTML::load()
    load DOMDocument from local HTML file
load
in file FileXML.php, method FluentDOMLoaderFileXML::load()
    load DOMDocument from local XML file
load
in file DOMDocument.php, method FluentDOMLoaderDOMDocument::load()
    Attach existing DOMDocument to a FluentDOM
top

m

map
in file FluentDOM.php, method FluentDOM::map()
    Translate a set of elements in the FluentDOM object into another set of values in an array (which may, or may not contain elements).
top

n

namespaces
in file Core.php, method FluentDOMCore::namespaces()
    Register namespaces and or get namespaces
next
in file FluentDOM.php, method FluentDOM::next()
    Get a set of elements containing the unique next siblings of each of the given set of elements.
next
in file Iterator.php, method FluentDOMIterator::next()
    Move iterator pointer to next element
nextAll
in file FluentDOM.php, method FluentDOM::nextAll()
    Find all sibling elements after the current element.
nextUntil
in file FluentDOM.php, method FluentDOM::nextUntil()
    Get all following siblings of each element up to but not including the element matched by the selector.
not
in file FluentDOM.php, method FluentDOM::not()
    Removes elements matching the specified expression from the set of matched elements.
top

o

offsetExists
in file Core.php, method FluentDOMCore::offsetExists()
    Check if index exists in internal array
offsetGet
in file Core.php, method FluentDOMCore::offsetGet()
    Get element from internal array
offsetSet
in file Core.php, method FluentDOMCore::offsetSet()
    If somebody tries to modify the internal array throw an exception.
offsetUnset
in file Core.php, method FluentDOMCore::offsetUnset()
    If somebody tries to remove an element from the internal array throw an exception.
top

p

parent
in file FluentDOM.php, method FluentDOM::parent()
    Get a set of elements containing the unique parents of the matched set of elements.
parents
in file FluentDOM.php, method FluentDOM::parents()
    Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.
parentsUntil
in file FluentDOM.php, method FluentDOM::parentsUntil()
    Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector.
prepend
in file FluentDOM.php, method FluentDOM::prepend()
    Prepend content to the inside of every matched element.
prependTo
in file FluentDOM.php, method FluentDOM::prependTo()
    Prepend all of the matched elements to another, specified, set of elements.
prev
in file FluentDOM.php, method FluentDOM::prev()
    Get a set of elements containing the unique previous siblings of each of the matched set of elements.
prevAll
in file FluentDOM.php, method FluentDOM::prevAll()
    Find all sibling elements in front of the current element.
prevUntil
in file FluentDOM.php, method FluentDOM::prevUntil()
    Get all preceding siblings of each element up to but not including the element matched by the selector.
push
in file Core.php, method FluentDOMCore::push()
    Push new element(s) an the internal element list
PDO.php
procedural page PDO.php
top

r

remove
in file FluentDOM.php, method FluentDOM::remove()
    Removes all matched elements from the DOM.
removeAttr
in file FluentDOM.php, method FluentDOM::removeAttr()
    Remove an attribute from each of the matched elements.
removeClass
in file FluentDOM.php, method FluentDOM::removeClass()
    Removes all or the specified class(es) from the set of matched elements.
replaceAll
in file FluentDOM.php, method FluentDOM::replaceAll()
    Replaces the elements matched by the specified selector with the matched elements.
replaceWith
in file FluentDOM.php, method FluentDOM::replaceWith()
    Replaces all matched elements with the specified HTML or DOM elements.
rewind
in file Iterator.php, method FluentDOMIterator::rewind()
    Reset iterator pointer
top

s

Style.php
procedural page Style.php
seek
in file Iterator.php, method FluentDOMIterator::seek()
    Move iterator pointer to specified element
setLoaders
in file Core.php, method FluentDOMCore::setLoaders()
    Define own loading handlers
siblings
in file FluentDOM.php, method FluentDOM::siblings()
    Get a set of elements containing all of the unique siblings of each of the matched set of elements.
slice
in file FluentDOM.php, method FluentDOM::slice()
    Selects a subset of the matched elements.
spawn
in file Core.php, method FluentDOMCore::spawn()
    Create a new instance of the same class with $this as the parent. This is used for the chaining.
STYLE_PATTERN
in file Style.php, class constant FluentDOMStyle::STYLE_PATTERN
    Pattern to decode the stlye property string
SimpleXMLElement.php
procedural page SimpleXMLElement.php
StringHTML.php
procedural page StringHTML.php
StringJSON.php
procedural page StringJSON.php
StringXML.php
procedural page StringXML.php
setTagNames
in file PDO.php, method FluentDOMLoaderPDO::setTagNames()
    set root and record tag name for xml elements.
top

t

text
in file FluentDOM.php, method FluentDOM::text()
    Get the combined text contents of all matched elements or set the text contents of all matched elements.
toArray
in file FluentDOM.php, method FluentDOM::toArray()
    Retrieve the matched DOM elements in an array.
toggleClass
in file FluentDOM.php, method FluentDOM::toggleClass()
    Adds the specified class if the switch is TRUE, removes the specified class if the switch is FALSE, toggles the specified class if the switch is NULL.
$typeAttributes
in file StringJSON.php, variable FluentDOMLoaderStringJSON::$typeAttributes
    Add variable type attributes to the element nodes
top

u

unique
in file Core.php, method FluentDOMCore::unique()
    Sorts an array of DOM nodes based on document position, in place, with the duplicates removed.
top

v

valid
in file Iterator.php, method FluentDOMIterator::valid()
    Check if current iterator pointer contains a valid element
top

w

wrap
in file FluentDOM.php, method FluentDOM::wrap()
    Wrap each matched element with the specified content.
wrapAll
in file FluentDOM.php, method FluentDOM::wrapAll()
    Wrap al matched elements with the specified content
wrapInner
in file FluentDOM.php, method FluentDOM::wrapInner()
    Wrap the inner child contents of each matched element (including text nodes) with an XML structure.
top

x

xml
in file FluentDOM.php, method FluentDOM::xml()
    Get or set the xml contents of the first matched element.
top
Documentation generated on Fri, 30 Jul 2010 01:00:28 +0200 by phpDocumentor 1.4.3