framework/main/classes/streams/input/class_

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Stream\Input\;
   4
   5 // Import framework stuff
   6 use CoreFramework\Stream\BaseStream;
   7
   8 /**
   9  * A ???InputStream class
  10  *
  11  * @author              Roland Haeder <webmaster@ship-simu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009  Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.ship-simu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class ???InputStream extends BaseStream implements InputStream {
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor
  38                 parent::__construct(__CLASS__);
  39         }
  40
  41         /**
  42          * Creates an instance of this node class
  43          *
  44          * @return      $streamInstance         An instance of this node class
  45          */
  46         public final static function create???InputStream () {
  47                 // Get a new instance
  48                 $streamInstance = new ???InputStream();
  49
  50                 // Return the instance
  51                 return $streamInstance;
  52         }
  53
  54         /**
  55          * Streams the data and maybe does something to it
  56          *
  57          * @param       $data   The data (string mostly) to "stream"
  58          * @return      $data   The data (string mostly) to "stream"
  59          * @throws      UnsupportedOperationException   If this method is called
  60          */
  61         public function streamData ($data) {
  62                 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
  63                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  64         }
  65
  66 }