Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 13 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 1 |
| SessionSubstitutionService | |
0.00% |
0 / 13 |
|
0.00% |
0 / 3 |
30 | |
0.00% |
0 / 1 |
| substituteSession | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
2 | |||
| isSubstituted | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
6 | |||
| revert | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
6 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2016 (original work) Open Assessment Technologies SA; |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\tao\model\session; |
| 23 | |
| 24 | use oat\oatbox\user\User; |
| 25 | use oat\oatbox\service\ConfigurableService; |
| 26 | use common_session_Session; |
| 27 | use common_session_SessionManager; |
| 28 | |
| 29 | /** |
| 30 | * Class SessionSubstitutionService |
| 31 | * |
| 32 | * Used to temporary replace the current user session (to pretend to be another user). |
| 33 | * |
| 34 | * @author Aleh Hutnikau <hutnikau@1pt.com> |
| 35 | * @package oat\tao\model |
| 36 | */ |
| 37 | class SessionSubstitutionService extends ConfigurableService implements \oat\tao\model\SessionSubstitutionService |
| 38 | { |
| 39 | /** |
| 40 | * @param User $user |
| 41 | * @return PretenderSession new session instance |
| 42 | */ |
| 43 | public function substituteSession(User $user) |
| 44 | { |
| 45 | $session = new PretenderSession($user); |
| 46 | common_session_SessionManager::startSession($session); |
| 47 | return $session; |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * @return boolean |
| 52 | */ |
| 53 | public function isSubstituted() |
| 54 | { |
| 55 | $result = false; |
| 56 | $session = common_session_SessionManager::getSession(); |
| 57 | if ($session instanceof PretenderSession) { |
| 58 | $result = true; |
| 59 | } |
| 60 | return $result; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * @return void |
| 65 | * @return common_session_Session original session instance |
| 66 | * @throws \Exception |
| 67 | */ |
| 68 | public function revert() |
| 69 | { |
| 70 | $session = common_session_SessionManager::getSession(); |
| 71 | if ($session instanceof PretenderSession) { |
| 72 | $session->restoreOriginal(); |
| 73 | } else { |
| 74 | throw new \Exception('Session has not been substituted.'); |
| 75 | } |
| 76 | return common_session_SessionManager::getSession(); |
| 77 | } |
| 78 | } |