QueryPath.php

Classes

Package: \Default
See also: The QueryPath home page.; An online version of the API docs.; For how-tos and examples.

Tags

file	The Query Path package provides tools for manipulating a structured document. Typically, the sort of structured document is one using a Document Object Model (DOM). The two major DOMs are the XML DOM and the HTML DOM. Using Query Path, you can build, parse, search, and modify DOM documents. To use QueryPath, only one file must be imported: qp.php. This file defines the `qp()` function, and also registers an autoloader if necessary. Standard usage:
code	<?php require 'qp.php'; $xml = '<?xml version="1.0"?>'; // Procedural call a la jQuery: $qp = qp($xml, '#myID'); $qp->append('')->writeHTML(); // Object-oriented version with a factory: $qp = QueryPath::with($xml)->find('#myID') $qp->append('')->writeHTML(); ?> <?xml version="1.0"?>
endcode	The above would print (formatted for readability): Discovering the Library To gain familiarity with QueryPath, the following three API docs are the best to start with: qp(): This function constructs new queries, and is the starting point for manipulating a document. htmlqp() is an alias tuned for HTML documents (especially old HTML), and QueryPath::with(), QueryPath::withXML() and QueryPath::withHTML() all perform a similar role, but in a purely object oriented way. QueryPath: This is the top-level class for the library. It defines the main factories and some useful functions. QueryPath::Query: This defines all of the functions in QueryPath. When working with HTML and XML, the QueryPath::DOMQuery is the actual implementation that you work with. Included with the source code for QueryPath is a complete set of unit tests as well as some example files. Those are good resources for learning about how to apply QueryPath's tools. The full API documentation can be generated from these files using Doxygen, or you can view it online at http://api.querypath.org. If you are interested in building extensions for QueryPath, see the QueryPath and QueryPath::Extension classes. There you will find information on adding your own tools to QueryPath. QueryPath also comes with a full CSS 3 selector implementation (now with partial support for the current draft of the CSS 4 selector spec). If you are interested in reusing that in other code, you will want to start with QueryPath::CSS::EventHandler.php, which is the event interface for the parser. All of the code in QueryPath is licensed under an MIT-style license license. All of the code is Copyright, 2012 by Matt Butcher.
author	M Butcher
license	MIT
copyright	Copyright (c) 2009-2012, Matt Butcher.
version	-UNSTABLE% (3.x.x)