inc/main/classes/filter/update/class_UserStatusConfimedUpdateFilter.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\User\Status;
   4
   5 /**
   6  * A filter for updating the user account status to confirmed
   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 UserStatusConfimedUpdateFilter 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 createUserStatusConfimedUpdateFilter () {
  44                 // Get a new instance
  45                 $filterInstance = new UserStatusConfimedUpdateFilter();
  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          */
  58         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  59                 // Get user instance from registry
  60                 $userInstance = Registry::getRegistry()->getInstance('user');
  61
  62                 // Get "confirmed" status from config
  63                 $confirmed = $this->getConfigInstance()->getConfigEntry('user_status_confirmed');
  64
  65                 // Update the user status to "confirmed" here
  66                 $userInstance->updateDatabaseField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS, $confirmed);
  67
  68                 // Wipe out the confirm hash for extra security
  69                 $userInstance->updateDatabaseField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH, '');
  70
  71                 // Write all updates to the database
  72                 $userInstance->flushPendingUpdates();
  73         }
  74
  75 }