inc/classes/main/criteria/class_UpdateCriteria.php

   1 <?php
   2 /**
   3  * Search criteria for e.g. searching in databases. Do not use this class if
   4  * you are looking for a ship or company, or what ever. Instead use this class
   5  * for looking in storages like the database.
   6  *
   7  * @author              Roland Haeder <webmaster@ship-simu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.ship-simu.org
  12  *
  13  * This program is free software: you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation, either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  25  */
  26 class UpdateCriteria extends BaseFrameworkSystem implements LocalUpdateCriteria {
  27         /**
  28          * Criteria to handle
  29          */
  30         private $updateCriteria = array();
  31
  32         /**
  33          * Limitation for the update
  34          */
  35         private $limit = 0;
  36
  37         /**
  38          * Skip these entries before using them
  39          */
  40         private $skip = 0;
  41
  42         /**
  43          * Protected constructor
  44          *
  45          * @return      void
  46          */
  47         protected function __construct () {
  48                 // Call parent constructor
  49                 parent::__construct(__CLASS__);
  50
  51                 // Clean up a little
  52                 $this->removeNumberFormaters();
  53                 $this->removeSystemArray();
  54         }
  55
  56         /**
  57          * Create an instance of this class
  58          *
  59          * @return      $criteriaInstance       An instance of this criteria
  60          */
  61         public final static function createUpdateCriteria () {
  62                 // Get a new instance
  63                 $criteriaInstance = new UpdateCriteria();
  64
  65                 // Return this instance
  66                 return $criteriaInstance;
  67         }
  68
  69         /**
  70          * Add criteria
  71          *
  72          * @param       $criteriaKey    Criteria key
  73          * @param       $criteriaValue  Criteria value
  74          * @return      void
  75          */
  76         public function addCriteria ($criteriaKey, $criteriaValue) {
  77                 $this->updateCriteria[$criteriaKey] = $criteriaValue;
  78         }
  79
  80         /**
  81          * Add configured criteria
  82          *
  83          * @param       $criteriaKey    Criteria key
  84          * @param       $configEntry    Configuration entry
  85          * @return      void
  86          */
  87         public function addConfiguredCriteria ($criteriaKey, $configEntry) {
  88                 // Add the configuration entry as a criteria
  89                 $value = $this->getConfigInstance()->readConfig($configEntry);
  90                 $this->addCriteria($criteriaKey, $value);
  91         }
  92
  93         /**
  94          * Getter for update criteria array
  95          *
  96          * @return      $updateCriteria         Array holding the update criteria
  97          */
  98         public final function getUpdateCriteria () {
  99                 return $this->updateCriteria;
 100         }
 101 }
 102
 103 // [EOF]
 104 ?>