application/hub/main/connectors/query/class_

   1 <?php
   2 /**
   3  * A ??? query connector class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  * @todo                Find an interface for: handleAllQueries()
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class ???QueryConnector extends BaseQueryConnector implements Connectable, Visitable {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34         }
  35
  36         /**
  37          * Creates an instance of this query connector class
  38          *
  39          * @param       $nodeInstance           An instance of a node
  40          * @return      $connectorInstance      An instance of this query connector class
  41          */
  42         public final static function create???QueryConnector (NodeHelper $nodeInstance) {
  43                 // Create the instance
  44                 $connectorInstance = new ???QueryConnector();
  45
  46                 // Set the node instance
  47                 $connectorInstance->setNodeInstance($nodeInstance);
  48
  49                 // Get a list instance
  50                 $listInstance = ObjectFactory::createObjectByConfiguredName('!!!_query_list_class');
  51
  52                 // Set it in the connector
  53                 $connectorInstance->setListInstance($listInstance);
  54
  55                 // Finally return the connector
  56                 return $connectorInstance;
  57         }
  58
  59         /**
  60          * Accepts the visitor to process the visit "request"
  61          *
  62          * @param       $visitorInstance        An instance of a Visitor class
  63          * @return      void
  64          */
  65         public function accept (Visitor $visitorInstance) {
  66                 // Visit the query connector
  67                 $visitorInstance->visitQuery($this);
  68         }
  69
  70         /**
  71          * Handles all unsent queries and should be called from a visitor
  72          *
  73          * @return      void
  74          * @todo        0% done
  75          */
  76         public function handleAllQueries () {
  77                 $this->partialStub('Please implement this method.');
  78         }
  79
  80         /**
  81          * Processes all pending queries. This method should be called by the
  82          * ActiveTaskVisitor class and should use an iterator on all pending
  83          * queries.
  84          *
  85          * @return      void
  86          * @todo        0% done
  87          */
  88         public function processAllPendingQueries () {
  89                 $this->partialStub('Please implement this method.');
  90         }
  91 }
  92
  93 // [EOF]
  94 ?>