The PHP bindings for Xapian are packaged in the
extension. The PHP API provided by this extension largely follows Xapian's C++
API. This document lists the differences and additions.
As of Xapian version 1.1.0, these bindings require PHP5 (PHP4 is no longer supported). PHP7 is not yet supported because SWIG doesn't yet support it.
PHP strings, arrays, etc., are converted automatically to and from the
corresponding C++ types in the bindings, so generally you can pass arguments as
you would expect. One thing to be aware of though is that SWIG implements
dispatch functions for overloaded methods based on the types of the parameters,
so you can't always pass in a string containing a number (e.g.
"42") where a number is expected as you usually can in PHP.
You need to
explicitly convert to the type required - e.g. use
convert to an integer,
(string) to string,
to a floating point number.
With version 1.2.6 and later, you can subclass Xapian classes in PHP and virtual methods defined in PHP are called from C++ in the way you'd expect.
PHP has a lot of reserved words of various sorts, which sadly clash with common
method names. Because of this
empty() methods of various
container-like classes are wrapped as
is_empty() for PHP
clone() method of the
class and subclasses is wrapped as
examples subdirectory contains examples showing how to use the
PHP bindings based on the simple examples from
Assuming you have a suitable version of PHP installed, running
configure will automatically enable the PHP bindings, and
make install will install the extension shared library in
the location reported by
Check that php.ini has a line like
"<location reported by php-config --extension-dir>".
Then add this line to php.ini:
extension = xapian.so (or
whatever the library is called - not all UNIX systems use
as the extension, and MS Windows uses
If you're using PHP as a webserver module (e.g. mod_php with Apache), you may need to restart the webserver for this change to take effect.
You also need to add
to your PHP scripts which use Xapian in order to get the PHP class wrappers.
Exceptions thrown by Xapian are translated into PHP Exception objects which are thrown into the PHP script.
As of Xapian 0.9.7, the PHP bindings use a PHP object oriented style.
In order to construct an object, use
$object = new XapianClassName(...);. Objects are destroyed
when they go out of scope - to explicitly destroy an object you can use
$object = Null;
You invoke a method on an object using
In Xapian 1.0.0 and later, the Xapian::Stem, Xapian::QueryParser, and
Xapian::TermGenerator classes all assume text is in UTF-8. If you want
to index strings in a different encoding, use the PHP
to convert them to UTF-8 before passing them to Xapian, and
when reading values back from Xapian.
All iterators support
to move through and test iterators (as for all language bindings).
MSetIterator and ESetIterator also support
In C++, trying to dereference or advance an iterator which is at its end point is undefined behaviour and should be avoided, and currently the PHP wrappers around the Xapian iterator classes inherit these semantics. The plan is to wrap these PHP iterators (see ticket#520).
C++ iterators are often dereferenced to get information, eg
(*it). With PHP these are all mapped to named methods, as
Other methods, such as
MSet objects have some additional methods to simplify access (these work using the C++ array dereferencing):
|returns MSetIterator at index|
Xapian::Auto::open_stub(file)is wrapped as
Xapian::Brass::open()is wrapped as
Xapian::Chert::open()is wrapped as
Xapian::Flint::open()is wrapped as
Xapian::InMemory::open()is wrapped as
Xapian::Remote::open(...)is wrapped as
Xapian::remote_open(...)(both the TCP and "program" versions are wrapped - the SWIG wrapper checks the parameter list to decide which to call).
Xapian::Remote::open_writable(...)is wrapped as
Xapian::remote_open_writable(...)(both the TCP and "program" versions are wrapped - the SWIG wrapper checks the parameter list to decide which to call).
Constants are wrapped as
const members of the appropriate class.
Xapian::DB_CREATE_OR_OPEN is available as
XapianQuery::OP_OR, and so on.
Non-class functions are wrapped in the natural way, so the C++
Xapian::version_string is wrapped under the same
name in PHP.
In C++ there's a Xapian::Query constructor which takes a query operator and start/end iterators specifying a number of terms or queries, plus an optional parameter. In PHP, this is wrapped to accept an array listing the terms and/or queries (you can specify a mixture of terms and queries if you wish) For example:
$subq = new XapianQuery(XapianQuery::OP_AND, "hello", "world"); $q = new XapianQuery(XapianQuery::OP_AND, array($subq, "foo", new XapianQuery("bar", 2)));
In Xapian 1.3.0 and later, these are wrapped as static methods
If you want to be compatible with earlier versions, you can continue to use
new XapianQuery('') for MatchAll and
new XapianQuery() for MatchNothing.
There is an additional method
get_matching_terms() which takes
an MSetIterator and returns a list of terms in the current query which
match the document given by that iterator. You may find this
more convenient than using the TermIterator directly.