git.roojs.org Git - web.mtrack/blob - inc/lib/Zend/Search/Lucene/Index/DocsFilter.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Search_Lucene
  17  * @subpackage Index
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id: DocsFilter.php 16971 2009-07-22 18:05:45Z mikaelkael $
  21  */
  22
  23
  24 /**
  25  * A Zend_Search_Lucene_Index_DocsFilter is used to filter documents while searching.
  26  *
  27  * It may or _may_not_ be used for actual filtering, so it's just a hint that upper query limits
  28  * search result by specified list.
  29  *
  30  * @category   Zend
  31  * @package    Zend_Search_Lucene
  32  * @subpackage Index
  33  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  34  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  35  */
  36 class Zend_Search_Lucene_Index_DocsFilter
  37 {
  38     /**
  39      * Set of segment filters:
  40      *  array( <segmentName> => array(<docId> => <undefined_value>,
  41      *                                <docId> => <undefined_value>,
  42      *                                <docId> => <undefined_value>,
  43      *                                ...                          ),
  44      *         <segmentName> => array(<docId> => <undefined_value>,
  45      *                                <docId> => <undefined_value>,
  46      *                                <docId> => <undefined_value>,
  47      *                                ...                          ),
  48      *         <segmentName> => array(<docId> => <undefined_value>,
  49      *                                <docId> => <undefined_value>,
  50      *                                <docId> => <undefined_value>,
  51      *                                ...                          ),
  52      *         ...
  53      *       )
  54      *
  55      * @var array
  56      */
  57     public $segmentFilters = array();
  58 }
  59