DMAbstractQuery.php

<?php
#
# dmBridge: a data access framework for CONTENTdm(R)
#
# Copyright © 2009, 2010, 2011 Board of Regents of the Nevada System of Higher
# Education, on behalf of the University of Nevada, Las Vegas
#

abstract class DMAbstractQuery {

   private $only_count = false;
   private $page = 1;
   protected $results_per_page = 20;
   private $collections = array();
   protected $results = array();
   protected $num_results = 0;
   private $objects;
   private $predicates = array();
   private $sort_fields = array();


   public function __construct() {
   }

   public function getCollections() {
      return $this->collections;
   }

   public function addCollection(DMCollection $collection) {
      $this->collections[] = $collection;
   }

   public function setCollections(array $collections) {
      foreach ($collections as $c) {
         if (!$c instanceof DMCollection) {
            throw new DMIllegalArgumentException(
               DMLocalizedString::getString("INVALID_COLLECTION"));
         }
      }
      $this->collections = $collections;
   }

   public function unsetCollections() {
      $this->collections = array();
   }

   public function onlyCount() {
      return $this->only_count;
   }

   public function getLimit() {
      return $this->results_per_page;
   }

   public function setLimit($limit) {
      $this->results_per_page = abs($limit);
   }

   public function setOnlyCount($bool) {
      $this->only_count = (bool) $bool;
   }

   public function getNumPages() {
      if ($this->getNumResultsPerPage() > 0) {
         return ceil($this->getNumResults() / $this->getNumResultsPerPage());
      }
      return 0;
   }

   public function getNumResults() {
      return $this->num_results;
   }

   protected function setNumResults($int) {
      $this->num_results = abs($int);
   }

   public function getNumResultsPerPage() {
      return $this->getLimit();
   }

   public function setNumResultsPerPage($rpp) {
      $this->setLimit($rpp);
   }

   public function addObject(DMObject $obj) {
      $this->objects[] = $obj;
   }

   public function getObjects() {
      return $this->objects;
   }

   public function getPage() {
      return $this->page;
   }

   public function setPage($int) {
      $this->page = abs((int) substr($int, 0, 8));
      if ($this->page < 1) {
         $this->page = 1;
      }
   }

   public function addPredicate(DMQueryPredicate $predicate) {
      $this->predicates[] = $predicate;
   }

   public function getPredicates($index = null) {
      if (array_key_exists($index, $this->predicates)) {
         return $this->predicates[$index];
      }
      return $this->predicates;
   }

   public function setPredicates(array $predicates) {
      $this->unsetPredicates();
      foreach ($predicates as $t) {
         if ($t instanceof DMQueryPredicate) {
            $this->addPredicate($t);
         } else {
            throw new DMIllegalArgumentException();
         }
      }
   }

   public function unsetPredicates() {
      $this->predicates = array();
   }

   public function getSortFields() {
      return $this->sort_fields;
   }

   public function setSortFields(array $fields) {
      $this->sort_fields = $fields;
   }

   public function getStart() {
      return ($this->getPage() - 1) * $this->getNumResultsPerPage();
   }

}