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