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