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