inc/main/classes/factories/html/class_HtmlNewsFactory.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Factory\News;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7 use CoreFramework\Request\Requestable;
   8
   9 /**
  10  * A news factory for web pages
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.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 HtmlNewsFactory extends BaseFactory {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Singleton getter for a special factory instance depending on the given
  44          * request
  45          *
  46          * @param       $requestInstance        An instance of a Requestable class
  47          * @return      $factoryInstance        An instance of a HtmlNewsFactory class
  48          */
  49         public static final function createFactoryByRequest (Requestable $requestInstance) {
  50                 // Set default news reader class
  51                 $configEntry = 'news_reader_class';
  52
  53                 // Get "page"
  54                 $command = $requestInstance->getRequestElement('command');
  55
  56                 // Is 'command' used?
  57                 if (!empty($command)) {
  58                         // Then add it
  59                         $configEntry = sprintf('news_reader_%s_class', $command);
  60
  61                         // Get 'action'
  62                         $action = $requestInstance->getRequestElement('action');
  63
  64                         // Is it also there?
  65                         if (!empty($action)) {
  66                                 // Then use both for config entry
  67                                 $configEntry = sprintf('news_reader_%s_%s_class', $command, $action);
  68                         } // END - if
  69                 } // END - if
  70
  71                 // Get the news reader class name from config
  72                 $className = $requestInstance->getConfigInstance()->getConfigEntry($configEntry);
  73
  74                 // Once we have that name, try to load initialize it
  75                 $newsInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
  76
  77                 // Initialize the reader
  78                 $newsInstance->initializeReader();
  79
  80                 // Return the prepared factory instance
  81                 return $newsInstance;
  82         }
  83
  84 }