framework/main/classes/discovery/class_

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