Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 27 |
|
0.00% |
0 / 6 |
CRAP | |
0.00% |
0 / 1 |
| tao_actions_ServiceModule | |
0.00% |
0 / 27 |
|
0.00% |
0 / 6 |
110 | |
0.00% |
0 / 1 |
| getServiceCallId | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| getState | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| setState | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| submitState | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| getUserPropertyValues | |
0.00% |
0 / 10 |
|
0.00% |
0 / 1 |
6 | |||
| getDirectory | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| 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) 2013 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | use oat\tao\model\state\StateStorage; |
| 23 | |
| 24 | /** |
| 25 | * V2 of the service controller |
| 26 | * |
| 27 | * @author CRP Henri Tudor - TAO Team - {@link http://www.tao.lu} |
| 28 | * @license GPLv2 http://www.opensource.org/licenses/gpl-2.0.php |
| 29 | * @package tao |
| 30 | * |
| 31 | */ |
| 32 | class tao_actions_ServiceModule extends tao_actions_CommonModule |
| 33 | { |
| 34 | /** |
| 35 | * Returns the serviceCallId for the current service call |
| 36 | * |
| 37 | * @throws common_exception_Error |
| 38 | * @return string |
| 39 | */ |
| 40 | protected function getServiceCallId() |
| 41 | { |
| 42 | if (!$this->hasRequestParameter('serviceCallId')) { |
| 43 | throw new common_exception_Error('No serviceCallId on service call'); |
| 44 | } |
| 45 | return $this->getRequestParameter('serviceCallId'); |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Returns the state stored or NULL ifs none was found |
| 50 | * |
| 51 | * @return string |
| 52 | */ |
| 53 | protected function getState() |
| 54 | { |
| 55 | $serviceService = $this->getServiceLocator()->get(StateStorage::SERVICE_ID); |
| 56 | $userUri = $this->getSession()->getUserUri(); |
| 57 | return is_null($userUri) ? null : $serviceService->get($userUri, $this->getServiceCallId()); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Stores the state of the current service call |
| 62 | * |
| 63 | * @param string $state |
| 64 | * @return boolean |
| 65 | */ |
| 66 | protected function setState($state) |
| 67 | { |
| 68 | $serviceService = $this->getServiceLocator()->get(StateStorage::SERVICE_ID); |
| 69 | $userUri = $this->getSession()->getUserUri(); |
| 70 | return is_null($userUri) ? false : $serviceService->set($userUri, $this->getServiceCallId(), $state); |
| 71 | } |
| 72 | |
| 73 | public function submitState() |
| 74 | { |
| 75 | $success = $this->setState($_POST['state']); |
| 76 | $this->returnJson([ |
| 77 | 'success' => $success |
| 78 | ]); |
| 79 | } |
| 80 | |
| 81 | public function getUserPropertyValues() |
| 82 | { |
| 83 | if (!$this->hasRequestParameter('property')) { |
| 84 | throw new common_exception_MissingParameter('property'); |
| 85 | } |
| 86 | $property = $this->getRequestParameter('property'); |
| 87 | |
| 88 | $values = $this->getSession()->getUserPropertyValues($property); |
| 89 | $this->returnJson([ |
| 90 | 'success' => true, |
| 91 | 'data' => [ |
| 92 | $property => $values |
| 93 | ] |
| 94 | ]); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Returns a directory from the service file storage |
| 99 | * |
| 100 | * @param string $id |
| 101 | * @return tao_models_classes_service_StorageDirectory |
| 102 | */ |
| 103 | protected function getDirectory($id) |
| 104 | { |
| 105 | return $this |
| 106 | ->getServiceLocator() |
| 107 | ->get(tao_models_classes_service_FileStorage::SERVICE_ID) |
| 108 | ->getDirectoryById($id); |
| 109 | } |
| 110 | } |