Source for file OnpubQueryOptions.php

Documentation is available at OnpubQueryOptions.php

  1. <?php
  2.  
  3. /**
  4.  * Onpub database query options.
  5.  *
  6.  * @author {@link mailto:corey@onpub.com Corey H.M. Taylor}
  7.  * @copyright Onpub (TM). Copyright 2012, Onpub.com.
  8.  *  {@link http://onpub.com/}
  9.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
  10.  *  Version 2
  11.  * @package OnpubAPI
  12.  */
  13. class OnpubQueryOptions
  14. {
  15.   /**
  16.    * Default is FALSE. Set to TRUE if you would like article
  17.    * data to be included in the database query results (where applicable).
  18.    *
  19.    * @var bool 
  20.    */
  21.   public $includeArticles;
  22.   /**
  23.    * Default is FALSE.
  24.    *
  25.    * @var bool 
  26.    */
  27.   public $includeAuthors;
  28.   /**
  29.    * Default is TRUE.
  30.    *
  31.    * @var bool 
  32.    */
  33.   public $includeContent;
  34.   /**
  35.    * Default is FALSE.
  36.    *
  37.    * @var bool 
  38.    */
  39.   public $includeSections;
  40.   /**
  41.    * Default is NULL.
  42.    *
  43.    * @var string 
  44.    */
  45.   public $orderBy;
  46.   /**
  47.    * Default is NULL.
  48.    *
  49.    * @var string 
  50.    */
  51.   public $order;
  52.   /**
  53.    * Default is NULL.
  54.    *
  55.    * @var int 
  56.    */
  57.   public $rowLimit;
  58.   /**
  59.    * Default is NULL.
  60.    *
  61.    * @var DateTime 
  62.    */
  63.   public $dateAfter;
  64.   /**
  65.    * Default is NULL.
  66.    *
  67.    * @var DateTime 
  68.    */
  69.   public $dateLimit;
  70.   /**
  71.    * Default is FALSE.
  72.    *
  73.    * @var bool 
  74.    */
  75.   public $fullTextSearch;
  76.  
  77.   private $page;
  78.  
  79.   function __construct()
  80.   {
  81.     $this->includeArticles = FALSE;
  82.     $this->includeAuthors = FALSE;
  83.     $this->includeContent = TRUE;
  84.     $this->includeSections = FALSE;
  85.     $this->orderBy = NULL;
  86.     $this->order = NULL;
  87.     $this->page = NULL;
  88.     $this->rowLimit = NULL;
  89.     $this->dateAfter = NULL;
  90.     $this->dateLimit = NULL;
  91.     $this->fullTextSearch = FALSE;
  92.   }
  93.  
  94.   /**
  95.    * @return int 
  96.    */
  97.   public function getPage()
  98.   {
  99.     return $this->page;
  100.   }
  101.  
  102.   /**
  103.    * Paginate a set of rows.
  104.    *
  105.    * @param int 
  106.    * @param int 
  107.    */
  108.   public function setPage($page, $rowLimit)
  109.   {
  110.     $this->page = $page;
  111.     $this->rowLimit = $rowLimit;
  112.   }
  113. }
  114. ?>

Documentation generated on Sun, 20 May 2012 04:02:55 -0400 by phpDocumentor 1.4.4