Crawler

__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

string getUri()

Returns the current URI.

Return Value

string

string getBaseHref()

Returns base href.

Return Value

string

clear()

Removes all the nodes.

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

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

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

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

addDocument(DOMDocument $dom)

Adds a \DOMDocument to the list of nodes.

Parameters

DOMDocument

$dom

A \DOMDocument instance

addNodeList(DOMNodeList $nodes)

Adds a \DOMNodeList to the list of nodes.

Parameters

DOMNodeList

$nodes

A \DOMNodeList instance

addNodes(array $nodes)

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

Parameters

array

$nodes

An array of \DOMNode instances

addNode(DOMNode $node)

Adds a \DOMNode instance to the list of nodes.

Parameters

DOMNode

$node

A \DOMNode instance

Crawler eq(int $position)

Returns a node given its position in the node list.

Parameters

int

$position

The position

Return Value

Crawler

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

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

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

Parameters

int	$offset
int	$length

Return Value

Crawler

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

Crawler first()

Returns the first node of the current selection.

Return Value

Crawler

Crawler last()

Returns the last node of the current selection.

Return Value

Crawler

Crawler siblings()

Returns the siblings nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException

When current node is empty

Crawler nextAll()

Returns the next siblings nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException

When current node is empty

Crawler previousAll()

Returns the previous sibling nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException

Crawler parents()

Returns the parents nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException

When current node is empty

Crawler children()

Returns the children nodes of the current selection.

Return Value

Crawler

Exceptions

InvalidArgumentException

When current node is empty

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

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

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

string html()

Returns the first node of the list as HTML.

Return Value

string

The node html

Exceptions

InvalidArgumentException

When current node is empty

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

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

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

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

Crawler selectLink(string $value)

Selects links by name or alt value for clickable images.

Parameters

string

$value

The link text

Return Value

Crawler

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

Crawler selectButton(string $value)

Selects a button by name or alt value for images.

Parameters

string

$value

The button text

Return Value

Crawler

Link link(string $method = 'get')

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

Link[] links()

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

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

Image[] images()

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

Return Value

Image[]

An array of Image instances

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

setDefaultNamespacePrefix(string $prefix)

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

Parameters

string

$prefix

registerNamespace(string $prefix, string $namespace)

Parameters

string	$prefix
string	$namespace

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

DOMElement|null getNode(int $position)

Parameters

int

$position

Return Value

DOMElement|null

int count()

Return Value

int

ArrayIterator|DOMElement[] getIterator()

Return Value

ArrayIterator|DOMElement[]