• Home
• pQuery
• DomNode

PHP Class pQuery\DomNode

Show file Open project: tburry/pquery Class Usage Examples

Public Properties

Property	Type	Description
$attribute_shorttag	boolean	Use short tags for attributes? If true, then attributes with values equal to the attribute name will not output the value, e.g. selected="selected" will be selected.
$attributes	array	Attributes of node
$attributes_ns	array	Namespace info for attributes
$childClass	string	Name of the class used for {@link addChild()}
$childClass_ASP	string	Name of the class used for {@link addASP()}
$childClass_CDATA	string	Name of the class used for {@link addCDATA()}
$childClass_Comment	string	Name of the class used for {@link addComment()}
$childClass_Conditional	string	Name of the class used for {@link addContional()}
$childClass_Doctype	string	Name of the class used for {@link addDoctype()}
$childClass_Text	string	Name of the class used for {@link addText()}
$childClass_XML	string	Name of the class used for {@link addXML()}
$children	array	Array of child nodes
$filter_map	array	Function map used for the selector filter
$parent	DomNode	Parent node, null if none
$parserClass	string	Name of the parser class
$selectClass	string	Name of the selector class
$self_close	boolean	Is node a self closing node? No closing tag if true.
$self_close_str	string	If self close, then this will be used to close the tag
$tag	string	Full tag name (including namespace)
$tag_ns	array	Namespace info for tag

Public Methods

Method	Description
__construct ( string | array $tag, DomNode $parent )	Class constructor
__destruct ( )	Class destructor
__get ( $attribute ) : string	Class magic get method, outputs {@link getAttribute()}
__invoke ( string $query = '*' ) : pQuery	Class magic invoke method, performs {@link query()}.
__isset ( $attribute ) : boolean	Class magic isset method, returns {@link hasAttribute()}
__set ( $attribute, $value )	Class magic set method, performs {@link setAttribute()}
__toString ( ) : string	Class toString, outputs {@link $tag}
__unset ( $attribute )	Class magic unset method, performs {@link deleteAttribute()}
addASP ( $tag = '', $text = '', $attributes = [], &$offset = null )	#php5
addAttribute ( string $attr, string $val )	Add new attribute
addCDATA ( $text, &$offset = null )	#php5
addChild ( $tag, &$offset = null )	#php5
addClass ( string | array $className )	Add new class(es)
addComment ( $text, &$offset = null )	#php5
addConditional ( $condition, $hidden = true, &$offset = null )	#php5
addDoctype ( $dtd, &$offset = null )	#php5
addText ( $text, &$offset = null )	#php5
addXML ( $tag = 'xml', $text = '', $attributes = [], &$offset = null )	#php5
after ( $content )
append ( $content )
attr ( $name, $value = null )
attributeCount ( ) : integer	Number of attributes
before ( $content )
changeParent ( $to, &$index = null )	#php5
childCount ( boolean $ignore_text_comments = false ) : integer	Number of children in node
clear ( )	Deletes all child nodes from node
count ( )
delete ( )	Delete node from parent and clear node
deleteAttribute ( string | integer $attr, string $compare = 'total', boolean $case_sensitive = false )	Delete attribute(s)
deleteChild ( integer | DomNode $child, boolean $soft_delete = false )	Delete a child node
detach ( boolean $move_children_up = false )	Detach node from parent
dumpLocation ( ) : string	Returns place in document
findChild ( DomNode $child ) : integer	Find node in children
firstChild ( boolean $ignore_text_comments = false ) : DomNode	First child node
getAttribute ( string | integer $attr, string $compare = 'total', boolean $case_sensitive = false ) : string | array	Gets value(s) of attribute(s)
getAttributeNS ( string | integer $attr, string $compare = 'name', boolean $case_sensitive = false ) : string | array	Gets namespace of attribute(s)
getChild ( integer | DomNode $child, boolean $ignore_text_comments = false ) : DomNode	Get childnode
getChildrenByAttribute ( string $attribute, string $value, string $mode = 'equals', string $compare = 'total', boolean | integer $recursive = true ) : array	Finds children that match a certain attribute
getChildrenByCallback ( callable $callback, boolean | integer $recursive = true, boolean $check_self = false ) : array	Finds children using a callback function
getChildrenByClass ( string $class, boolean | integer $recursive = true ) : array	Finds all children using class attribute
getChildrenByID ( string $id, boolean | integer $recursive = true ) : array	Finds all children using ID attribute
getChildrenByMatch ( $conditions, boolean | integer $recursive = true, boolean $check_self = false, $custom_filters = [] ) : array	Finds children using the {$link match()} function
getChildrenByName ( string $name, boolean | integer $recursive = true ) : array	Finds all children using name attribute
getChildrenByTag ( string $tag, string $compare = 'total', boolean | integer $recursive = true ) : array	Finds children that match a certain tag
getEncoding ( ) : string | boolean	Try to determine the encoding of the current tag
getInnerText ( ) : string	Similar to JavaScript innerText, will return (html formatted) content
getNamespace ( ) : string	Get namespace of node
getNextSibling ( boolean $skip_text_comments = true ) : DomNode	Get node next to current
getOuterText ( ) : string	Similar to JavaScript outerText, will return full (html formatted) node
getPlainText ( ) : string	Similar to JavaScript plainText, will return text in node (and subnodes)
getPlainTextUTF8 ( ) : string	Return plaintext taking document encoding into account
getPreviousSibling ( boolean $skip_text_comments = true ) : DomNode	Get node previous to current
getRoot ( ) : DomNode	Get top parent
getSibling ( integer $offset = 1 ) : DomNode	Get sibling node
getTag ( ) : string	Get tagname of node (without namespace)
hasAttribute ( $attr, string $compare = 'total', boolean $case_sensitive = false ) : boolean	Checks if node has attribute
hasChild ( DomNode $child ) : boolean	Checks if node has another node as child
hasClass ( string $className ) : boolean	Determine if node has a certain class
hasParent ( DomNode | string $tag = null, boolean $recursive = false ) : boolean	Find out if node has (a certain) parent
html ( string | null $value = null ) : string	Return html code of node
indent ( ) : integer	Calculate indent of node (number of parent tags - 1)
index ( boolean $count_all = true ) : integer	Index of node in parent
insertChild ( string | DomNode $tag, $index ) : DomNode	Insert childnode
isComment ( ) : boolean	Find out if node is comment
isParent ( DomNode | string $tag, boolean $recursive = false ) : boolean	Find out if node is parent of a certain tag
isText ( ) : boolean	Find out if node is text
isTextOrComment ( ) : boolean	Find out if node is text or comment node
lastChild ( boolean $ignore_text_comments = false ) : DomNode	Last child node
match ( $conditions, array $match = true, array $custom_filters = [] ) : boolean	Checks if node matches certain conditions
move ( $to, &$new_index )	#php5
moveChildren ( $to, &$new_index, $start, $end )	#php5
prepend ( $content = null )	}
prop ( $name, $value = null )
query ( string $query = '*' ) : pquery\IQuery	Performs a css query on the node.
remove ( $selector = null )
removeAttr ( $name )
removeClass ( string | array $className )	Remove clas(ses)
replaceWith ( $content )
select ( string $query = '*', integer | boolean $index = false, boolean | integer $recursive = true, boolean $check_self = false ) : DomNode[] | DomNode	Performs css query on node
setAttribute ( string | integer $attr, $val, string $compare = 'total', boolean $case_sensitive = false )	Sets value(s) of attribute(s)
setAttributeNS ( string | integer $attr, string $namespace, string $compare = 'name', boolean $case_sensitive = false ) : boolean	Sets namespace of attribute(s)
setIndex ( integer $index )	Change index of node in parent
setInnerText ( string $text, HtmlParserBase $parser = null ) : boolean | array	Similar to JavaScript innerText, will replace child nodes with new text
setNamespace ( string $ns )	Set namespace of node
setOuterText ( string $text, HtmlParserBase $parser = null ) : boolean | array	Similar to JavaScript outerText, will replace node (and child nodes) with new text
setPlainText ( string $text )	Similar to JavaScript plainText, will replace child nodes with new text (literal)
setTag ( string $tag, boolean $with_ns = false )	Set tag (with or without namespace)
tagName ( type $value = null ) : string | DomNode
text ( $value = null )
toString ( boolean $attributes = true, boolean | integer $recursive = true, boolean | integer $content_only = false ) : string	Returns the node as string
toggleClass ( $classname, $switch = null )
typeIndex ( ) : integer	Index of all similar nodes in parent
unwrap ( )
val ( $value = null )
wrap ( string | DomNode $node, integer $wrap_index, integer $node_index = null ) : DomNode	Wrap node
wrapInner ( string | DomNode $node, integer $start, integer $end, integer $wrap_index, integer $node_index = null ) : DomNode	Wrap child nodes

Protected Methods

Method	Description
createNode ( string | DomNode $content ) : DomNode	Create a {@link DomNode} from its string representation.
createNodes ( string | DomNode $content ) : DomNode[]	Create an array of {@link DomNode} objects from their string representation.
filter_checked ( ) : boolean	Checks if a node matches css query filter ":checked"
filter_comment ( ) : boolean	Checks if node matches css query filter ":comment"
filter_contains ( string $text ) : boolean	Checks if node matches css query filter ":contains(s)"
filter_element ( ) : boolean	Checks if node matches css query filter ":element"
filter_empty ( ) : boolean	Checks if node matches css query filter ":empty"
filter_even ( ) : boolean	Checks if node matches css query filter ":even"
filter_every ( $n ) : boolean	Checks if node matches css query filter ":every(n)"
filter_first ( ) : boolean	Checks if node matches css query filter ":first"
filter_firsttype ( ) : boolean	Checks if node matches css query filter ":first-of-type"
filter_gt ( string $n ) : boolean	Checks if node matches css query filter ":gt(n)"
filter_has ( string $selector ) : boolean	Checks if node matches css query filter ":has(s)"
filter_hastext ( ) : boolean	Checks if node matches css query filter ":has-text"
filter_lang ( string $lang ) : boolean	Checks if node matches css query filter ":lang(s)"
filter_last ( ) : boolean	Checks if node matches css query filter ":last"
filter_lasttype ( ) : boolean	Checks if node matches css query filter ":last-of-type"
filter_lt ( string $n ) : boolean	Checks if node matches css query filter ":lt(n)"
filter_nchild ( string $n ) : boolean	Checks if node matches css query filter ":nth-child(n)"
filter_nlastchild ( string $n ) : boolean	Checks if node matches css query filter ":nth-last-child(n)"
filter_nlastype ( string $n ) : boolean	Checks if node matches css query filter ":nth-last-of-type(n)"
filter_not ( string $selector ) : boolean	Checks if node matches css query filter ":not(s)"
filter_notempty ( ) : boolean	Checks if node matches css query filter ":not-empty"
filter_notext ( ) : boolean	Checks if node matches css query filter ":no-text"
filter_ntype ( string $n ) : boolean	Checks if node matches css query filter ":nth-of-type(n)"
filter_odd ( ) : boolean	Checks if node matches css query filter ":odd"
filter_onlychild ( ) : boolean	Checks if node matches css query filter ":only-child"
filter_onlytype ( ) : boolean	Checks if node matches css query filter ":only-of-type"
filter_root ( ) : boolean	Checks if node matches css query filter ":root"
filter_selected ( ) : boolean	Checks if a node matches css query filter ":selected"
filter_text ( ) : boolean	Checks if node matches css query filter ":text"
findAttribute ( string | integer $attr, string $compare = 'total', boolean $case_sensitive = false ) : array	Find attribute using namespace, name or both
match_attributes ( array $attributes ) : boolean	Checks if attributes match certain conditions
match_filters ( $conditions, array $custom_filters = [] ) : boolean	Checks if node matches certain filters
match_tags ( array $tags ) : boolean	Checks if tag matches certain conditions
toString_attributes ( ) : string	Returns all the attributes and their values
toString_content ( boolean $attributes = true, boolean | integer $recursive = true, boolean $content_only = false ) : string	Returns the content of the node (child tags and text)

Method Details

Property Details