mima/dom-navigator

Simple wrapper for find elements in DOMNode. Adds XPath, Selector (like jQuery) mechanism to find elements, allow create own implementation.

PHP DOMNavigator

, _(*1)

About library

The library is a wrapper for the implementation of DOM in php. Designed for easy loading html document, parse it. It allows you to implement your own algorithm search elements., _(*2)

Documentation

• Installation
• Use Navigator
• Create custom Finder
• Create custom Loader
• Use CompositeLoader

Installation

Run command:, _(*3)

composer require mima/dom-navigator

Add dependency on your composer.json:, _(*4)

{
    "require": {
        "mima/dom-navigator": "@stable"
    }
}

Use Navigator

For beginning usage navigator need create an instance of DOMNavigator\Navigator class:, _(*5)

use DOMNavigator\Navigator;
use DOMNavigator\Loader\StringLoader;
use DOMNavigator\Finder\XPathFinder;

$loader = new StringLoader();
$finder = new XPathFinder();

$navigator = new Navigator($loader, $finder);

Before search in document need load document:, _(*6)

// For load HTML document call:
$navigator->loadHTML($htmlContent);

// or call next method for load XML document:
$navigator->loadXML($xmlContent);

When you call method loadHTML or loadXML, navigator try to load DOMDocument with help DOMNavigator\Loader\StringLoader (in this example). After loading you may use navigate method for search elements in document., _(*7)

// return \DOMNodeList with list of found elements
$addressNodes = $navigator->navigate("//div[@id='address']");

Navigate method always return \DOMNodeList. It is possible to search in the context of an element:, _(*8)

// $addresNodes is a list of element from previous example
$cityNodes = $navigator->navigate("*[@id='city']", $addressNodes->item(0));

If you want find out number of found elements, follow to this example:, _(*9)

if ($cityNodes->length > 0) {
    ...
}

Create custom Finder

All finders need implement interface DOMNavigator\Finder\FinderInterface., _(*10)

Create custom Loader

All loaders need implement DOMNavigator\Finder\LoaderInterface., _(*11)

Use CompositeLoader

If you are not sure of the source through the document, you can use CompositeLoader:, _(*12)

use DOMNavigator\Loader\CompositeLoader;
use DOMNavigator\Loader\URLLoader;
use DOMNavigator\Loader\FileLoader;
use DOMNavigator\Loader\StringLoader;


$stringLoader = new StringLoader();
$urlLoader = new URLLoader($stringLoader);
$fileLoader = new FileLoader();

// set loaders with construct
$compositeLoader = new CompositeLoader([$stringLoader, $urlLoader]);

// set loader with method
$compositeLoader->addLoader($fileLoader);

The next step is assigning the loader in the navigator:, _(*13)

// as first argument in constructor
$navigator = new Navigator($compositeLoader, $finder);

// or using a special method
$navigator->setLoader($compositeLoader);