PHP bindings for Xapian
***********************

The PHP bindings for Xapian are packaged in the ``xapian``
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.4.22, these bindings require at least PHP 8.0.
PHP 5 is now well out of security support, while PHP 7 upstream security
support ends 2021-11-28 - if you still need to use these versions then
Xapian 1.4.21 was the last version to support them.

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 ``(int)`` to
convert to an integer, ``(string)`` to string, ``(double)``
to a floating point number.

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
and the ``clone()`` method of the ``XapianWeight``
class and subclasses is wrapped as ``clone_object()``.

The ``examples`` subdirectory contains examples showing how to use the
PHP bindings based on the simple examples from ``xapian-examples``:
`simpleindex.php8 <examples/simpleindex.php8>`_,
`simplesearch.php8 <examples/simplesearch.php8>`_,
`simpleexpand.php8 <examples/simpleexpand.php8>`_,
`simplematchdecider.php8 <examples/simplematchdecider.php8>`_.

Note that these examples are written to work with the command line (CLI)
version of the PHP interpreter, not through a webserver.  Xapian's PHP
bindings may of course also be used under CGI, Apache's modphp, ISAPI,
etc.

Installation
============

This version of the bindings only support PHP >= 8.0  If you need support
for PHP 5.x or 7.x, you'll need to use Xapian 1.4.21 or earlier instead.

If you want to install from source you'll need to `download the source
code <https://xapian.org/download>`_ if you haven't already done so.

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 ``php-config --extension-dir``.

Check that php.ini has a line like ``extension_dir = "<location reported by php-config --extension-dir>"``.


Then add this line to php.ini: ``extension=xapian``

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.

Previous versions of these bindings for PHP < 8 also required you to add
``include&nbsp;"xapian.php"`` to your PHP scripts which use Xapian, but
this is not necessary with versions which support PHP8 (1.4.22 and newer).
To write code which supports both you can use::

    if (PHP_MAJOR_VERSION < 8) include "xapian.php";

Exceptions
##########

Exceptions thrown by Xapian are translated into PHP Exception objects
which are thrown into the PHP script.

Object orientation
##################

These PHP bindings use a PHP object oriented style.

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
``unset($object);`` or ``$object = Null;``

You invoke a method on an object using ``$object->method_name()``.

Unicode Support
###############

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 `iconv function <https://secure.php.net/iconv>`_ to convert them to UTF-8 before passing them to Xapian, and when reading values back from Xapian.

Iterators
#########

Xapian's iterators (except ``XapianLatLongCoordsIterator``)
are wrapped as PHP iterators, so can be used in ``foreach``.

There's one important thing to beware of currently - the ``rewind()`` method
on ``XapianPositionIterator``, ``XapianPostingIterator``,
``XapianTermIterator`` and ``XapianValueIterator`` currently does nothing.  We
can't make it simply throw an exception, as ``foreach`` calls ``rewind()``
before iteration starts - each iterator needs to track if ``next()`` has been
called yet, and we've not yet implemented machinery for that.  This doesn't
affect the standard pattern of iterating once with ``foreach``, but if you want
to iterate a second time, you can't reuse the iterator (but it will currently
fail quietly).

You can safely call ``rewind()`` on ``XapianESetIterator`` and
``XapianMSetIterator``.

The ``current()`` method returns the result of dereferencing the iterator
in C++ (e.g. for a ``TermIterator``, it returns the term as a string - see
the section below for more details) and the ``key()`` method returns the
iterator object, which you can call other methods on, for example::

    foreach ($db->allterms_begin() as $k => $term) {
	print "{$k->get_termfreq()}\t$term\n";
    }

As well as the standard PHP iterator methods, MSetIterator and ESetIterator
also support ``prev()`` to go back one place.

Iterator dereferencing
######################

C++ iterators are often dereferenced to get information, eg
``(*it)``. With PHP these are all mapped to named methods, as
follows:

+------------------+----------------------+
| Iterator         | Dereferencing method |
+==================+======================+
| PositionIterator |   ``get_termpos()``  |
+------------------+----------------------+
| PostingIterator  |   ``get_docid()``    |
+------------------+----------------------+
| TermIterator     |   ``get_term()``     |
+------------------+----------------------+
| ValueIterator    |   ``get_value()``    |
+------------------+----------------------+
| MSetIterator     |   ``get_docid()``    |
+------------------+----------------------+
| ESetIterator     |   ``get_term()``     |
+------------------+----------------------+

Other methods, such as ``MSetIterator::get_document()``, are
available unchanged.

MSet
####

MSet objects have some additional methods to simplify access (these
work using the C++ array dereferencing):

+------------------------------------+----------------------------------------+
| Method name                        |            Explanation                 |
+====================================+========================================+
| ``get_hit(index)``                 |   returns MSetIterator at index        |
+------------------------------------+----------------------------------------+
| ``get_document_percentage(index)`` | ``convert_to_percent(get_hit(index))`` |
+------------------------------------+----------------------------------------+
| ``get_document(index)``            | ``get_hit(index)->get_document()``     |
+------------------------------------+----------------------------------------+
| ``get_docid(index)``               | ``get_hit(index)->get_docid()``        |
+------------------------------------+----------------------------------------+


Database Factory Functions
##########################


- ``Xapian::Auto::open_stub(file)`` is wrapped as ``Xapian::auto_open_stub(file)`` (now deprecated)
- ``Xapian::Chert::open()`` is wrapped as ``Xapian::chert_open()`` (now deprecated)
- ``Xapian::InMemory::open()`` is wrapped as ``Xapian::inmemory_open()`` (now deprecated)
- ``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
#########

Constants are wrapped as ``const`` members of the appropriate class.
So ``Xapian::DB_CREATE_OR_OPEN`` is available as
``Xapian::DB_CREATE_OR_OPEN``, ``Xapian::Query::OP_OR`` is
available as ``XapianQuery::OP_OR``, and so on.

Functions
#########

Non-class functions are wrapped in the natural way, so the C++
function ``Xapian::version_string`` is wrapped under the same
name in PHP.

Query
#####

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)));



MatchAll and MatchNothing
-------------------------

These are wrapped as static methods
``XapianQuery::MatchAll()`` and ``XapianQuery::MatchNothing()``.

If you want to be compatible with version 1.2.x of Xapian's PHP5 bindings, you
can continue to use ``new XapianQuery('')`` for MatchAll and
``new XapianQuery()`` for MatchNothing.


Enquire
#######

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.
