querypath/querypath

HTML/XML querying (CSS 4 or XPath) and processing (like jQuery)

Use GravityPDF's QueryPath

QueryPath is now updated and maintained by the amazing folks at GravityPDF. https://github.com/GravityPDF/querypath. The version of QueryPath in this repository is no longer maintained. You are encouraged to use GravityPDF's version. -- Matt, Dec. 2022, _(*1)

QueryPath: Find your way.

, _(*2)

Authors: Matt Butcher (lead), Emily Brand, and many others, _(*3)

Website | API Docs | VCS and Issue Tracking | Support List | Developer List | Pear channel |, _(*4)

This package is licensed under an MIT license (COPYING-MIT.txt)., _(*5)

At A Glance

QueryPath is a jQuery-like library for working with XML and HTML documents in PHP. It now contains support for HTML5 via the HTML5-PHP project., _(*6)

Gettings Started

Assuming you have successfully installed QueryPath via Composer, you can parse documents like this:, _(*7)

require_once "vendor/autoload.php";

// HTML5 (new)
$qp = html5qp("path/to/file.html");

// Legacy HTML via libxml
$qp = htmlqp("path/to/file.html");

// XML or XHTML
$qp = qp("path/to/file.html");

// All of the above can take string markup instead of a file name:
$qp = qp("<hello><world/></hello>")

But the real power comes from chaining. Check out the example below., _(*8)

Example Usage

Say we have a document like this:, _(*9)

<?xml version="1.0"?>
<table>
  <tr id="row1">
    <td>one</td><td>two</td><td>three</td>
  </tr>
  <tr id="row2">
    <td>four</td><td>five</td><td>six</td>
  </tr>
</table>

And say that the above is stored in the variable $xml. Now we can use QueryPath like this:, _(*10)

attr('foo', 'bar');

// Print the contents of the third TD in the second row:
print qp($xml, '#row2>td:nth(3)')->text();

// Append another row to the XML and then write the
// result to standard output:
qp($xml, 'tr:last')->after('



')->writeXML();

?>

(This example is in examples/at-a-glance.php.), _(*11)

With over 60 functions and robust support for chaining, you can accomplish sophisticated XML and HTML processing using QueryPath., _(*12)

QueryPath Installers

The preferred method of installing QueryPath is via Composer., _(*13)

You can also download the package from GitHub., _(*14)

Composer (Preferred)

To add QueryPath as a library in your project, add this to the 'require' section of your composer.json:, _(*15)

{
  "require": {
    "querypath/QueryPath": ">=3.0.0"
  }
}

The run php composer.phar install in that directory., _(*16)

To stay up to date on stable code, you can use dev-master instead of >=3.0.0., _(*17)

Manual Install

You can either download a stable release from the GitHub Tags page or you can use git to clone this repository and work from the code., _(*18)

Including QueryPath

As of QueryPath 3.x, QueryPath uses the Composer autoloader if you installed with composer:, _(*19)

<?php
require 'vendor/autoload.php';
?>

Without Composer, you can include QueryPath like this:, _(*20)

<?php
require 'QueryPath/src/qp.php';
?>

QueryPath can also be compiled into a Phar and then included like this:, _(*21)

<?php
require 'QueryPath.phar';
?>

From there, the main functions you will want to use are qp() (alias of QueryPath::with()) and htmlqp() (alias of QueryPath::withHTML()). Start with the API docs., _(*22)