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

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