API Documentation

\QueryPathExtension

A Extension is a tool that extends the capabilities of a Query object.

Extensions to QueryPath should implement the Extension interface. The only requirement is that the extension provide a constructor that takes a Query object as a parameter.

Here is an example QueryPath extension:

Summary

Methods

Constants

__construct()

No constants found

No protected methods found

N/A

No private methods found

N/A

Tags

code

<?php class StubExtensionOne implements \QueryPath\Extension { private $qp = NULL; public function __construct(\QueryPath\Query $qp) {

$this->qp = $qp;

}

public function stubToe() {

$this->qp->find(':root')->append('<toe/>')->end();
return $this->qp;

} } ?>

<?php QueryPath::enable('StubExtension'); ?>

endcode

In this example, the StubExtensionOne class implements Extension. The constructor stores a local copyof the Query object. This is important if you are planning on fully integrating with QueryPath's Fluent Interface.

Finally, the stubToe() function illustrates how the extension makes use of QueryPath's Query object internally, and remains part of the fluent interface by returning the $qp object.

Enabling an Extension

To enable an extension, call the QueryPath::enable() method.

More complex management of extensions can be accomplished with the QueryPath::ExtensionRegistry class.

How is a QueryPath extension called?

QueryPath extensions are called like regular QueryPath functions. For example, the extension above can be called like this: qp('some.xml')->stubToe(); // or QueryPath::with('some.xml')->stubToe(); Since it returns the Query ($qp) object, chaining is supported: print qp('some.xml')->stubToe()->xml(); When you write your own extensions, anything that does not need to return a specific value should return the Query object. Between that and the extension registry, this will provide the best developer experience.

ingroup

querypath_extensions

__construct()

__construct(\QueryPath\Query  $qp)

Parameters

\QueryPath\Query

$qp