inc/classes/main/registration/class_BaseRegistration.php

   1 <?php
   2 /**
   3  * A general registration class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.3.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.mxchange.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 abstract class BaseRegistration extends BaseFrameworkSystem implements UserRegister {
  25         /**
  26          * Instance of a request class
  27          */
  28         private $requestInstance = null;
  29
  30         /**
  31          * Instance of a response class
  32          */
  33         private $responseInstance = null;
  34
  35         /**
  36          * Pre-registration filter chain
  37          */
  38         private $preRegistrationFilter = null;
  39
  40         /**
  41          * Pre-registration filter chain
  42          */
  43         private $postRegistrationFilter = null;
  44
  45         /**
  46          * Protected constructor
  47          *
  48          * @param       $className      Name of the class
  49          * @return      void
  50          */
  51         protected function __construct ($className) {
  52                 // Call parent constructor
  53                 parent::__construct($className);
  54
  55                 // Clean up a little
  56                 $this->removeNumberFormaters();
  57                 $this->removeSystemArray();
  58         }
  59
  60         /**
  61          * Initialize filters. This must be done before you can use them
  62          *
  63          * @return      void
  64          */
  65         protected function initFilterChains () {
  66                 // Pre/post-registration filters
  67                 $this->preRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain');
  68                 $this->postRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain');
  69         }
  70
  71         /**
  72          * Setter for request instance
  73          *
  74          * @param       $requestInstance        An instance of a Requestable class
  75          * @return      void
  76          */
  77         public final function setRequestInstance (Requestable $requestInstance) {
  78                 $this->requestInstance = $requestInstance;
  79         }
  80
  81         /**
  82          * Getter for request instance
  83          *
  84          * @return      $requestInstance        An instance of a Requestable class
  85          */
  86         public final function getRequestInstance () {
  87                 return $this->requestInstance;
  88         }
  89
  90         /**
  91          * Setter for response instance
  92          *
  93          * @param       $responseInstance       An instance of a Responseable class
  94          * @return      void
  95          */
  96         public final function setResponseInstance (Responseable $responseInstance) {
  97                 $this->responseInstance = $responseInstance;
  98         }
  99
 100         /**
 101          * Getter for response instance
 102          *
 103          * @return      $responseInstance       An instance of a Responseable class
 104          */
 105         public final function getResponseInstance () {
 106                 return $this->responseInstance;
 107         }
 108
 109         /**
 110          * Adds a filter to the pre filter chain
 111          *
 112          * @param       $filterInstance         An instance of a filter
 113          * @return      void
 114          */
 115         public function addPreFilter (Filterable $filterInstance) {
 116                 // Add the pre filter
 117                 $this->preRegistrationFilter->addFilter($filterInstance);
 118         }
 119
 120         /**
 121          * Adds a filter to the post filter chain
 122          *
 123          * @param       $filterInstance         An instance of a filter
 124          * @return      void
 125          */
 126         public function addPostFilter (Filterable $filterInstance) {
 127                 // Add the post filter
 128                 $this->postRegistrationFilter->addFilter($filterInstance);
 129         }
 130
 131         /**
 132          * Executes all pre filters
 133          *
 134          * @return      void
 135          */
 136         protected function executePreFilters () {
 137                 // Execute all pre filters
 138                 $this->preRegistrationFilter->processFilters($this->getRequestInstance(), $this->getResponseInstance());
 139         }
 140
 141         /**
 142          * Executes all post filters
 143          *
 144          * @return      void
 145          */
 146         protected function executePostFilters () {
 147                 // Execute all post filters
 148                 $this->postRegistrationFilter->processFilters($this->requestInstance, $this->responseInstance);
 149         }
 150 }
 151
 152 // [EOF]
 153 ?>