class Crawler implements Countable, IteratorAggregate

Crawler eases navigation of a list of \DOMNode objects.

Methods

__construct(mixed $node = null, string $uri = null, string $baseHref = null)

No description

string
getUri()

Returns the current URI.

string
getBaseHref()

Returns base href.

clear()

Removes all the nodes.

add(DOMNodeList|DOMNode|array|string|null $node)

Adds a node to the current list of nodes.

addContent(string $content, null|string $type = null)

Adds HTML/XML content.

addHtmlContent(string $content, string $charset = 'UTF-8')

Adds an HTML content to the list of nodes.

addXmlContent(string $content, string $charset = 'UTF-8', int $options = LIBXML_NONET)

Adds an XML content to the list of nodes.

addDocument(DOMDocument $dom)

Adds a \DOMDocument to the list of nodes.

addNodeList(DOMNodeList $nodes)

Adds a \DOMNodeList to the list of nodes.

addNodes(array $nodes)

Adds an array of \DOMNode instances to the list of nodes.

addNode(DOMNode $node)

Adds a \DOMNode instance to the list of nodes.

eq(int $position)

Returns a node given its position in the node list.

array
each(Closure $closure)

Calls an anonymous function on each node of the list.

slice(int $offset, int $length = null)

Slices the list of nodes by $offset and $length.

reduce(Closure $closure)

Reduces the list of nodes by calling an anonymous function.

first()

Returns the first node of the current selection.

last()

Returns the last node of the current selection.

siblings()

Returns the siblings nodes of the current selection.

nextAll()

Returns the next siblings nodes of the current selection.

previousAll()

Returns the previous sibling nodes of the current selection.

parents()

Returns the parents nodes of the current selection.

children()

Returns the children nodes of the current selection.

string|null
attr(string $attribute)

Returns the attribute value of the first node of the list.

string
nodeName()

Returns the node name of the first node of the list.

string
text()

Returns the node value of the first node of the list.

string
html()

Returns the first node of the list as HTML.

array|Crawler
evaluate(string $xpath)

Evaluates an XPath expression.

array
extract(array $attributes)

Extracts information from the list of nodes.

filterXPath(string $xpath)

Filters the list of nodes with an XPath expression.

filter(string $selector)

Filters the list of nodes with a CSS selector.

selectLink(string $value)

Selects links by name or alt value for clickable images.

selectImage(string $value)

Selects images by alt value.

selectButton(string $value)

Selects a button by name or alt value for images.

link(string $method = 'get')

Returns a Link object for the first node in the list.

Link[]
links()

Returns an array of Link objects for the nodes in the list.

image()

Returns an Image object for the first node in the list.

Image[]
images()

Returns an array of Image objects for the nodes in the list.

form(array $values = null, string $method = null)

Returns a Form object for the first node in the list.

setDefaultNamespacePrefix(string $prefix)

Overloads a default namespace prefix to be used with XPath and CSS expressions.

registerNamespace(string $prefix, string $namespace)

No description

static string
xpathLiteral(string $s)

Converts string for XPath expressions.

DOMElement|null
getNode(int $position)

No description

int
count()

No description

getIterator()

No description

Details

at line line 62
__construct(mixed $node = null, string $uri = null, string $baseHref = null)

Parameters

mixed $node A Node to use as the base for the crawling
string $uri The current URI
string $baseHref The base href value

at line line 75
string getUri()

Returns the current URI.

Return Value

string

at line line 85
string getBaseHref()

Returns base href.

Return Value

string

at line line 93
clear()

Removes all the nodes.

at line line 109
add(DOMNodeList|DOMNode|array|string|null $node)

Adds a node to the current list of nodes.

This method uses the appropriate specialized add*() method based on the type of the argument.

Parameters

DOMNodeList|DOMNode|array|string|null $node A node

Exceptions

InvalidArgumentException when node is not the expected type

at line line 134
addContent(string $content, null|string $type = null)

Adds HTML/XML content.

If the charset is not set via the content type, it is assumed to be UTF-8, or ISO-8859-1 as a fallback, which is the default charset defined by the HTTP 1.1 specification.

Parameters

string $content A string to parse as HTML/XML
null|string $type The content type of the string

at line line 184
addHtmlContent(string $content, string $charset = 'UTF-8')

Adds an HTML content to the list of nodes.

The libxml errors are disabled when the content is parsed.

If you want to get parsing errors, be sure to enable internal errors via libxmluseinternalerrors(true) and then, get the errors via libxmlgeterrors(). Be sure to clear errors with libxmlclear_errors() afterward.

Parameters

string $content The HTML content
string $charset The charset

at line line 242
addXmlContent(string $content, string $charset = 'UTF-8', int $options = LIBXML_NONET)

Adds an XML content to the list of nodes.

The libxml errors are disabled when the content is parsed.

If you want to get parsing errors, be sure to enable internal errors via libxmluseinternalerrors(true) and then, get the errors via libxmlgeterrors(). Be sure to clear errors with libxmlclear_errors() afterward.

Parameters

string $content The XML content
string $charset The charset
int $options Bitwise OR of the libxml option constants LIBXML_PARSEHUGE is dangerous, see http://symfony.com/blog/security-release-symfony-2-0-17-released

at line line 272
addDocument(DOMDocument $dom)

Adds a \DOMDocument to the list of nodes.

Parameters

DOMDocument $dom A \DOMDocument instance

at line line 284
addNodeList(DOMNodeList $nodes)

Adds a \DOMNodeList to the list of nodes.

Parameters

DOMNodeList $nodes A \DOMNodeList instance

at line line 298
addNodes(array $nodes)

Adds an array of \DOMNode instances to the list of nodes.

Parameters

array $nodes An array of \DOMNode instances

at line line 310
addNode(DOMNode $node)

Adds a \DOMNode instance to the list of nodes.

Parameters

DOMNode $node A \DOMNode instance

at line line 339
Crawler eq(int $position)

Returns a node given its position in the node list.

Parameters

int $position The position

Return Value

Crawler

at line line 364
array each(Closure $closure)

Calls an anonymous function on each node of the list.

The anonymous function receives the position and the node wrapped in a Crawler instance as arguments.

Example:

$crawler->filter('h1')->each(function ($node, $i) {
    return $node->text();
});

Parameters

Closure $closure An anonymous function

Return Value

array An array of values returned by the anonymous function

at line line 382
Crawler slice(int $offset, int $length = null)

Slices the list of nodes by $offset and $length.

Parameters

int $offset
int $length

Return Value

Crawler

at line line 396
Crawler reduce(Closure $closure)

Reduces the list of nodes by calling an anonymous function.

To remove a node from the list, the anonymous function must return false.

Parameters

Closure $closure An anonymous function

Return Value

Crawler

at line line 413
Crawler first()

Returns the first node of the current selection.

Return Value

Crawler

at line line 423
Crawler last()

Returns the last node of the current selection.

Return Value

Crawler

at line line 435
Crawler siblings()

Returns the siblings nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException When current node is empty

at line line 451
Crawler nextAll()

Returns the next siblings nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException When current node is empty

at line line 467
Crawler previousAll()

Returns the previous sibling nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException

at line line 483
Crawler parents()

Returns the parents nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException When current node is empty

at line line 508
Crawler children()

Returns the children nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException When current node is empty

at line line 528
string|null attr(string $attribute)

Returns the attribute value of the first node of the list.

Parameters

string $attribute The attribute name

Return Value

string|null The attribute value or null if the attribute does not exist

Exceptions

InvalidArgumentException When current node is empty

at line line 546
string nodeName()

Returns the node name of the first node of the list.

Return Value

string The node name

Exceptions

InvalidArgumentException When current node is empty

at line line 562
string text()

Returns the node value of the first node of the list.

Return Value

string The node value

Exceptions

InvalidArgumentException When current node is empty

at line line 578
string html()

Returns the first node of the list as HTML.

Return Value

string The node html

Exceptions

InvalidArgumentException When current node is empty

at line line 602
array|Crawler evaluate(string $xpath)

Evaluates an XPath expression.

Since an XPath expression might evaluate to either a simple type or a \DOMNodeList, this method will return either an array of simple types or a new Crawler instance.

Parameters

string $xpath An XPath expression

Return Value

array|Crawler An array of evaluation results or a new Crawler instance

at line line 635
array extract(array $attributes)

Extracts information from the list of nodes.

You can extract attributes or/and the node value (_text).

Example:

$crawler->filter('h1 a')->extract(array('_text', 'href'));

Parameters

array $attributes An array of attributes

Return Value

array An array of extracted values

at line line 669
Crawler filterXPath(string $xpath)

Filters the list of nodes with an XPath expression.

The XPath expression is evaluated in the context of the crawler, which is considered as a fake parent of the elements inside it. This means that a child selector "div" or "./div" will match only the div elements of the current crawler, not their children.

Parameters

string $xpath An XPath expression

Return Value

Crawler

at line line 692
Crawler filter(string $selector)

Filters the list of nodes with a CSS selector.

This method only works if you have installed the CssSelector Symfony Component.

Parameters

string $selector A CSS selector

Return Value

Crawler

Exceptions

RuntimeException if the CssSelector Component is not available

Selects links by name or alt value for clickable images.

Parameters

string $value The link text

Return Value

Crawler

at line line 726
Crawler selectImage(string $value)

Selects images by alt value.

Parameters

string $value The image alt

Return Value

Crawler A new instance of Crawler with the filtered list of nodes

at line line 740
Crawler selectButton(string $value)

Selects a button by name or alt value for images.

Parameters

string $value The button text

Return Value

Crawler

Returns a Link object for the first node in the list.

Parameters

string $method The method for the link (get by default)

Return Value

Link A Link instance

Exceptions

InvalidArgumentException If the current node list is empty or the selected node is not instance of DOMElement

Returns an array of Link objects for the nodes in the list.

Return Value

Link[] An array of Link instances

Exceptions

InvalidArgumentException If the current node list contains non-DOMElement instances

at line line 802
Image image()

Returns an Image object for the first node in the list.

Return Value

Image An Image instance

Exceptions

InvalidArgumentException If the current node list is empty

at line line 822
Image[] images()

Returns an array of Image objects for the nodes in the list.

Return Value

Image[] An array of Image instances

at line line 846
Form form(array $values = null, string $method = null)

Returns a Form object for the first node in the list.

Parameters

array $values An array of values for the form fields
string $method The method for the form

Return Value

Form A Form instance

Exceptions

InvalidArgumentException If the current node list is empty or the selected node is not instance of DOMElement

at line line 872
setDefaultNamespacePrefix(string $prefix)

Overloads a default namespace prefix to be used with XPath and CSS expressions.

Parameters

string $prefix

at line line 881
registerNamespace(string $prefix, string $namespace)

Parameters

string $prefix
string $namespace

at line line 907
static string xpathLiteral(string $s)

Converts string for XPath expressions.

Escaped characters are: quotes (") and apostrophe (').

Examples: echo Crawler::xpathLiteral('foo " bar'); //prints 'foo " bar'

echo Crawler::xpathLiteral("foo ' bar");
//prints "foo ' bar"

echo Crawler::xpathLiteral('a\'b"c');
//prints concat('a', "'", 'b"c')

Parameters

string $s String to be escaped

Return Value

string Converted string

at line line 1051
DOMElement|null getNode(int $position)

Parameters

int $position

Return Value

DOMElement|null

at line line 1061
int count()

Return Value

int

at line line 1069
ArrayIterator|DOMElement[] getIterator()

Return Value

ArrayIterator|DOMElement[]