DOMInspector
PHP >= 5.4, (*1)
, (*2)
, (*3)
The DOMInspector provides PHP methods for traversing and inspecting nodes in HTML markup., (*4)
Installation
Install using composer:, (*5)
composer require gwa/dom-inspector
Example Usage
Consider the following markup in the variable $markup:, (*6)
<select name="fruit" class="big">
<option value="1">apples</option>
<option value="2" selected>oranges</option>
<option value="3">pears</option>
<option value="4">kiwis</option>
</select>
In our unit tests we want to inspect the structure of the HTML., (*7)
// Create an Inspector instance, passing the markup.
$inspector = new \Gwa\DOMInspector\Inspector($markup);
The inspector represents a node that contains the nodes in the markup passed into it., (*8)
We expect there should be single child node, the select element., (*9)
// (We are using the PHPUnit test framework.)
// Test that there is one node
$this->assertEquals(1, $inspector->children()->count());
$select = $inspector->children()->get(0);
// Test the "tag name" of the first node
$this->assertEquals('select', $select->tagname());
// Test that the select has the class `big`
$this->assertTrue($select->hasClass('big'));
// Test the `name` attribute value
$this->assertEquals('fruit', $select->attr('name'));
The select element should expose four option nodes., (*10)
$this->assertTrue($select->contains(4, 'option'));
$this->assertEquals(4, $select->children()->count());
Selectors
A selector is a string with one of the following formats:, (*11)
tag
.classname
#id
tag.classname
tag#id
tag#id.classname
Methods
Inspector / Node
find($selector) NodeList
Returns a NodeList containing all child nodes that match the selector., (*12)
children($selector = null) NodeList
Returns a NodeList containing all direct child nodes, or a single Node if an numeric index is specified, or filtered nodes if a selector string is passed., (*13)
// return NodeList containing all LIs
$inspector->find('ul')->children();
// return NodeList containing second LI
$inspector->find('ul')->children(1);
// return NodeList containing all LIs with class 'active'
$inspector->find('ul')->children('.active');
tagname() string
Returns the tag name of the node., (*14)
id() string|null
Returns the id attribute value of the node., (*15)
attr($attr) string|null
Returns the value of an attribute of the node., (*16)
html() string
Returns the "outer" HTML value of the node., (*17)
text() string
Returns the text value of the node., (*18)
For complex text, structure (p and br) is maintained. For example with the following markup, (*19)
<article>
<p>
This is some <strong>text</strong> with <em>inline styles</em>
and a <a href="http://www.example.com">link</a>.<BR/>
With a line break.
</p>
<p>
A second paragraph.
</p>
</article>
the text method, (*20)
$inspector->children('article')->first()->text();
returns, (*21)
This is some text with inline styles and a link.
With a line break.
A second paragraph.
hasClass($cssclass) boolean
Assert whether the node has the class passed as an attribute., (*22)
contains($selector) boolean
Assert whether the node has one or more direct child nodes that match the selector., (*23)
containsDeep($selector) boolean
Assert whether the node contains one or more child nodes that match the selector., (*24)
containsNum($selector) boolean
Assert whether the node has a certain number of direct child nodes that match the selector., (*25)
containsNumDeep($selector) boolean
Assert whether the node contains a certain number of child nodes that match the selector., (*26)
NodeList
The NodeList is a flat list of nodes. It is iterable, so you can do this:, (*27)
$blanks = [];
$links = $inspector->find('a');
foreach ($links as $link) {
if ($link->attr('target') === '_blank') {
$blanks[] = $link;
}
}
count() integer
Returns the number of nodes in the list., (*28)
get($index) Node
Returns the Node at the zero-based index specified., (*29)
first() Node
Returns the first Node in the list., (*30)
last() Node
Returns the last Node in the list., (*31)
filter() NodeList
Returns a new NodeList created by filtering the current list using the selector passed., (*32)
Tests
Run tests using phpunit., (*33)
$ vendor/bin/phpunit -c tests/phpunit.xml tests
Wallogit.com
