Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 11 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 1 |
| ControllerDescription | |
0.00% |
0 / 11 |
|
0.00% |
0 / 3 |
110 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getClassName | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getActions | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
72 | |||
| 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) 2014-2021 (original work) Open Assessment Technologies SA; |
| 19 | */ |
| 20 | |
| 21 | namespace oat\tao\model\controllerMap; |
| 22 | |
| 23 | use oat\tao\model\http\Controller; |
| 24 | use oat\tao\model\routing\Contract\ActionInterface; |
| 25 | use ReflectionClass; |
| 26 | use ReflectionMethod; |
| 27 | |
| 28 | /** |
| 29 | * Description of a Tao Controller |
| 30 | * |
| 31 | * @author Joel Bout <joel@taotesting.com> |
| 32 | */ |
| 33 | class ControllerDescription |
| 34 | { |
| 35 | private static $BLACK_LIST = ['forward', 'redirect', 'forwardUrl', 'setView']; |
| 36 | /** |
| 37 | * Reflection of the controller |
| 38 | * |
| 39 | * @var ReflectionClass |
| 40 | */ |
| 41 | private $class; |
| 42 | |
| 43 | /** |
| 44 | * Create a new lazy parsing controller description |
| 45 | * |
| 46 | * @param ReflectionClass $controllerClass |
| 47 | */ |
| 48 | public function __construct(ReflectionClass $controllerClass) |
| 49 | { |
| 50 | $this->class = $controllerClass; |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Returns the class name of the controller |
| 55 | * |
| 56 | * @return string |
| 57 | */ |
| 58 | public function getClassName() |
| 59 | { |
| 60 | return $this->class->getName(); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Returns ann array of ActionDescription objects |
| 65 | * |
| 66 | * @return array |
| 67 | */ |
| 68 | public function getActions() |
| 69 | { |
| 70 | $actions = []; |
| 71 | |
| 72 | foreach ($this->class->getMethods(ReflectionMethod::IS_PUBLIC) as $m) { |
| 73 | if ($m->isConstructor() || $m->isDestructor() || in_array($m->name, self::$BLACK_LIST)) { |
| 74 | continue; |
| 75 | } |
| 76 | |
| 77 | if ( |
| 78 | is_subclass_of($m->class, 'Module') || |
| 79 | is_subclass_of($m->class, Controller::class) || |
| 80 | $this->class->implementsInterface(ActionInterface::class) |
| 81 | ) { |
| 82 | $actions[] = new ActionDescription($m); |
| 83 | } |
| 84 | } |
| 85 | |
| 86 | return $actions; |
| 87 | } |
| 88 | } |