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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\Change\Email;
   4
   5 // Import framework stuff
   6 use CoreFramework\Registry\Generic\Registry;
   7
   8 /**
   9  * A filter for detecting email changes
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class EmailChangeFilter extends BaseFilter implements Filterable {
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor
  38                 parent::__construct(__CLASS__);
  39         }
  40
  41         /**
  42          * Creates an instance of this filter class
  43          *
  44          * @return      $filterInstance                 An instance of this filter class
  45          */
  46         public static final function createEmailChangeFilter () {
  47                 // Get a new instance
  48                 $filterInstance = new EmailChangeFilter();
  49
  50                 // Return the instance
  51                 return $filterInstance;
  52         }
  53
  54         /**
  55          * Executes the filter with given request and response objects
  56          *
  57          * @param       $requestInstance        An instance of a class with an Requestable interface
  58          * @param       $responseInstance       An instance of a class with an Responseable interface
  59          * @return      void
  60          * @throws      FilterChainException    If this filter fails to operate
  61          * @todo        Implement email change of the user here. HINT: Use the User class!
  62          */
  63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  64                 // Get both emails
  65                 $email1 = $requestInstance->getRequestElement('email1');
  66                 $email2 = $requestInstance->getRequestElement('email2');
  67
  68                 // Is only first email set?
  69                 if ((!empty($email1)) && (empty($email2))) {
  70                         // Request is invalid!
  71                         $requestInstance->requestIsValid(FALSE);
  72
  73                         // Email 2 is empty
  74                         $responseInstance->addFatalMessage('email2_empty');
  75
  76                         // Stop processing here
  77                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  78                 } // END - if
  79
  80                 // Is only second email set?
  81                 if ((empty($email1)) && (!empty($email2))) {
  82                         // Request is invalid!
  83                         $requestInstance->requestIsValid(FALSE);
  84
  85                         // Email 1 is empty
  86                         $responseInstance->addFatalMessage('email1_empty');
  87
  88                         // Stop processing here
  89                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  90                 } // END - if
  91
  92                 // Do both match?
  93                 if ($email1 != $email2) {
  94                         // Request is invalid!
  95                         $requestInstance->requestIsValid(FALSE);
  96
  97                         // Emails are mismatching
  98                         $responseInstance->addFatalMessage('emails_mismatch');
  99
 100                         // Stop processing here
 101                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 102                 } // END - if
 103
 104                 // Are email and confirmation empty?
 105                 if ((empty($email1)) && (empty($email2))) {
 106                         // No email change required!
 107                         return TRUE;
 108                 } // END - if
 109
 110                 // Now, get a user instance for comparison
 111                 $userInstance = Registry::getRegistry()->getInstance('user');
 112
 113                 // Get the email field
 114                 $userEmail = $userInstance->getField('email');
 115
 116                 // Are they different?
 117                 if ($userEmail == $email1) {
 118                         // Nothing has been changed is fine...
 119                         return TRUE;
 120                 } // END - if
 121
 122                 // Update the "new_email" field
 123                 $this->partialStub('Unfinished part.');
 124         }
 125
 126 }