[Sommaire] [Imprimer]

   1  <?php
   2  /*****************************************************
   3  * This file is part of Agora, web based content management system.
   4  *
   5  * Agora is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; version 2 of the License.
   8  *
   9  * Agora is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details (file "COPYING").
  13  *
  14  * Copyright © Arnaud Martin, Antoine Pitrou et Philippe Rivière.
  15  * List of authors detailed in "copyright_fr.html" file.
  16  * E-mail : agora@sig.premier-ministre.gouv.fr
  17  * Web site : http://www.agora.gouv.fr
  18  *****************************************************/
  19  // Class used to handle search results from a search query
  20  //
  21  
  22  /**
  23   * This class is designed to handle the list of search results
  24   * for a given query.
  25   *
  26   * @author Antoine Angénieux <aangenieux@clever-age.com>
  27   * @version $Revision$
  28   */
  29  class SearchResults {
  30  
  31      // {{{ properties
  32  
  33      /**
  34       * Specifies the total number of results returned by the indexer
  35       * @var     int
  36       * @access  public
  37       */
  38      var $numberOfResults;
  39  
  40      /**
  41       * Specifies the index of the first result returned by the query.
  42       * This is useful for example when querying the indexer for a
  43       * given page of results
  44       * @var     int
  45       * @access  public
  46       */
  47      var $firstResultIndex;
  48  
  49      /**
  50       * Specifies the index of the last result returned by the query.
  51       * This is useful for example when querying the indexer for a
  52       * given page of results
  53       * @var     int
  54       * @access  public
  55       */
  56      var $lastResultIndex;
  57  
  58      /**
  59       * Array of SearchResult for each result returned by the indexer
  60       * @var     array
  61       * @access  public
  62       */
  63      var $results;
  64  
  65      // }}}
  66  
  67      // {{{ constructor
  68  
  69      /**
  70       * Constructor for SearchResults. Empty for now!
  71       */
  72  	function SearchResults () {
  73          $results = array();
  74      }
  75  
  76  // }}}
  77  
  78  }
  79  ?>