application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php

   1 <?php
   2 /**
   3  * A command for profile-update handling
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.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.ship-simu.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 WebShipsimuProfileCommand extends BaseCommand implements Commandable {
  25         /**
  26          * Filtered request data
  27          */
  28         private $requestData = array();
  29
  30         /**
  31          * Allowed profile data to pass through
  32          */
  33         private $allowedData = array(
  34                 'pass'  => 'pass1',
  35                 'email' => 'email1',
  36                 'surname',
  37                 'family',
  38                 'street',
  39                 'city',
  40                 'zip',
  41                 'icq',
  42                 'jabber',
  43                 'yahoo',
  44                 'aol',
  45                 'msn',
  46                 'rules'
  47         );
  48
  49         /**
  50          * Protected constructor
  51          *
  52          * @return      void
  53          */
  54         protected function __construct () {
  55                 // Call parent constructor
  56                 parent::__construct(__CLASS__);
  57
  58                 // Set part description
  59                 $this->setObjectDescription("Registration handling command for Ship-Simu");
  60
  61                 // Create unique ID number
  62                 $this->generateUniqueId();
  63
  64                 // Clean up a little
  65                 $this->removeNumberFormaters();
  66                 $this->removeSystemArray();
  67         }
  68
  69         /**
  70          * Creates an instance of this command and sets the resolver instance
  71          *
  72          * @param       $resolverInstance       An instance of a command resolver
  73          * @return      $commandInstance        The created command instance
  74          */
  75         public final static function createWebShipsimuProfileCommand (CommandResolver $resolverInstance) {
  76                 // Get a new instance
  77                 $commandInstance = new WebShipsimuProfileCommand();
  78
  79                 // Set the resolver instance
  80                 $commandInstance->setResolverInstance($resolverInstance);
  81
  82                 // Return the prepared instance
  83                 return $commandInstance;
  84         }
  85
  86         /**
  87          * Executes the command with given request and response objects
  88          *
  89          * @param       $requestInstance        An instance of a class with an Requestable interface
  90          * @param       $responseInstance       An instance of a class with an Responseable interface
  91          * @return      void
  92          */
  93         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  94                 // Make sure only allowed values are comming through
  95                 foreach ($this->allowedData as $alias=>$element) {
  96                         // Get data
  97                         $data = $requestInstance->getRequestElement($element);
  98
  99                         // Skip empty fields
 100                         if (empty($data)) continue;
 101
 102                         // Do we have an alias?
 103                         if (is_string($alias)) {
 104                                 // Yes, so use it
 105                                 $this->requestData[$alias]   = $data;
 106                         } else {
 107                                 // No, default entry
 108                                 $this->requestData[$element] = $data;
 109                         }
 110                 } // END - foreach
 111
 112                 // Remove the array, we don't need it anymore
 113                 unset($this->allowedData);
 114
 115                 // Unfinished!
 116                 $this->partialStub("Unfinished work.");
 117                 $this->debugBackTrace();
 118         }
 119
 120         /**
 121          * Adds extra filters to the given controller instance
 122          *
 123          * @param       $controllerInstance             A controller instance
 124          * @param       $requestInstance                An instance of a class with an Requestable interface
 125          * @return      void
 126          * @todo        Add some more pre/post filters to the controller
 127          */
 128         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 129                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
 130                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_class'));
 131
 132                 // User status filter
 133                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_class'));
 134
 135                 // Updated rules accepted
 136                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('rules_accepted_class'));
 137
 138                 // Account password validation
 139                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('account_password_class'));
 140
 141                 // Email changed
 142                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_change_class'));
 143
 144                 // Password changed
 145                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_change_class'));
 146         }
 147 }
 148
 149 // [EOF]
 150 ?>