Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
100.00% |
3 / 3 |
|
100.00% |
2 / 2 |
CRAP | |
100.00% |
1 / 1 |
| AbstractModule | |
100.00% |
3 / 3 |
|
100.00% |
2 / 2 |
4 | |
100.00% |
1 / 1 |
| application | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| isRegistered | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
3 | |||
| register | n/a |
0 / 0 |
n/a |
0 / 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 | use Pop\AbstractApplication; |
| 19 | |
| 20 | /** |
| 21 | * Abstract module class |
| 22 | * |
| 23 | * @category Pop |
| 24 | * @package Pop |
| 25 | * @author Nick Sagona, III <nick@popphp.org> |
| 26 | * @copyright Copyright (c) 2009-2026 Nick Sagona, III |
| 27 | * @license https://www.popphp.org/license New BSD License |
| 28 | * @version 5.0.0 |
| 29 | */ |
| 30 | abstract class AbstractModule extends AbstractApplication implements ModuleInterface |
| 31 | { |
| 32 | |
| 33 | /** |
| 34 | * Application |
| 35 | * @var ?Application |
| 36 | */ |
| 37 | protected ?Application $application = null; |
| 38 | |
| 39 | /** |
| 40 | * Get application |
| 41 | * |
| 42 | * @return Application |
| 43 | */ |
| 44 | public function application(): Application |
| 45 | { |
| 46 | return $this->application; |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * Determine if the module has been registered with an application object |
| 51 | * |
| 52 | * @return bool |
| 53 | */ |
| 54 | public function isRegistered(): bool |
| 55 | { |
| 56 | return (($this->application !== null) && |
| 57 | ($this->application->modules() !== null) && ($this->application->modules()->hasModule($this))); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Register module |
| 62 | * |
| 63 | * @param Application $application |
| 64 | * @return AbstractModule |
| 65 | */ |
| 66 | abstract public function register(Application $application): AbstractModule; |
| 67 | |
| 68 | } |