wcfsetup/install/files/lib/system/search/ISearchEngine.class.php

   1 <?php
   2 namespace wcf\system\search;
   3 use wcf\system\database\util\PreparedStatementConditionBuilder;
   4
   5 /**
   6  * Default interface for search engines.
   7  *
   8  * @author      Alexander Ebert
   9  * @copyright   2001-2014 WoltLab GmbH
  10  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  11  * @package     com.woltlab.wcf
  12  * @subpackage  system.search
  13  * @category    Community Framework
  14  */
  15 interface ISearchEngine {
  16         /**
  17          * Searches for the given string and returns the data of the found messages.
  18          *
  19          * @param       string                                                          $q
  20          * @param       array                                                           $objectTypes
  21          * @param       boolean                                                         $subjectOnly
  22          * @param       \wcf\system\database\util\PreparedStatementConditionBuilder     $searchIndexCondition
  23          * @param       array                                                           $additionalConditions
  24          * @param       string                                                          $orderBy
  25          * @param       integer                                                         $limit
  26          * @return      array
  27          */
  28         public function search($q, array $objectTypes, $subjectOnly = false, PreparedStatementConditionBuilder $searchIndexCondition = null, array $additionalConditions = array(), $orderBy = 'time DESC', $limit = 1000);
  29 }