framework/main/interfaces/discovery/class_Discoverable.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Discovery;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7 use Org\Mxchange\CoreFramework\Helper\Template\HelpableTemplate;
   8 use Org\Mxchange\CoreFramework\Request\Requestable;
   9
  10 /**
  11  * An interface for discovery
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.shipsimu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 interface Discoverable extends FrameworkInterface {
  33         /**
  34          * Discovers the request
  35          *
  36          * @param       $requestInstance        An instance of a Requestable class
  37          * @return      void
  38          */
  39         function discover (Requestable $requestInstance);
  40
  41         /**
  42          * Adds the database result in a human-readable format to the helper class
  43          *
  44          * @param       $helperInstance         An instance of a helper class
  45          * @return      void
  46          */
  47         function addResultsToHelper (HelpableTemplate $helperInstance);
  48
  49 }