inc/classes/main/stacker/class_

   1 <?php
   2 /**
   3  * A ??? Stacker class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core 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 ???Stacker extends BaseStacker implements Stackable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of the class Stacker and prepares it for usage
  37          *
  38          * @param       $appInstance    A manageable application
  39          * @return      $stackerInstance        An instance of ???Stacker
  40          */
  41         public final static function create???Stacker (ManageableApplication $appInstance) {
  42                 // Get a new instance
  43                 $stackerInstance = new ???Stacker();
  44
  45                 // Init generic stacker
  46                 $stackerInstance->initStacker('generic');
  47
  48                 // Return the prepared instance
  49                 return $stackerInstance;
  50         }
  51
  52         /**
  53          * Pushs a value on a named stacker
  54          *
  55          * @param       $stackerName    Name of the stack
  56          * @param       $value                  Value to push on it
  57          * @return      void
  58          * @throws      StackerFullException    If the stack is full
  59          */
  60         public function pushNamed ($stackerName, $value) {
  61                 $this->partialStub('stackerName=' . $stackerName . ',value[' . gettype($value) . ']=' . $value);
  62         }
  63
  64         /**
  65          * 'Pops' a value from a named stacker
  66          *
  67          * @param       $stackerName    Name of the stack
  68          * @return      void
  69          * @throws      NoStackerException      If the named stacker was not found
  70          * @throws      EmptyStackerException   If the named stacker is empty
  71          */
  72         public function popNamed ($stackerName) {
  73                 $this->partialStub('stackerName=' . $stackerName);
  74         }
  75
  76         /**
  77          * Get value from named stacker
  78          *
  79          * @param       $stackerName    Name of the stack
  80          * @return      $value                  Value of last added value
  81          * @throws      NoStackerException      If the named stacker was not found
  82          * @throws      EmptyStackerException   If the named stacker is empty
  83          */
  84         public function getNamed ($stackerName) {
  85                 $this->partialStub('stackerName=' . $stackerName);
  86         }
  87 }
  88
  89 // [EOF]
  90 ?>