application/hub/interfaces/nodes/class_NodeHelper.php

   1 <?php
   2 /**
   3  * An interface for "node-helper" classes
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  * @todo                We need to find a better name for this interface
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 interface NodeHelper extends FrameworkInterface {
  26         /**
  27          * Method to "bootstrap" the node. This step does also apply provided
  28          * command-line arguments stored in the request instance. You should now
  29          * get it from calling $this->getRequestInstance().
  30          *
  31          * @return      void
  32          */
  33         function doBootstrapping ();
  34 }
  35
  36 //
  37 ?>