application/hub/classes/factories/chain/class_PackageFilterChainFactory.php

   1 <?php
   2 /**
   3  * A factory class for network packages
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class PackageFilterChainFactory extends ObjectFactory {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Returns a filter chain by given tags array.
  37          *
  38          * @param       $tags                   An array with tags from a package
  39          * @return      $chainInstance  An instance of a filter chain class
  40          */
  41         public static final function createChainByTagsArray (array $tags) {
  42                 // Get a registry key from tags array, this does mostly call implode()
  43                 $registryKey = Registry::getRegistryKeyFromArray('package_filter_chain', $tags);
  44
  45                 // Is the registry key there?
  46                 if (Registry::getRegistry()->instanceExists($registryKey)) {
  47                         // Yes, then use that instance
  48                         $chainInstance = Registry::getRegistry()->getInstance($registryKey);
  49                 } else {
  50                         // Initialize a filter chain class
  51                         $chainInstance = self::createObjectByConfiguredName('package_filter_chain_class');
  52
  53                         // "Walk" through all tags entries
  54                         foreach ($tags as $tag) {
  55                                 /*
  56                                  * Now create a filter instance of this tag. This way all tags
  57                                  * got rudymentary verified, if an exception is coming here, it
  58                                  * simply means the tag is not valid. This however should be
  59                                  * handled some calls before this method is called.
  60                                  */
  61                                 $filterInstance = self::createObjectByConfiguredName('package_tag_' . $tag . '_filter');
  62
  63                                 // Add this filter to the chain
  64                                 $chainInstance->addFilter($filterInstance);
  65                         } // END - foreach
  66
  67                         // Add the finished chain to the registry
  68                         Registry::getRegistry()->addInstance($registryKey, $chainInstance);
  69                 }
  70
  71                 // Return the chain instance
  72                 return $chainInstance;
  73         }
  74 }
  75
  76 // [EOF]
  77 ?>