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                 // Set part description
  52                 $this->setObjectDescription("Update criteria class");
  53
  54                 // Create unique ID number
  55                 $this->generateUniqueId();
  56
  57                 // Clean up a little
  58                 $this->removeNumberFormaters();
  59                 $this->removeSystemArray();
  60         }
  61
  62         /**
  63          * Create an instance of this class
  64          *
  65          * @return      $criteriaInstance       An instance of this criteria
  66          */
  67         public final static function createUpdateCriteria () {
  68                 // Get a new instance
  69                 $criteriaInstance = new UpdateCriteria();
  70
  71                 // Return this instance
  72                 return $criteriaInstance;
  73         }
  74
  75         /**
  76          * Add criteria
  77          *
  78          * @param       $criteriaKey    Criteria key
  79          * @param       $criteriaValue  Criteria value
  80          * @return      void
  81          */
  82         public function addCriteria ($criteriaKey, $criteriaValue) {
  83                 $this->updateCriteria[$criteriaKey] = $criteriaValue;
  84         }
  85
  86         /**
  87          * Add configured criteria
  88          *
  89          * @param       $criteriaKey    Criteria key
  90          * @param       $configEntry    Configuration entry
  91          * @return      void
  92          */
  93         public function addConfiguredCriteria ($criteriaKey, $configEntry) {
  94                 // Add the configuration entry as a criteria
  95                 $value = $this->getConfigInstance()->readConfig($configEntry);
  96                 $this->addCriteria($criteriaKey, $value);
  97         }
  98
  99         /**
 100          * Getter for update criteria array
 101          *
 102          * @return      $updateCriteria         Array holding the update criteria
 103          */
 104         public final function getUpdateCriteria () {
 105                 return $this->updateCriteria;
 106         }
 107 }
 108
 109 // [EOF]
 110 ?>