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