Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 1 | <?php |
| 2 | declare(strict_types=1); |
| 3 | /** |
| 4 | * Pop PHP Framework (https://www.popphp.org/) |
| 5 | * |
| 6 | * @link https://github.com/popphp/popphp-framework |
| 7 | * @author Nick Sagona, III <nick@popphp.org> |
| 8 | * @copyright Copyright (c) 2009-2026 Nick Sagona, III |
| 9 | * @license https://www.popphp.org/license New BSD License |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * @namespace |
| 14 | */ |
| 15 | namespace Pop\Module; |
| 16 | |
| 17 | use Pop\Application; |
| 18 | |
| 19 | /** |
| 20 | * Pop router interface |
| 21 | * |
| 22 | * @category Pop |
| 23 | * @package Pop\Module |
| 24 | * @author Nick Sagona, III <nick@popphp.org> |
| 25 | * @copyright Copyright (c) 2009-2026 Nick Sagona, III |
| 26 | * @license https://www.popphp.org/license New BSD License |
| 27 | * @version 5.0.0 |
| 28 | */ |
| 29 | interface ModuleInterface |
| 30 | { |
| 31 | |
| 32 | /** |
| 33 | * Set name |
| 34 | * |
| 35 | * @param string $name |
| 36 | * @return static |
| 37 | */ |
| 38 | public function setName(string $name): static; |
| 39 | |
| 40 | /** |
| 41 | * Get name |
| 42 | * |
| 43 | * @return string |
| 44 | */ |
| 45 | public function getName(): string; |
| 46 | |
| 47 | /** |
| 48 | * Get application |
| 49 | * |
| 50 | * @return Application |
| 51 | */ |
| 52 | public function application(): Application; |
| 53 | |
| 54 | /** |
| 55 | * Determine if the module has been registered with an application object |
| 56 | * |
| 57 | * @return bool |
| 58 | */ |
| 59 | public function isRegistered(): bool; |
| 60 | |
| 61 | /** |
| 62 | * Register the module |
| 63 | * |
| 64 | * @param Application $application |
| 65 | * @return ModuleInterface |
| 66 | */ |
| 67 | public function register(Application $application): ModuleInterface; |
| 68 | |
| 69 | } |