scotteh/php-dom-wrapper

Simple DOM wrapper to select nodes using either CSS or XPath expressions and manipulate results quickly and easily.

Maintainers

Details

github.com/scotteh/php-dom-wrapper

Homepage

Source

Issues

Installs: 1 281 716

Dependents: 12

Suggesters: 0

Security: 0

Stars: 144

Watchers: 10

Forks: 34

Open Issues: 4

3.0.1 2024-11-18 22:57 UTC

Requires

Requires (Dev)

BSD-3-Clause 79912a137a99ec51aea253a0c527b59b0b8f61fb

  • Andrew Scott <andrew.woop@andrewscott.net.au>

cssparserhtmldomwrapper

This package is auto-updated.

Last update: 2024-12-18 12:21:04 UTC

README

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

Requirements

  • PHP 8.0 or later
  • PSR-4 compatible autoloader

Install

Install with Composer.

composer require scotteh/php-dom-wrapper

Autoloading

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

require 'vendor/autoload.php';

Methods

Manipulation

Traversal

Other

Usage

Example #1:

use DOMWrap\Document;

$html = '<ul><li>First</li><li>Second</li><li>Third</li></ul>';

$doc = new Document();
$doc->html($html);
$nodes = $doc->find('li');

// Returns '3'
var_dump($nodes->count());

// Append as a child node to each <li>
$nodes->appendWith('<b>!</b>');

// Returns: <html><body><ul><li>First<b>!</b></li><li>Second<b>!</b></li><li>Third<b>!</b></li></ul></body></html>
var_dump($doc->html());

Methods

Manipulation

addClass

self addClass(string|callable $class)
Example
$doc = (new Document())->html('<p>first paragraph</p><p>second paragraph</p>');
$doc->find('p')->addClass('text-center');

Result:

<p class="text-center">first paragraph</p><p class="text-center">second paragraph</p>

follow

self follow(string|NodeList|\DOMNode|callable $input)

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

Example
$doc = (new Document())->html('<ul><li>first</li><li>second</li></ul>');
$doc->find('li')->first()->follow('<li>first-and-a-half</li>');

Result:

<ul>
    <li>first</li>
    <li>first-and-a-half</li>
    <li>second</li>
</ul>

appendWith

self appendWith(string|NodeList|\DOMNode|callable $input)
Example
$doc = (new Document())->html('<div>The quick brown fox jumps over the lazy dog</div>');
$doc->find('div')->appendWith('<strong> Appended!</strong>');

Result:

<div>The quick brown fox jumps over the lazy dog<strong> Appended!</strong></div>

appendTo

self appendTo(string|NodeList|\DOMNode $selector)
Example
$doc = (new Document())->html('<div>The quick brown fox jumps over the lazy dog</div>');
$doc->create('<strong> Appended!</strong>')->appendTo('div');

Result:

<div>The quick brown fox jumps over the lazy dog<strong> Appended!</strong></div>

attr

self|string attr(string $name[, mixed $value = null])
Example #1 (Set)
$doc = (new Document())->html('<div class="text-center"></div>');
$doc->attr('class', 'text-left');

Result:

<div class="text-left"></div>
Example #2 (Get)
$doc = (new Document())->html('<div class="text-center"></div>');
echo $doc->attr('text-center');

Result:

text-center

precede

self precede(string|NodeList|\DOMNode|callable $input)

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

Example
$doc = (new Document())->html('<ul><li>first</li><li>second</li></ul>');
doc->find('li')->first()->precede('<li>zeroth</li>');

Result:

<ul>
    <li>zeroth</li>
    <li>first</li>
    <li>second</li>
</ul>

clone

NodeList|\DOMNode clone()
Example
$doc = (new Document())->html('<ul><li>Item</li></ul>');
$doc->find('div')->clone()->appendTo('ul');

Result:

<ul><li>Item</li><li>Item</li></ul>

destroy

self destroy([string $selector = null])
Example
$doc = (new Document())->html('<ul><li class="first"></li><li class="second"></li></ul>');
$doc->find('.first')->destroy();

Result:

<ul><li class="second"></li></ul>

detach

NodeList detach([string $selector = null])
Example
$doc = (new Document())->html('<ul class="first"><li>Item</li></ul><ul class="second"></ul>');
$el = $doc->find('ul.first li')->detach();
$doc->first('ul.second').append($el);

Result:

<ul class="first"></ul><ul class="second"><li>Item</li></ul>

empty

self empty()
Example
$doc = (new Document())->html('<div>The quick brown fox jumps over the lazy dog</div>');
$doc->find('div')->empty();

Result:

<div></div>

hasClass

bool hasClass(string $class)
Example
$doc = (new Document())->html('<div class="text-center"></div>');
echo $doc->first('div')->hasClass('text-center');

Result:

true

html

string|self html([string|NodeList|\DOMNode|callable $input = null])
Example #1 (Set)
$doc = (new Document());
$doc->html('<div class="example"></div>');

Result:

<div class="example"></div>
Example #1 (Get)
$doc = (new Document())->html('<div class="example"></div>');
$doc->find('div')->appendWith('<span>Example!</span>');
echo $doc->html();

Result:

<div class="example"><span>Example!</span></div>

prependWith

self prependWith(string|NodeList|\DOMNode|callable $input)
Example
$doc = (new Document())->html('<div>The quick brown fox jumps over the lazy dog</div>');
$doc->find('div')->prependWith('<strong>Prepended! </strong>');

Result:

<div><strong>Prepended! </strong>The quick brown fox jumps over the lazy dog</div>

prependTo

self prependTo(string|NodeList|\DOMNode $selector)
Example
$doc = (new Document())->html('<div>The quick brown fox jumps over the lazy dog</div>');
$doc->create('<strong>Prepended! </strong>')->appendTo('div');

Result:

<div><strong>Prepended! </strong>The quick brown fox jumps over the lazy dog</div>

removeAttr

self removeAttr(string $name)
Example
$doc = (new Document())->html('<div class="first second"></div>');
$doc->find('div').removeAttr('class');

Result:

<div></div>

removeClass

self removeClass(string|callable $class)
Example
$doc = (new Document())->html('<div class="first second"></div>');
$doc->find('div').removeClass('first');

Result:

<div class="second"></div>

substituteWith

self substituteWith(string|NodeList|\DOMNode|callable $input)

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

Example
$doc = (new Document())->html('<p><b>Hello</b> <b>World!</b></p>');
$doc->find('b')->substituteWith(function($node) {
    return '<em>' . $node->text() . '</em>';
});
echo $doc->html();

Result:

<p><em>Hello</em> <em>World!</em></p>

text

string|self text([string|NodeList|\DOMNode|callable $input = null])

Get the text contents of the current set.

Example (get)
$doc = (new Document())->html('<div class="text">Hello World!</div>');
echo $doc->find('.text')->text();

Result:

Hello World!

Set the text contents for current set.

Example (set)
$doc = (new Document())->html('<div class="text"><string>The quick brown</strong> fox <em>jumps over the lazy dog</em></div>');
$doc->find('.text')->text('Hello World!');
echo $doc->html();

Result:

<div class="text">Hello World!</div>

unwrap

self 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
$doc = (new Document())->html('<div id="outer"><div id="first"/><div id="second"/></div>');
$doc->find('#first')->unwrap();

Result:

<div id="first"></div>
<div id="second"></div>

wrap

self wrap(string|NodeList|\DOMNode|callable $input)

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
$doc = (new Document())->html('<span>foo<span><span>bar</span>');
$doc->find->('span')->wrap('<div><p/></div>');

Result:

<div><p><span>foo</span></p></div>
<div><p><span>bar</span></p></div>

wrapAll

self wrapAll(string|NodeList|\DOMNode|callable $input)

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
$doc = (new Document())->html('<span>foo<span><span>bar</span>');
$doc->find->('span')->wrapAll('<div><p/></div>');

Result:

<div><p>
    <span>foo</span>
    <span>bar</span>
</p></div>

wrapInner

self wrapInner(string|NodeList|\DOMNode|callable $input)

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

Example
$doc = (new Document())->html('<span>foo<span><span>bar</span>');
$doc->find('span')->wrapInner('<b><i/></b>');

Result:

<span><b><i>foo</i></b></span>
<span><b><i>bar</i></b></span>

Traversal

add

NodeList add(string|NodeList|\DOMNode $input)

Add additional node(s) to the existing set.

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

children

NodeList children()

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

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

closest

Element|NodeList|null closest(string|NodeList|\DOMNode|callable $input)

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

Example
$nodes = $doc->find('a');
$closestAncestors = $nodes->closest('p');

contents

NodeList contents()

Return all children of each node in the current set.

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

eq

\DOMNode|null eq(int $index)

Return node in the current set at the specified index.

Example
$nodes = $doc->find('a');
$nodeAtIndexOne = $nodes->eq(1);

filter

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

Return nodes in the current set that match the input.

Example
$nodes = $doc->filter('a')
$exampleATags = $nodes->filter('[href*=https://example.org/]');

find

NodeList find(string $selector[, string $prefix = 'descendant::'])

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

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

first

mixed first()

Return the first node of the current set.

Example
$nodes = $doc->find('a');
$firstNode = $nodes->first();

has

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

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

Example
$nodes = $doc->find('a');
$anchorTags = $nodes->has('span');

is

bool is(string|NodeList|\DOMNode|callable $input)

Test if nodes from the current set match the input.

Example
$nodes = $doc->find('a');
$isAnchor = $nodes->is('[anchor]');

last

mixed last()

Return the last node of the current set.

Example
$nodes = $doc->find('a');
$lastNode = $nodes->last();

map

NodeList map(callable $function)

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

Example
$nodes = $doc->find('a');
$nodeValues = $nodes->map(function($node) {
    return $node->nodeValue;
});

following

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

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

Optionally filtered by selector.

Example
$nodes = $doc->find('a');
$follwingNodes = $nodes->following();

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.