inc/main/classes/criteria/update/class_UpdateCriteria.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Criteria\Update;
   4
   5 // Import framework stuff
   6 use CoreFramework\Criteria\BaseCriteria;
   7 use CoreFramework\Criteria\Local\LocalUpdateCriteria;
   8
   9 /**
  10  * Search criteria for e.g. searching in databases. Do not use this class if
  11  * you are looking for a ship or company, or what ever. Instead use this class
  12  * for looking in storages like the database.
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class UpdateCriteria extends BaseCriteria implements LocalUpdateCriteria {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42         }
  43
  44         /**
  45          * Create an instance of this class
  46          *
  47          * @return      $criteriaInstance       An instance of this criteria
  48          */
  49         public static final function createUpdateCriteria () {
  50                 // Get a new instance
  51                 $criteriaInstance = new UpdateCriteria();
  52
  53                 // Return this instance
  54                 return $criteriaInstance;
  55         }
  56
  57         /**
  58          * Getter for update criteria array
  59          *
  60          * @return      $updateCriteria         Array holding the update criteria
  61          */
  62         public final function getUpdateCriteria () {
  63                 return $this->getCriteriaArray();
  64         }
  65
  66 }