application/hub/interfaces/apt-proxy/class_AptProxy.php

   1 <?php
   2 /**
   3  * An interface for apt-proxy classes
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 AptProxy extends FrameworkInterface {
  26         /**
  27          * Method to "bootstrap" the apt-proxy. 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          * Outputs the console teaser. This should only be executed on startup or
  37          * full restarts. This method generates some space around the teaser.
  38          *
  39          * @return      void
  40          */
  41         function outputConsoleTeaser ();
  42
  43         /**
  44          * Add some apt-proxy-specific filters
  45          *
  46          * @param       $controllerInstance             An object of a Controller instance
  47          * @param       $responseInstance               An object of a Responseable instance
  48          * @return      void
  49          */
  50         function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance);
  51
  52         /**
  53          * Enables/disables the apt-proxy (just sets a flag)
  54          *
  55          * @param       $version        Version number of this apt-proxy
  56          * @return      void
  57          */
  58         function enableIsActive ($isActive = TRUE);
  59
  60         /**
  61          * Determines whether the apt-proxy is active
  62          *
  63          * @return      $isActive       Whether the apt-proxy is active
  64          */
  65         function isActive ();
  66 }
  67
  68 // [EOF]
  69 ?>