billortell / querypath

QueryPath is a PHP library for manipulating XML and HTML. It is designed to work not only with local files, but also with web services and database resources.

QueryPath: Find your way.

New development is happening on the 3.x branch.

Authors: Matt Butcher (lead), Emily Brand, and others

Website | API Docs | VCS and Issue Tracking | Support List | Developer List | Pear channel |

This package is licensed under the GNU LGPL 2.1 (COPYING-LGPL.txt) or, at your choice, an MIT-style license (COPYING-MIT.txt). The licenses should have been distributed with this library.

QueryPath Installers

The following packages of QueryPath are available:

• PEAR package (pear install querypath/QueryPath): Installs the library and documentation.
• Download from the GitHub Tags page.
• Composer: Add this to the 'require' section of your composer.json:

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

Or if you prefer PEAR:

$ pear channel-discover pear.querypath.org
$ pear install querypath/QueryPath

Downloads (for manual installation)

• Phar (QueryPath-VERSION.phar): This is a Phar package which can be used as-is. Its size has been minimized by stripping comments. It is designed for direct inclusion in PHP 5.3 applications.
• Minimal (QueryPath-VERSION-minimal.tgz): This contains only the QueryPath library, with no documentation or additional build environment. It is designed for production systems.
• Full (QueryPath-VERSION.tgz): This contains QueryPath, its unit tests, its documentation, examples, and all supporting material. If you are starting with QueryPath, this might be the best package.
• Docs (QueryPath-VERSION-docs.tgz): This package contains only the documentation for QueryPath. Generally, this is useful to install as a complement to the minimal package.
• Git repository clone: You can always clone this repository and work from that code.

If in doubt, you probably want the PEAR version or the Full package.

Including QueryPath

If you installed QueryPath as a PEAR package, use it like this:

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

From the Full Install:

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

With the Phar archive, you can include QueryPath like this:

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

Unfortunately, in the 2.1 branch of QueryPath, the Composer include is:

<?php
require 'vendor/querypath/QueryPath/src/QueryPath/QueryPath.php';
?>

The next major release of QueryPath will support Composer autoloading.

From there, the main functions you will want to use are qp() and htmlqp(). Start with the API docs.