inc/classes/main/discovery/class_

   1 <?php
   2 /**
   3  * A ??? discovery class.
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 ???Discovery extends BaseDiscovery implements Discoverable {
  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          * Create an instance of this class
  37          *
  38          * @return      $discoveryInstance      An instance of this discovery class
  39          */
  40         public final static function create???Discovery () {
  41                 // Get an instance of this class
  42                 $discoveryInstance = new ???Discovery();
  43
  44                 // Return the prepared instance
  45                 return $discoveryInstance;
  46         }
  47
  48         /**
  49          * Discovers the request
  50          *
  51          * @param       $requestInstance        An instance of a Requestable class
  52          * @return      void
  53          * @todo        0% done
  54          */
  55         public function discover (Requestable $requestInstance) {
  56                 $this->partialStub("Please implement this method.");
  57         }
  58
  59         /**
  60          * Adds the database result in a human-readable format to the helper class
  61          *
  62          * @param       $helperInstance         An instance of a helper class
  63          * @return      void
  64          * @todo        0% done
  65          */
  66         public function addResultsToHelper (HelpableTemplate $helperInstance) {
  67                 $this->partialStub("Please implement this method.");
  68         }
  69 }
  70
  71 // [EOF]
  72 ?>