API Documentation

Search/Lucene/Index/DocsFilter.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Index  
version
$Id: DocsFilter.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Search_Lucene_Index_DocsFilter

A Zend_Search_Lucene_Index_DocsFilter is used to filter documents while searching.

It may or may_not be used for actual filtering, so it's just a hint that upper query limits search result by specified list.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Index  

Properties

Propertypublicarray  $segmentFilters= 'array'

Set of segment filters: array( <segmentName> => array(<docId> => <undefined_value>, <docId> => <undefined_value>, <docId> => <undefined_value>, ... ), <segmentName> => array(<docId> => <undefined_value>, <docId> => <undefined_value>, <docId> => <undefined_value>, ... ), <segmentName> => array(<docId> => <undefined_value>, <docId> => <undefined_value>, <docId> => <undefined_value>, ... ), ...

)

Default valuearrayDetails
Type
array
Documentation was generated by DocBlox 0.13.3.