inc/classes/main/stacker/file/fifo/class_FiFoFileStack.php

   1 <?php
   2 /**
   3  * A FiFo file-based stack
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2014 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 FiFoFileStack extends BaseFileStack implements StackableFile, Registerable {
  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 this class
  37          *
  38          * @param       $fileName               Absolute Name of stack file
  39          * @param       $type                   Type of this stack (e.g. url_source for URL sources)
  40          * @return      $stackInstance  An instance of a Stackable class
  41          */
  42         public final static function createFiFoFileStack ($fileName, $type) {
  43                 // Get new instance
  44                 $stackInstance = new FiFoFileStack();
  45
  46                 // Init this stack
  47                 $stackInstance->initFileStack($fileName, $type);
  48
  49                 // Return the prepared instance
  50                 return $stackInstance;
  51         }
  52
  53         /**
  54          * Pushs a value on a named stacker
  55          *
  56          * @param       $stackerName    Name of the stack
  57          * @param       $value                  Value to push on it
  58          * @return      void
  59          * @throws      StackerFullException    If the stack is full
  60          */
  61         public function pushNamed ($stackerName, $value) {
  62                 $this->partialStub('stackerName=' . $stackerName . ',value[' . gettype($value) . ']=' . $value);
  63         }
  64
  65         /**
  66          * 'Pops' a value from a named stacker
  67          *
  68          * @param       $stackerName    Name of the stack
  69          * @return      void
  70          * @throws      NoStackerException      If the named stacker was not found
  71          * @throws      EmptyStackerException   If the named stacker is empty
  72          */
  73         public function popNamed ($stackerName) {
  74                 $this->partialStub('stackerName=' . $stackerName);
  75         }
  76
  77         /**
  78          * Get value from named stacker
  79          *
  80          * @param       $stackerName    Name of the stack
  81          * @return      $value                  Value of last added value
  82          * @throws      NoStackerException      If the named stacker was not found
  83          * @throws      EmptyStackerException   If the named stacker is empty
  84          */
  85         public function getNamed ($stackerName) {
  86                 $this->partialStub('stackerName=' . $stackerName);
  87         }
  88
  89         /**
  90          * Seeks to given position
  91          *
  92          * @param       $seekPosition   Seek position in file
  93          * @return      $status                 Status of this operation
  94          */
  95         public function seek ($seekPosition) {
  96                 $this->partialStub('seekPosition=' . $seekPosition);
  97         }
  98
  99         /**
 100          * Size of file stack
 101          *
 102          * @return      $size   Size (in bytes) of file
 103          */
 104         public function size () {
 105                 $this->partialStub();
 106         }
 107 }
 108
 109 // [EOF]
 110 ?>