application/hub/main/cruncher/class_BaseHubCruncher.php

   1 <?php
   2 /**
   3  * A general hub cruncher class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseHubCruncher extends BaseHubSystem implements Updateable {
  25         /**
  26          * Version information
  27          */
  28         private $version = 'x.x';
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39         }
  40
  41         /**
  42          * Getter for version
  43          *
  44          * @return      $version        Version number of this cruncher
  45          */
  46         protected final function getVersion () {
  47                 return $this->version;
  48         }
  49
  50         /**
  51          * Setter for version
  52          *
  53          * @param       $version        Version number of this cruncher
  54          * @return      void
  55          */
  56         protected final function setVersion ($version) {
  57                 $this->version = (string) $version;
  58         }
  59
  60         /**
  61          * Updates a given field with new value
  62          *
  63          * @param       $fieldName              Field to update
  64          * @param       $fieldValue             New value to store
  65          * @return      void
  66          * @throws      DatabaseUpdateSupportException  If this class does not support database updates
  67          * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
  68          */
  69         public function updateDatabaseField ($fieldName, $fieldValue) {
  70                 // Unfinished
  71                 $this->partialStub('Unfinished!');
  72                 return;
  73         }
  74 }
  75
  76 // [EOF]
  77 ?>