inc/classes/main/discovery/class_

   1 <?php
   2 /**
   3  * A local payment discovery class. This class looks in local database for
   4  * registered payment types and like all the others it at least returns the
   5  * money bank transfer type.
   6  *
   7  * @author              Roland Haeder <webmaster@ship-simu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.ship-simu.org
  12  *
  13  * This program is free software: you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation, either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  25  */
  26 class ???Discovery extends BaseDiscovery implements Discoverable {
  27         /**
  28          * Protected constructor
  29          *
  30          * @return      void
  31          */
  32         protected function __construct () {
  33                 // Call parent constructor
  34                 parent::__construct(__CLASS__);
  35         }
  36
  37         /**
  38          * Create an instance of this class
  39          *
  40          * @return      $discoveryInstance      An instance of this discovery class
  41          */
  42         public final static function create???Discovery () {
  43                 // Get an instance of this class
  44                 $discoveryInstance = new ???Discovery();
  45
  46                 // Return the prepared instance
  47                 return $discoveryInstance;
  48         }
  49
  50         /**
  51          * Discovers the request
  52          *
  53          * @param       $requestInstance        An instance of a Requestable class
  54          * @return      void
  55          * @todo        0% done
  56          */
  57         public function discover (Requestable $requestInstance) {
  58                 $this->partialStub("Please implement this method.");
  59         }
  60
  61         /**
  62          * Adds the database result in a human-readable format to the helper class
  63          *
  64          * @param       $helperInstance         An instance of a helper class
  65          * @return      void
  66          * @todo        0% done
  67          */
  68         public function addResultsToHelper (HelpableTemplate $helperInstance) {
  69                 $this->partialStub("Please implement this method.");
  70         }
  71 }
  72
  73 // [EOF]
  74 ?>