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