Zend_Search_Lucene is a general purpose text search engine written entirely in PHP 5. Since it stores its index on the filesystem and does not require a database server, it can add search capabilities to almost any PHP-driven website. Zend_Search_Lucene supports the following features:
Ranked searching - best results returned first
Many powerful query types: phrase queries, wildcard queries, proximity queries, range queries and more 
Search by specific field (e.g., title, author, contents)
Previous Zend_Search_Lucene implementations support the Lucene 1.9 index format.
Currently any index created using these versions is automatically upgraded to Lucene 2.1 format after the Zend_Search_Lucene update and will not be compatible with previous Zend_Search_Lucene versions.
Zend_Search_Lucene operates with documents as atomic objects for indexing. A document is divided into named fields, and fields have content that can be searched.
A document is represented by the Zend_Search_Lucene_Document class, and this objects of this class contain instances of Zend_Search_Lucene_Field that represent the fields on the document.
It is important to note that any information can be added to the index. Application-specific information or metadata can be stored in the document fields, and later retrieved with the document during search.
It is the responsibility of your application to control the indexer. This means that data can be indexed from any source that is accessible by your application. For example, this could be the filesystem, a database, an HTML form, etc.
Zend_Search_Lucene_Field class provides several static methods to create fields with
addField(Zend_Search_Lucene_Field::Keyword('doctype', 'autogenerated')); // Field is not tokenized nor indexed, but is stored in the index. $doc->addField(Zend_Search_Lucene_Field::UnIndexed('created', time())); // Binary String valued Field that is not tokenized nor indexed, // but is stored in the index. $doc->addField(Zend_Search_Lucene_Field::Binary('icon', $iconData)); // Field is tokenized and indexed, and is stored in the index. $doc->addField(Zend_Search_Lucene_Field::Text('annotation', 'Document annotation text')); // Field is tokenized and indexed, but is not stored in the index. $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', 'My document content'));
Each of these methods (excluding the
Zend_Search_Lucene_Field::Binary() method) has an optional
$encoding parameter for specifying input data encoding.
Encoding may differ for different documents as well as for different fields within one document:
addField(Zend_Search_Lucene_Field::Text('title', $title, 'iso-8859-1')); $doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $contents, 'utf-8'));
If encoding parameter is omitted, then the current locale is used at processing time. For example:
Fields are always stored and returned from the index in UTF-8 encoding. Any required conversion to UTF-8 happens automatically.
Text analyzers (see below) may also convert text to some other encodings. Actually, the default analyzer converts text to 'ASCII//TRANSLIT' encoding. Be careful, however; this translation may depend on current locale.
Fields' names are defined at your discretion in the
Java Lucene uses the 'contents' field as a default field to search. Zend_Search_Lucene searches through all fields by default, but the behavior is configurable. See the "Default search field" chapter for details.
Keyword fields are stored and indexed, meaning that they can be searched as well
as displayed in search results. They are not split up into separate words by tokenization.
Enumerated database fields usually translate well to Keyword fields in Zend_Search_Lucene.
UnIndexed fields are not searchable, but they are returned with search hits. Database
timestamps, primary keys, file system paths, and other external identifiers are good
candidates for UnIndexed fields.
Binary fields are not tokenized or indexed, but are stored for retrieval with search hits.
They can be used to store any data encoded as a binary string, such as an image icon.
Text fields are stored, indexed, and tokenized. Text fields are appropriate for storing
information like subjects and titles that need to be searchable as well as returned with
UnStored fields are tokenized and indexed, but not stored in the index. Large amounts of
text are best indexed using this type of field. Storing data creates a larger index on
disk, so if you need to search but not redisplay the data, use an UnStored field.
UnStored fields are practical when using a Zend_Search_Lucene index in
combination with a relational database. You can index large data fields with UnStored
fields for searching, and retrieve them from your relational database by using a separate
field as an identifier.
Zend_Search_Lucene offers a HTML parsing feature. Documents can be created directly from a HTML file or string:
addDocument($doc); ... $doc = Zend_Search_Lucene_Document_Html::loadHTML($htmlString); $index->addDocument($doc);
Zend_Search_Lucene_Document_Html class uses the
DOMDocument::loadHTMLFile() methods to parse the source HTML, so it doesn't need HTML to be well formed or
to be XHTML. On the other hand, it's sensitive to the encoding specied by the "meta http-equiv" header tag.
Zend_Search_Lucene_Document_Html class recognizes document title, body and document header meta tags.
The 'title' field is actually the /html/head/title value. It's stored within the index, tokenized and available for search.
The 'body' field is the actual body content of the HTML file or string. It doesn't include scripts, comments or attributes.
loadHTMLFile() methods of
also have second optional argument. If it's set to true, then body content is also stored within index and can
be retrieved from the index. By default, the body is tokenized and indexed, but not stored.
Other document header meta tags produce additional document fields. The field 'name' is taken from 'name' attribute, and the 'content' attribute populates the field 'value'. Both are tokenized, indexed and stored, so documents may be searched by their meta tags (for example, by keywords).
Parsed documents may be augmented by the programmer with any other field:
addField(Zend_Search_Lucene_Field::UnIndexed('created', time())); $doc->addField(Zend_Search_Lucene_Field::UnIndexed('updated', time())); $doc->addField(Zend_Search_Lucene_Field::Text('annotation', 'Document annotation text')); $index->addDocument($doc);
Document links are not included in the generated document, but may be retrieved with
getLinks(); $headerLinksArray = $doc->getHeaderLinks();