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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Factory\News;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   7 use Org\Mxchange\CoreFramework\Factory\BaseFactory;
   8 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
   9 use Org\Mxchange\CoreFramework\Request\Requestable;
  10
  11 /**
  12  * A news factory for web pages
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class HtmlNewsFactory extends BaseFactory {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         private function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42         }
  43
  44         /**
  45          * Singleton getter for a special factory instance depending on the given
  46          * request
  47          *
  48          * @param       $requestInstance        An instance of a Requestable class
  49          * @return      $factoryInstance        An instance of a HtmlNewsFactory class
  50          */
  51         public static final function createFactoryByRequest (Requestable $requestInstance) {
  52                 // Set default news reader class
  53                 $configEntry = 'news_reader_class';
  54
  55                 // Get "page"
  56                 $command = $requestInstance->getRequestElement('command');
  57
  58                 // Is 'command' used?
  59                 if (!empty($command)) {
  60                         // Then add it
  61                         $configEntry = sprintf('news_reader_%s_class', $command);
  62
  63                         // Get 'action'
  64                         $action = $requestInstance->getRequestElement('action');
  65
  66                         // Is it also there?
  67                         if (!empty($action)) {
  68                                 // Then use both for config entry
  69                                 $configEntry = sprintf('news_reader_%s_%s_class', $command, $action);
  70                         }
  71                 }
  72
  73                 // Get the news reader class name from config
  74                 $className = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($configEntry);
  75
  76                 // Once we have that name, try to load initialize it
  77                 $newsInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
  78
  79                 // Initialize the reader
  80                 $newsInstance->initializeReader();
  81
  82                 // Return the prepared factory instance
  83                 return $newsInstance;
  84         }
  85
  86 }