Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 6 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 1 |
| AbstractRoute | |
0.00% |
0 / 6 |
|
0.00% |
0 / 4 |
20 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
2 | |||
| getExtension | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getConfig | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getId | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| resolve | n/a |
0 / 0 |
n/a |
0 / 0 |
0 | |||||
| 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) 2019 (original work) Open Assessment Technologies SA; |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\tao\model\routing; |
| 23 | |
| 24 | use common_ext_Extension; |
| 25 | use Psr\Http\Message\ServerRequestInterface; |
| 26 | |
| 27 | /** |
| 28 | * Interface of a router, that based on a relative Url |
| 29 | * and its configuration provided as $routeData |
| 30 | * decides which methode of which controller should be executed |
| 31 | * |
| 32 | * @author Joel Bout, <joel@taotesting.com> |
| 33 | */ |
| 34 | abstract class AbstractRoute implements Route |
| 35 | { |
| 36 | /** |
| 37 | * Owner of the route |
| 38 | * |
| 39 | * @var common_ext_Extension |
| 40 | */ |
| 41 | private $extension; |
| 42 | |
| 43 | /** |
| 44 | * Id of the route |
| 45 | * |
| 46 | * @var string |
| 47 | */ |
| 48 | private $id; |
| 49 | |
| 50 | /** |
| 51 | * Data the route requires to resolve |
| 52 | * |
| 53 | * @var mixed |
| 54 | */ |
| 55 | private $config; |
| 56 | |
| 57 | /** |
| 58 | * |
| 59 | * @param common_ext_Extension $extension |
| 60 | * @param string $routeId |
| 61 | * @param mixed $routeConfig |
| 62 | */ |
| 63 | public function __construct(common_ext_Extension $extension, $routeId, $routeConfig) |
| 64 | { |
| 65 | $this->extension = $extension; |
| 66 | $this->id = $routeId; |
| 67 | $this->config = $routeConfig; |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * |
| 72 | * @return common_ext_Extension |
| 73 | */ |
| 74 | protected function getExtension() |
| 75 | { |
| 76 | return $this->extension; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * |
| 81 | * @return mixed |
| 82 | */ |
| 83 | protected function getConfig() |
| 84 | { |
| 85 | return $this->config; |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * |
| 90 | * @return string |
| 91 | */ |
| 92 | protected function getId() |
| 93 | { |
| 94 | return $this->id; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Returns the name of the controller and action to call |
| 99 | * or null if it doesn't apply |
| 100 | * @param ServerRequestInterface $request |
| 101 | * @return string |
| 102 | */ |
| 103 | abstract public function resolve(ServerRequestInterface $request); |
| 104 | } |