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