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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\Change\Email;
   4
   5 /**
   6  * A filter for detecting email changes
   7  *
   8  * @author              Roland Haeder <webmaster@shipsimu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.shipsimu.org
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  26  */
  27 class EmailChangeFilter extends BaseFilter implements Filterable {
  28         /**
  29          * Protected constructor
  30          *
  31          * @return      void
  32          */
  33         protected function __construct () {
  34                 // Call parent constructor
  35                 parent::__construct(__CLASS__);
  36         }
  37
  38         /**
  39          * Creates an instance of this filter class
  40          *
  41          * @return      $filterInstance                 An instance of this filter class
  42          */
  43         public static final function createEmailChangeFilter () {
  44                 // Get a new instance
  45                 $filterInstance = new EmailChangeFilter();
  46
  47                 // Return the instance
  48                 return $filterInstance;
  49         }
  50
  51         /**
  52          * Executes the filter with given request and response objects
  53          *
  54          * @param       $requestInstance        An instance of a class with an Requestable interface
  55          * @param       $responseInstance       An instance of a class with an Responseable interface
  56          * @return      void
  57          * @throws      FilterChainException    If this filter fails to operate
  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                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  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                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  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                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  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 }