inc/classes/main/filter/change/class_EmailChangeFilter.php

   1 <?php
   2 /**
   3  * A filter for detecting email changes
   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 EmailChangeFilter extends BaseFilter implements Filterable {
  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          * Creates an instance of this filter class
  37          *
  38          * @param       $controllerInstance             An instance of a Controller class
  39          * @return      $filterInstance                 An instance of this filter class
  40          */
  41         public final static function createEmailChangeFilter (Controller $controllerInstance) {
  42                 // Get a new instance
  43                 $filterInstance = new EmailChangeFilter();
  44
  45                 // Set the controller
  46                 $filterInstance->setControllerInstance($controllerInstance);
  47
  48                 // Return the instance
  49                 return $filterInstance;
  50         }
  51
  52         /**
  53          * Executes the filter with given request and response objects
  54          *
  55          * @param       $requestInstance        An instance of a class with an Requestable interface
  56          * @param       $responseInstance       An instance of a class with an Responseable interface
  57          * @return      void
  58          * @todo        Implement email change of the user here. HINT: Use the User class!
  59          */
  60         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  61                 // Get both emails
  62                 $email1 = $requestInstance->getRequestElement('email1');
  63                 $email2 = $requestInstance->getRequestElement('email2');
  64
  65                 // Is only first email set?
  66                 if ((!empty($email1)) && (empty($email2))) {
  67                         // Request is invalid!
  68                         $requestInstance->requestIsValid(false);
  69
  70                         // Email 2 is empty
  71                         $responseInstance->addFatalMessage('email2_empty');
  72
  73                         // Stop processing here
  74                         return false;
  75                 } // END - if
  76
  77                 // Is only second email set?
  78                 if ((empty($email1)) && (!empty($email2))) {
  79                         // Request is invalid!
  80                         $requestInstance->requestIsValid(false);
  81
  82                         // Email 1 is empty
  83                         $responseInstance->addFatalMessage('email1_empty');
  84
  85                         // Stop processing here
  86                         return false;
  87                 } // END - if
  88
  89                 // Do both match?
  90                 if ($email1 != $email2) {
  91                         // Request is invalid!
  92                         $requestInstance->requestIsValid(false);
  93
  94                         // Emails are mismatching
  95                         $responseInstance->addFatalMessage('emails_mismatch');
  96
  97                         // Stop processing here
  98                         return false;
  99                 } // END - if
 100
 101                 // Are email and confirmation empty?
 102                 if ((empty($email1)) && (empty($email2))) {
 103                         // No email change required!
 104                         return true;
 105                 } // END - if
 106
 107                 // Now, get a user instance for comparison
 108                 $userInstance = Registry::getRegistry()->getInstance('user');
 109
 110                 // Get the email field
 111                 $userEmail = $userInstance->getField('email');
 112
 113                 // Are they different?
 114                 if ($userEmail == $email1) {
 115                         // Nothing has been changed is fine...
 116                         return true;
 117                 } // END - if
 118
 119                 // Update the "new_email" field
 120                 $this->partialStub("Unfinished part.");
 121         }
 122 }
 123
 124 // [EOF]
 125 ?>