Download the PHP package scotteh/php-dom-wrapper without Composer

PHP DOM Wrapper

Intro

PHP DOM Wrapper is a simple DOM wrapper library to manipulate and traverse HTML documents. Based around jQuery's manipulation and traversal methods, largely mimicking the behaviour of it's jQuery counterparts.

Author

• Andrew Scott ([email protected])

Requirements

• PHP 8.0 or later
• PSR-4 compatible autoloader

Install

Install with Composer.

Autoloading

This library requires an autoloader, if you aren't already using one you can include Composers autoloader.

Methods

Manipulation

Traversal

Other

Usage

Example #1:

Methods

Manipulation

addClass

Example

Result:

follow

Insert the argument as a sibling directly after each of the nodes operated on.

Example

Result:

appendWith

Example

Result:

appendTo

Example

Result:

attr

Example #1 (Set)

Result:

Example #2 (Get)

Result:

precede

Insert the argument as a sibling just before each of the nodes operated on.

Example

Result:

clone

Example

Result:

destroy

Example

Result:

detach

Example

Result:

empty

Example

Result:

hasClass

Example

Result:

html

Example #1 (Set)

Result:

Example #1 (Get)

Result:

prependWith

Example

Result:

prependTo

Example

Result:

removeAttr

Example

Result:

removeClass

Example

Result:

substituteWith

Replace each node in the current set with the contents provided.

Example

Result:

text

Get the text contents of the current set.

Example (get)

Result:

Set the text contents for current set.

Example (set)

Result:

unwrap

Unwrap each current node by removing its parent, replacing the parent with its children (i.e. the current node and its siblings).

Note that each node is operated on separately, so when you call unwrap() on a NodeList containing two siblings, two parents will be removed.

Example

Result:

wrap

Wrap the current node or nodes in the given structure.

The wrapping structure can be nested, but should only contain one node on each level (any extra siblings are removed). The outermost node replaces the node operated on, while the node operated on is put into the innermost node.

If called on a NodeList, each of nodes in the list will be separately wrapped. When such a list contains multiple nodes, the argument to wrap() cannot be a NodeList or \DOMNode, since those can be used to wrap a node only once. A string or callable returning a string or a unique NodeList or \DomNode every time can be used in this case.

When a callable is passed, it is called once for each node operated on, passing that node and its index. The callable should return either a string, or a unique NodeList or \DOMNode ever time it is called.

Note that this returns the original node like all other methods, not the (new) node(s) wrapped around it.

Example

Result:

wrapAll

Like wrap(), but when operating on multiple nodes, all of them will be wrapped together in a single instance of the given structure, rather than each of them individually.

Note that the wrapping structure replaces the first node operated on, so if the other nodes operated on are not siblings of the first, they will be moved inside the document.

Example

Result:

wrapInner

Like wrap(), but rather than wrapping the nodes that are being operated on, this wraps their contents.

Example

Result:

Traversal

add

Add additional node(s) to the existing set.

Example

children

Return all children of each element node in the current set.

Example

closest

Return the first element matching the supplied input by traversing up through the ancestors of each node in the current set.

Example

contents

Return all children of each node in the current set.

Example

eq

Return node in the current set at the specified index.

Example

filter

Return nodes in the current set that match the input.

Example

find

Return the decendants of the current set filtered by the selector and optional XPath axes.

Example

first

Return the first node of the current set.

Example

has

Return nodes with decendants of the current set matching the input.

Example

is

Test if nodes from the current set match the input.

Example

last

Return the last node of the current set.

Example

map

Apply a callback to nodes in the current set and return a new NodeList.

Example

following

Return the sibling immediately following each element node in the current set.

Optionally filtered by selector.

Example

followingAll

NodeList followingAll([string|NodeList|\DOMNode|callable $selector = null])

Return all siblings following each element node in the current set.

Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$follwingAllNodes = $nodes->followingAll('[anchor]');

followingUntil

NodeList followingUntil([[string|NodeList|\DOMNode|callable $input = null], string|NodeList|\DOMNode|callable $selector = null])

Return all siblings following each element node in the current set upto but not including the node matched by $input.

Optionally filtered by input.
Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$follwingUntilNodes = $nodes->followingUntil('.submit');

not

NodeList not(string|NodeList|\DOMNode|callable $input)

Return element nodes from the current set not matching the input.

Example

$nodes = $doc->find('a');
$missingHrefAttribute = $nodes->not('[href]');

parent

Element|NodeList|null parent([string|NodeList|\DOMNode|callable $selector = null])

Return the immediate parent of each element node in the current set.

Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$parentNodes = $nodes->parent();

parents

NodeList parent([string $selector = null])

Return the ancestors of each element node in the current set.

Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$ancestorDivNodes = $nodes->parents('div');

parentsUntil

NodeList parentsUntil([[string|NodeList|\DOMNode|callable $input, [string|NodeList|\DOMNode|callable $selector = null])

Return the ancestors of each element node in the current set upto but not including the node matched by $selector.

Optionally filtered by input.
Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$ancestorDivNodes = $nodes->parentsUntil('div');

preceding

\DOMNode|null preceding([string|NodeList|\DOMNode|callable $selector = null])

Return the sibling immediately preceding each element node in the current set.

Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$precedingNodes = $nodes->preceding();

precedingAll

NodeList precedingAll([string|NodeList|\DOMNode|callable $selector = null])

Return all siblings preceding each element node in the current set.

Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$precedingAllNodes = $nodes->precedingAll('[anchor]');

precedingUntil

NodeList precedingUntil([[string|NodeList|\DOMNode|callable $input = null], string|NodeList|\DOMNode|callable $selector = null])

Return all siblings preceding each element node in the current set upto but not including the node matched by $input.

Optionally filtered by input.
Optionally filtered by selector.

Example

$nodes = $doc->find('a');
$precedingUntilNodes = $nodes->precedingUntil('.submit');

siblings

NodeList siblings([[string|NodeList|\DOMNode|callable $selector = null])

Return siblings of each element node in the current set.

Optionally filtered by selector.

Example

$nodes = $doc->find('p');
$siblings = $nodes->siblings();

slice

NodeList slice(int $start[, int $end])

Return a subset of the current set based on the start and end indexes.

Example

$nodes = $doc->find('p');
// Return nodes 1 through to 3 as a new NodeList
$slicedNodes = $nodes->slice(1, 3);

Additional Methods

count

int count()

Return number of nodes in the current set

Example

$nodes = $doc->find('p');

echo $nodes->count();

each

self each(callable $function)

Iterate through for each item in the existing set via callback

Example

$nodes = $doc->find('p');

$nodes->each(function($node){
    echo $node->nodeName . "\n";
});

Licensing

PHP DOM Wrapper is licensed by Andrew Scott under the BSD 3-Clause License, see the LICENSE file for more details.