application/shipsimu/main/commands/web/class_WebShipsimuProfileCommand.php

   1 <?php
   2 /**
   3  * A command for profile-update handling
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu 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 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                 'birth_day',
  48                 'birth_month',
  49                 'birth_year'
  50         );
  51
  52         /**
  53          * Protected constructor
  54          *
  55          * @return      void
  56          */
  57         protected function __construct () {
  58                 // Call parent constructor
  59                 parent::__construct(__CLASS__);
  60         }
  61
  62         /**
  63          * Creates an instance of this command and sets the resolver instance
  64          *
  65          * @param       $resolverInstance       An instance of a command resolver
  66          * @return      $commandInstance        The created command instance
  67          */
  68         public static final function createWebShipsimuProfileCommand (CommandResolver $resolverInstance) {
  69                 // Get a new instance
  70                 $commandInstance = new WebShipsimuProfileCommand();
  71
  72                 // Set the resolver instance
  73                 $commandInstance->setResolverInstance($resolverInstance);
  74
  75                 // Return the prepared instance
  76                 return $commandInstance;
  77         }
  78
  79         /**
  80          * Executes the command with given request and response objects
  81          *
  82          * @param       $requestInstance        An instance of a class with an Requestable interface
  83          * @param       $responseInstance       An instance of a class with an Responseable interface
  84          * @return      void
  85          * @todo        Add functionality here
  86          */
  87         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  88                 // Make sure only allowed values are comming through
  89                 foreach ($this->allowedData as $alias => $element) {
  90                         // Get data
  91                         $data = $requestInstance->getRequestElement($element);
  92
  93                         // Silently skip empty fields
  94                         if (empty($data)) continue;
  95
  96                         // Do we have an alias?
  97                         if (is_string($alias)) {
  98                                 // Yes, so use it
  99                                 $this->requestData[$alias]   = $data;
 100                         } else {
 101                                 // No, default entry
 102                                 $this->requestData[$element] = $data;
 103                         }
 104                 } // END - foreach
 105
 106                 // Remove the array, we don't need it anymore
 107                 unset($this->allowedData);
 108
 109                 // Unfinished!
 110                 $this->partialStub("Unfinished work.");
 111                 $this->debugBackTrace();
 112         }
 113
 114         /**
 115          * Adds extra filters to the given controller instance
 116          *
 117          * @param       $controllerInstance             A controller instance
 118          * @param       $requestInstance                An instance of a class with an Requestable interface
 119          * @return      void
 120          * @todo        Add some more pre/post filters to the controller
 121          */
 122         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 123                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
 124                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
 125
 126                 // User status filter
 127                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
 128
 129                 // User status if not 'guest' filter
 130                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_guest_filter'));
 131
 132                 // Updated rules accepted
 133                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('rules_accepted_filter'));
 134
 135                 // Account password validation
 136                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('account_password_filter'));
 137
 138                 // Validate CAPTCHA input
 139                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_profile_verifier_filter'));
 140
 141                 // Validate birthday input
 142                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('birthday_profile_verifier_filter'));
 143
 144                 // Email changed
 145                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_change_filter'));
 146
 147                 // Password changed
 148                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_change_filter'));
 149         }
 150 }
 151
 152 // [EOF]
 153 ?>