inc/main/classes/registration/class_BaseRegistration.php

   1 <?php
   2 /**
   3  * A general registration class.
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core 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 BaseRegistration extends BaseFrameworkSystem {
  25         /**
  26          * Pre-registration filter chain
  27          */
  28         private $preRegistrationFilter = NULL;
  29
  30         /**
  31          * Pre-registration filter chain
  32          */
  33         private $postRegistrationFilter = NULL;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Initialize filters. This must be done before you can use them
  48          *
  49          * @return      void
  50          */
  51         protected function initFilterChains () {
  52                 // Pre/post-registration filters
  53                 $this->preRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
  54                 $this->postRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
  55         }
  56
  57         /**
  58          * Adds a filter to the pre filter chain
  59          *
  60          * @param       $filterInstance         An instance of a filter
  61          * @return      void
  62          */
  63         public function addPreFilter (Filterable $filterInstance) {
  64                 // Add the pre filter
  65                 $this->preRegistrationFilter->addFilter($filterInstance);
  66         }
  67
  68         /**
  69          * Adds a filter to the post filter chain
  70          *
  71          * @param       $filterInstance         An instance of a filter
  72          * @return      void
  73          */
  74         public function addPostFilter (Filterable $filterInstance) {
  75                 // Add the post filter
  76                 $this->postRegistrationFilter->addFilter($filterInstance);
  77         }
  78
  79         /**
  80          * Executes all pre filters
  81          *
  82          * @return      void
  83          */
  84         protected function executePreFilters () {
  85                 // Execute all pre filters
  86                 $this->preRegistrationFilter->processFilters($this->getRequestInstance(), $this->getResponseInstance());
  87         }
  88
  89         /**
  90          * Executes all post filters
  91          *
  92          * @return      void
  93          */
  94         protected function executePostFilters () {
  95                 // Execute all post filters
  96                 $this->postRegistrationFilter->processFilters($this->getRequestInstance(), $this->getResponseInstance());
  97         }
  98 }
  99
 100 // [EOF]
 101 ?>