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

   1 <?php
   2 /**
   3  * A filter for updating the user account like last activity, last action
   4  * performed and so on.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class UserUpdateFilter extends BaseFrameworkSystem implements Filterable {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34
  35                 // Set part description
  36                 $this->setObjectDescription("User update filter");
  37
  38                 // Create unique ID number
  39                 $this->generateUniqueId();
  40
  41                 // Clean up a little
  42                 $this->removeNumberFormaters();
  43                 $this->removeSystemArray();
  44         }
  45
  46         /**
  47          * Creates an instance of this filter class
  48          *
  49          * @return      $filterInstance         An instance of this filter class
  50          */
  51         public final static function createUserUpdateFilter () {
  52                 // Get a new instance
  53                 $filterInstance = new UserUpdateFilter();
  54
  55                 // Return the instance
  56                 return $filterInstance;
  57         }
  58
  59         /**
  60          * Executes the filter with given request and response objects
  61          *
  62          * @param       $requestInstance        An instance of a class with an Requestable interface
  63          * @param       $responseInstance       An instance of a class with an Responseable interface
  64          * @return      void
  65          */
  66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  67                 // Get user instance from registry
  68                 $userInstance = Registry::getRegistry()->getInstance('user');
  69
  70                 // Now update last activity
  71                 $userInstance->updateLastActivity($requestInstance);
  72
  73                 // Update auth data as well
  74                 $authInstance = Registry::getRegistry()->getInstance('auth');
  75                 $authInstance->updateAuthData();
  76
  77                 /* @todo Add more user updates here */
  78
  79                 // Write all updates to the database
  80                 $userInstance->flushUpdates();
  81         }
  82 }
  83
  84 // [EOF]
  85 ?>