Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 10 |
|
0.00% |
0 / 2 |
CRAP | |
0.00% |
0 / 1 |
| AbstractAuthService | |
0.00% |
0 / 10 |
|
0.00% |
0 / 2 |
90 | |
0.00% |
0 / 1 |
| getTypes | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
6 | |||
| getAuthType | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
56 | |||
| 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) 2018 (original work) Open Assessment Technologies SA; |
| 19 | * |
| 20 | * @author Alexander Zagovorichev <olexander.zagovorychev@1pt.com> |
| 21 | */ |
| 22 | |
| 23 | namespace oat\tao\model\auth; |
| 24 | |
| 25 | use oat\oatbox\service\ConfigurableService; |
| 26 | |
| 27 | /** |
| 28 | * Class AbstractAuthService |
| 29 | * @package oat\tao\model\auth |
| 30 | */ |
| 31 | abstract class AbstractAuthService extends ConfigurableService |
| 32 | { |
| 33 | public const OPTION_TYPES = 'types'; |
| 34 | public const OPTION_DEFAULT_TYPE = 'type'; |
| 35 | |
| 36 | /** |
| 37 | * Get all available type from config |
| 38 | * |
| 39 | * @return array of the auth types from the configuration file |
| 40 | */ |
| 41 | public function getTypes() |
| 42 | { |
| 43 | return $this->hasOption(self::OPTION_TYPES) ? $this->getOption(self::OPTION_TYPES) : []; |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Get the authType form config |
| 48 | * |
| 49 | * @param \core_kernel_classes_Resource|null $resource |
| 50 | * @return AbstractAuthType |
| 51 | * @throws \common_Exception |
| 52 | */ |
| 53 | public function getAuthType(\core_kernel_classes_Resource $resource = null) |
| 54 | { |
| 55 | if ($resource) { |
| 56 | $authTypeUri = $resource->getUri(); |
| 57 | foreach ($this->getOption(self::OPTION_TYPES) as $type) { |
| 58 | if ($type instanceof AbstractAuthType && $type->getAuthClass()->getUri() == $authTypeUri) { |
| 59 | $authType = $type; |
| 60 | } |
| 61 | } |
| 62 | } else { |
| 63 | $authType = $this->getOption(self::OPTION_DEFAULT_TYPE); |
| 64 | } |
| 65 | |
| 66 | if (!isset($authType) || !is_a($authType, AbstractAuthType::class)) { |
| 67 | throw new \common_Exception('Auth type not defined'); |
| 68 | } |
| 69 | |
| 70 | return $authType; |
| 71 | } |
| 72 | } |