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