Initial release: Core PHP modular monolith framework
- Event-driven architecture with lazy module loading - ModuleScanner, ModuleRegistry, LazyModuleListener for module discovery - 7 lifecycle events: Web, Admin, API, Client, Console, MCP, FrameworkBooted - AdminMenuProvider and ServiceDefinition contracts - Artisan commands: make:mod, make:website, make:plug - Module stubs for rapid scaffolding - Comprehensive test suite with Orchestra Testbench - GitHub Actions CI for PHP 8.2-8.4 / Laravel 11-12 - EUPL-1.2 license Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Snider
commit
392678e68a
39 changed files with 2658 additions and 0 deletions
43
.github/workflows/tests.yml
vendored
Normal file
43
.github/workflows/tests.yml
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
name: Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
tests:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: true
|
||||||
|
matrix:
|
||||||
|
php: [8.2, 8.3, 8.4]
|
||||||
|
laravel: [11.*, 12.*]
|
||||||
|
exclude:
|
||||||
|
- php: 8.2
|
||||||
|
laravel: 12.*
|
||||||
|
|
||||||
|
name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup PHP
|
||||||
|
uses: shivammathur/setup-php@v2
|
||||||
|
with:
|
||||||
|
php-version: ${{ matrix.php }}
|
||||||
|
extensions: dom, curl, libxml, mbstring, zip
|
||||||
|
coverage: none
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
env:
|
||||||
|
LARAVEL_VERSION: ${{ matrix.laravel }}
|
||||||
|
run: |
|
||||||
|
composer require "laravel/framework:${LARAVEL_VERSION}" --no-interaction --no-update
|
||||||
|
composer update --prefer-dist --no-interaction --no-progress
|
||||||
|
|
||||||
|
- name: Execute tests
|
||||||
|
run: vendor/bin/phpunit
|
||||||
7
.gitignore
vendored
Normal file
7
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
/vendor/
|
||||||
|
/.phpunit.cache/
|
||||||
|
composer.lock
|
||||||
|
.DS_Store
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
113
CLAUDE.md
Normal file
113
CLAUDE.md
Normal file
|
|
@ -0,0 +1,113 @@
|
||||||
|
# Core PHP Framework
|
||||||
|
|
||||||
|
A modular monolith framework for Laravel. This is the open-source foundation extracted from Host Hub.
|
||||||
|
|
||||||
|
## Quick Reference
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer test # Run tests
|
||||||
|
composer install # Install dependencies
|
||||||
|
```
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
### Event-Driven Module Loading
|
||||||
|
|
||||||
|
1. **ModuleScanner** scans directories for `Boot.php` files with `$listens` arrays
|
||||||
|
2. **ModuleRegistry** wires lazy listeners for each event-module pair
|
||||||
|
3. **LazyModuleListener** defers module instantiation until events fire
|
||||||
|
4. **LifecycleEventProvider** fires events and processes collected requests
|
||||||
|
|
||||||
|
### Lifecycle Events
|
||||||
|
|
||||||
|
Located in `src/Core/Events/`:
|
||||||
|
|
||||||
|
- `WebRoutesRegistering` - public web routes
|
||||||
|
- `AdminPanelBooting` - admin panel
|
||||||
|
- `ApiRoutesRegistering` - REST API
|
||||||
|
- `ClientRoutesRegistering` - authenticated client routes
|
||||||
|
- `ConsoleBooting` - artisan commands
|
||||||
|
- `McpToolsRegistering` - MCP tools
|
||||||
|
- `FrameworkBooted` - late initialisation
|
||||||
|
|
||||||
|
### Key Classes
|
||||||
|
|
||||||
|
| Class | Location | Purpose |
|
||||||
|
|-------|----------|---------|
|
||||||
|
| `CoreServiceProvider` | `src/Core/` | Package entry point |
|
||||||
|
| `LifecycleEventProvider` | `src/Core/` | Fires events, processes requests |
|
||||||
|
| `ModuleScanner` | `src/Core/Module/` | Scans for `$listens` declarations |
|
||||||
|
| `ModuleRegistry` | `src/Core/Module/` | Wires lazy listeners |
|
||||||
|
| `LazyModuleListener` | `src/Core/Module/` | Deferred module instantiation |
|
||||||
|
|
||||||
|
### Contracts
|
||||||
|
|
||||||
|
- `AdminMenuProvider` - admin navigation interface
|
||||||
|
- `ServiceDefinition` - SaaS service registration
|
||||||
|
|
||||||
|
## File Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
src/Core/
|
||||||
|
├── CoreServiceProvider.php # Package entry
|
||||||
|
├── LifecycleEventProvider.php # Event firing
|
||||||
|
├── Events/ # Lifecycle events
|
||||||
|
│ ├── LifecycleEvent.php # Base class
|
||||||
|
│ ├── WebRoutesRegistering.php
|
||||||
|
│ ├── AdminPanelBooting.php
|
||||||
|
│ └── ...
|
||||||
|
├── Module/ # Module system
|
||||||
|
│ ├── ModuleScanner.php
|
||||||
|
│ ├── ModuleRegistry.php
|
||||||
|
│ └── LazyModuleListener.php
|
||||||
|
├── Front/ # Frontage contracts
|
||||||
|
│ └── Admin/Contracts/
|
||||||
|
│ └── AdminMenuProvider.php
|
||||||
|
├── Service/Contracts/
|
||||||
|
│ └── ServiceDefinition.php
|
||||||
|
└── Console/Commands/ # Artisan commands
|
||||||
|
├── MakeModCommand.php
|
||||||
|
├── MakeWebsiteCommand.php
|
||||||
|
└── MakePlugCommand.php
|
||||||
|
```
|
||||||
|
|
||||||
|
## Module Pattern
|
||||||
|
|
||||||
|
```php
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Mod\Example;
|
||||||
|
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
|
||||||
|
class Boot
|
||||||
|
{
|
||||||
|
public static array $listens = [
|
||||||
|
WebRoutesRegistering::class => 'onWebRoutes',
|
||||||
|
];
|
||||||
|
|
||||||
|
public function onWebRoutes(WebRoutesRegistering $event): void
|
||||||
|
{
|
||||||
|
$event->views('example', __DIR__.'/Views');
|
||||||
|
$event->routes(fn () => require __DIR__.'/Routes/web.php');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Namespacing
|
||||||
|
|
||||||
|
Default namespace detection:
|
||||||
|
- `/Core` paths → `Core\` namespace
|
||||||
|
- `/Mod` paths → `Mod\` namespace
|
||||||
|
- `/Website` paths → `Website\` namespace
|
||||||
|
- `/Plug` paths → `Plug\` namespace
|
||||||
|
|
||||||
|
Custom mapping via `ModuleScanner::setNamespaceMap()`.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
Tests use Orchestra Testbench. Fixtures in `tests/Fixtures/`.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
EUPL-1.2 (copyleft, GPL-compatible).
|
||||||
287
LICENSE
Normal file
287
LICENSE
Normal file
|
|
@ -0,0 +1,287 @@
|
||||||
|
EUROPEAN UNION PUBLIC LICENCE v. 1.2
|
||||||
|
EUPL © the European Union 2007, 2016
|
||||||
|
|
||||||
|
This European Union Public Licence (the 'EUPL') applies to the Work (as defined
|
||||||
|
below) which is provided under the terms of this Licence. Any use of the Work,
|
||||||
|
other than as authorised under this Licence is prohibited (to the extent such
|
||||||
|
use is covered by a right of the copyright holder of the Work).
|
||||||
|
|
||||||
|
The Work is provided under the terms of this Licence when the Licensor (as
|
||||||
|
defined below) has placed the following notice immediately following the
|
||||||
|
copyright notice for the Work:
|
||||||
|
|
||||||
|
Licensed under the EUPL
|
||||||
|
|
||||||
|
or has expressed by any other means his willingness to license under the EUPL.
|
||||||
|
|
||||||
|
1. Definitions
|
||||||
|
|
||||||
|
In this Licence, the following terms have the following meaning:
|
||||||
|
|
||||||
|
- 'The Licence': this Licence.
|
||||||
|
|
||||||
|
- 'The Original Work': the work or software distributed or communicated by the
|
||||||
|
Licensor under this Licence, available as Source Code and also as Executable
|
||||||
|
Code as the case may be.
|
||||||
|
|
||||||
|
- 'Derivative Works': the works or software that could be created by the
|
||||||
|
Licensee, based upon the Original Work or modifications thereof. This Licence
|
||||||
|
does not define the extent of modification or dependence on the Original Work
|
||||||
|
required in order to classify a work as a Derivative Work; this extent is
|
||||||
|
determined by copyright law applicable in the country mentioned in Article 15.
|
||||||
|
|
||||||
|
- 'The Work': the Original Work or its Derivative Works.
|
||||||
|
|
||||||
|
- 'The Source Code': the human-readable form of the Work which is the most
|
||||||
|
convenient for people to study and modify.
|
||||||
|
|
||||||
|
- 'The Executable Code': any code which has generally been compiled and which is
|
||||||
|
meant to be interpreted by a computer as a program.
|
||||||
|
|
||||||
|
- 'The Licensor': the natural or legal person that distributes or communicates
|
||||||
|
the Work under the Licence.
|
||||||
|
|
||||||
|
- 'Contributor(s)': any natural or legal person who modifies the Work under the
|
||||||
|
Licence, or otherwise contributes to the creation of a Derivative Work.
|
||||||
|
|
||||||
|
- 'The Licensee' or 'You': any natural or legal person who makes any usage of
|
||||||
|
the Work under the terms of the Licence.
|
||||||
|
|
||||||
|
- 'Distribution' or 'Communication': any act of selling, giving, lending,
|
||||||
|
renting, distributing, communicating, transmitting, or otherwise making
|
||||||
|
available, online or offline, copies of the Work or providing access to its
|
||||||
|
essential functionalities at the disposal of any other natural or legal
|
||||||
|
person.
|
||||||
|
|
||||||
|
2. Scope of the rights granted by the Licence
|
||||||
|
|
||||||
|
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
|
||||||
|
sublicensable licence to do the following, for the duration of copyright vested
|
||||||
|
in the Original Work:
|
||||||
|
|
||||||
|
- use the Work in any circumstance and for all usage,
|
||||||
|
- reproduce the Work,
|
||||||
|
- modify the Work, and make Derivative Works based upon the Work,
|
||||||
|
- communicate to the public, including the right to make available or display
|
||||||
|
the Work or copies thereof to the public and perform publicly, as the case may
|
||||||
|
be, the Work,
|
||||||
|
- distribute the Work or copies thereof,
|
||||||
|
- lend and rent the Work or copies thereof,
|
||||||
|
- sublicense rights in the Work or copies thereof.
|
||||||
|
|
||||||
|
Those rights can be exercised on any media, supports and formats, whether now
|
||||||
|
known or later invented, as far as the applicable law permits so.
|
||||||
|
|
||||||
|
In the countries where moral rights apply, the Licensor waives his right to
|
||||||
|
exercise his moral right to the extent allowed by law in order to make effective
|
||||||
|
the licence of the economic rights here above listed.
|
||||||
|
|
||||||
|
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
|
||||||
|
any patents held by the Licensor, to the extent necessary to make use of the
|
||||||
|
rights granted on the Work under this Licence.
|
||||||
|
|
||||||
|
3. Communication of the Source Code
|
||||||
|
|
||||||
|
The Licensor may provide the Work either in its Source Code form, or as
|
||||||
|
Executable Code. If the Work is provided as Executable Code, the Licensor
|
||||||
|
provides in addition a machine-readable copy of the Source Code of the Work
|
||||||
|
along with each copy of the Work that the Licensor distributes or indicates, in
|
||||||
|
a notice following the copyright notice attached to the Work, a repository where
|
||||||
|
the Source Code is easily and freely accessible for as long as the Licensor
|
||||||
|
continues to distribute or communicate the Work.
|
||||||
|
|
||||||
|
4. Limitations on copyright
|
||||||
|
|
||||||
|
Nothing in this Licence is intended to deprive the Licensee of the benefits from
|
||||||
|
any exception or limitation to the exclusive rights of the rights owners in the
|
||||||
|
Work, of the exhaustion of those rights or of other applicable limitations
|
||||||
|
thereto.
|
||||||
|
|
||||||
|
5. Obligations of the Licensee
|
||||||
|
|
||||||
|
The grant of the rights mentioned above is subject to some restrictions and
|
||||||
|
obligations imposed on the Licensee. Those obligations are the following:
|
||||||
|
|
||||||
|
Attribution right: The Licensee shall keep intact all copyright, patent or
|
||||||
|
trademarks notices and all notices that refer to the Licence and to the
|
||||||
|
disclaimer of warranties. The Licensee must include a copy of such notices and a
|
||||||
|
copy of the Licence with every copy of the Work he/she distributes or
|
||||||
|
communicates. The Licensee must cause any Derivative Work to carry prominent
|
||||||
|
notices stating that the Work has been modified and the date of modification.
|
||||||
|
|
||||||
|
Copyleft clause: If the Licensee distributes or communicates copies of the
|
||||||
|
Original Works or Derivative Works, this Distribution or Communication will be
|
||||||
|
done under the terms of this Licence or of a later version of this Licence
|
||||||
|
unless the Original Work is expressly distributed only under this version of the
|
||||||
|
Licence — for example by communicating 'EUPL v. 1.2 only'. The Licensee
|
||||||
|
(becoming Licensor) cannot offer or impose any additional terms or conditions on
|
||||||
|
the Work or Derivative Work that alter or restrict the terms of the Licence.
|
||||||
|
|
||||||
|
Compatibility clause: If the Licensee Distributes or Communicates Derivative
|
||||||
|
Works or copies thereof based upon both the Work and another work licensed under
|
||||||
|
a Compatible Licence, this Distribution or Communication can be done under the
|
||||||
|
terms of this Compatible Licence. For the sake of this clause, 'Compatible
|
||||||
|
Licence' refers to the licences listed in the appendix attached to this Licence.
|
||||||
|
Should the Licensee's obligations under the Compatible Licence conflict with
|
||||||
|
his/her obligations under this Licence, the obligations of the Compatible
|
||||||
|
Licence shall prevail.
|
||||||
|
|
||||||
|
Provision of Source Code: When distributing or communicating copies of the Work,
|
||||||
|
the Licensee will provide a machine-readable copy of the Source Code or indicate
|
||||||
|
a repository where this Source will be easily and freely available for as long
|
||||||
|
as the Licensee continues to distribute or communicate the Work.
|
||||||
|
|
||||||
|
Legal Protection: This Licence does not grant permission to use the trade names,
|
||||||
|
trademarks, service marks, or names of the Licensor, except as required for
|
||||||
|
reasonable and customary use in describing the origin of the Work and
|
||||||
|
reproducing the content of the copyright notice.
|
||||||
|
|
||||||
|
6. Chain of Authorship
|
||||||
|
|
||||||
|
The original Licensor warrants that the copyright in the Original Work granted
|
||||||
|
hereunder is owned by him/her or licensed to him/her and that he/she has the
|
||||||
|
power and authority to grant the Licence.
|
||||||
|
|
||||||
|
Each Contributor warrants that the copyright in the modifications he/she brings
|
||||||
|
to the Work are owned by him/her or licensed to him/her and that he/she has the
|
||||||
|
power and authority to grant the Licence.
|
||||||
|
|
||||||
|
Each time You accept the Licence, the original Licensor and subsequent
|
||||||
|
Contributors grant You a licence to their contributions to the Work, under the
|
||||||
|
terms of this Licence.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty
|
||||||
|
|
||||||
|
The Work is a work in progress, which is continuously improved by numerous
|
||||||
|
Contributors. It is not a finished work and may therefore contain defects or
|
||||||
|
'bugs' inherent to this type of development.
|
||||||
|
|
||||||
|
For the above reason, the Work is provided under the Licence on an 'as is' basis
|
||||||
|
and without warranties of any kind concerning the Work, including without
|
||||||
|
limitation merchantability, fitness for a particular purpose, absence of defects
|
||||||
|
or errors, accuracy, non-infringement of intellectual property rights other than
|
||||||
|
copyright as stated in Article 6 of this Licence.
|
||||||
|
|
||||||
|
This disclaimer of warranty is an essential part of the Licence and a condition
|
||||||
|
for the grant of any rights to the Work.
|
||||||
|
|
||||||
|
8. Disclaimer of Liability
|
||||||
|
|
||||||
|
Except in the cases of wilful misconduct or damages directly caused to natural
|
||||||
|
persons, the Licensor will in no circumstances be liable for any direct or
|
||||||
|
indirect, material or moral, damages of any kind, arising out of the Licence or
|
||||||
|
of the use of the Work, including without limitation, damages for loss of
|
||||||
|
goodwill, work stoppage, computer failure or malfunction, loss of data or any
|
||||||
|
commercial damage, even if the Licensor has been advised of the possibility of
|
||||||
|
such damage. However, the Licensor will be liable under statutory product
|
||||||
|
liability laws as far such laws apply to the Work.
|
||||||
|
|
||||||
|
9. Additional agreements
|
||||||
|
|
||||||
|
While distributing the Work, You may choose to conclude an additional agreement,
|
||||||
|
defining obligations or services consistent with this Licence. However, if
|
||||||
|
accepting obligations, You may act only on your own behalf and on your sole
|
||||||
|
responsibility, not on behalf of the original Licensor or any other Contributor,
|
||||||
|
and only if You agree to indemnify, defend, and hold each Contributor harmless
|
||||||
|
for any liability incurred by, or claims asserted against such Contributor by
|
||||||
|
the fact You have accepted any warranty or additional liability.
|
||||||
|
|
||||||
|
10. Acceptance of the Licence
|
||||||
|
|
||||||
|
The provisions of this Licence can be accepted by clicking on an icon 'I agree'
|
||||||
|
placed under the bottom of a window displaying the text of this Licence or by
|
||||||
|
affirming consent in any other similar way, in accordance with the rules of
|
||||||
|
applicable law. Clicking on that icon indicates your clear and irrevocable
|
||||||
|
acceptance of this Licence and all of its terms and conditions.
|
||||||
|
|
||||||
|
Similarly, you irrevocably accept this Licence and all of its terms and
|
||||||
|
conditions by exercising any rights granted to You by Article 2 of this Licence,
|
||||||
|
such as the use of the Work, the creation by You of a Derivative Work or the
|
||||||
|
Distribution or Communication by You of the Work or copies thereof.
|
||||||
|
|
||||||
|
11. Information to the public
|
||||||
|
|
||||||
|
In case of any Distribution or Communication of the Work by means of electronic
|
||||||
|
communication by You (for example, by offering to download the Work from a
|
||||||
|
remote location) the distribution channel or media (for example, a website) must
|
||||||
|
at least provide to the public the information requested by the applicable law
|
||||||
|
regarding the Licensor, the Licence and the way it may be accessible, concluded,
|
||||||
|
stored and reproduced by the Licensee.
|
||||||
|
|
||||||
|
12. Termination of the Licence
|
||||||
|
|
||||||
|
The Licence and the rights granted hereunder will terminate automatically upon
|
||||||
|
any breach by the Licensee of the terms of the Licence.
|
||||||
|
|
||||||
|
Such a termination will not terminate the licences of any person who has
|
||||||
|
received the Work from the Licensee under the Licence, provided such persons
|
||||||
|
remain in full compliance with the Licence.
|
||||||
|
|
||||||
|
13. Miscellaneous
|
||||||
|
|
||||||
|
Without prejudice of Article 9 above, the Licence represents the complete
|
||||||
|
agreement between the Parties as to the Work.
|
||||||
|
|
||||||
|
If any provision of the Licence is invalid or unenforceable under applicable
|
||||||
|
law, this will not affect the validity or enforceability of the Licence as a
|
||||||
|
whole. Such provision will be construed or reformed so as necessary to make it
|
||||||
|
valid and enforceable.
|
||||||
|
|
||||||
|
The European Commission may publish other linguistic versions or new versions of
|
||||||
|
this Licence or updated versions of the Appendix, so far this is required and
|
||||||
|
reasonable, without reducing the scope of the rights granted by the Licence. New
|
||||||
|
versions of the Licence will be published with a unique version number.
|
||||||
|
|
||||||
|
All linguistic versions of this Licence, approved by the European Commission,
|
||||||
|
have identical value. Parties can take advantage of the linguistic version of
|
||||||
|
their choice.
|
||||||
|
|
||||||
|
14. Jurisdiction
|
||||||
|
|
||||||
|
Without prejudice to specific agreement between parties,
|
||||||
|
|
||||||
|
- any litigation resulting from the interpretation of this License, arising
|
||||||
|
between the European Union institutions, bodies, offices or agencies, as a
|
||||||
|
Licensor, and any Licensee, will be subject to the jurisdiction of the Court
|
||||||
|
of Justice of the European Union, as laid down in article 272 of the Treaty on
|
||||||
|
the Functioning of the European Union,
|
||||||
|
|
||||||
|
- any litigation arising between other parties and resulting from the
|
||||||
|
interpretation of this License, will be subject to the exclusive jurisdiction
|
||||||
|
of the competent court where the Licensor resides or conducts its primary
|
||||||
|
business.
|
||||||
|
|
||||||
|
15. Applicable Law
|
||||||
|
|
||||||
|
Without prejudice to specific agreement between parties,
|
||||||
|
|
||||||
|
- this Licence shall be governed by the law of the European Union Member State
|
||||||
|
where the Licensor has his seat, resides or has his registered office,
|
||||||
|
|
||||||
|
- this licence shall be governed by Belgian law if the Licensor has no seat,
|
||||||
|
residence or registered office inside a European Union Member State.
|
||||||
|
|
||||||
|
Appendix
|
||||||
|
|
||||||
|
'Compatible Licences' according to Article 5 EUPL are:
|
||||||
|
|
||||||
|
- GNU General Public License (GPL) v. 2, v. 3
|
||||||
|
- GNU Affero General Public License (AGPL) v. 3
|
||||||
|
- Open Software License (OSL) v. 2.1, v. 3.0
|
||||||
|
- Eclipse Public License (EPL) v. 1.0
|
||||||
|
- CeCILL v. 2.0, v. 2.1
|
||||||
|
- Mozilla Public Licence (MPL) v. 2
|
||||||
|
- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
|
||||||
|
- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
|
||||||
|
works other than software
|
||||||
|
- European Union Public Licence (EUPL) v. 1.1, v. 1.2
|
||||||
|
- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
|
||||||
|
Reciprocity (LiLiQ-R+).
|
||||||
|
|
||||||
|
The European Commission may update this Appendix to later versions of the above
|
||||||
|
licences without producing a new version of the EUPL, as long as they provide
|
||||||
|
the rights granted in Article 2 of this Licence and protect the covered Source
|
||||||
|
Code from exclusive appropriation.
|
||||||
|
|
||||||
|
All other changes or additions to this Appendix require the production of a new
|
||||||
|
EUPL version.
|
||||||
227
README.md
Normal file
227
README.md
Normal file
|
|
@ -0,0 +1,227 @@
|
||||||
|
# Core PHP Framework
|
||||||
|
|
||||||
|
A modular monolith framework for Laravel with event-driven architecture and lazy module loading.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer require host-uk/core
|
||||||
|
```
|
||||||
|
|
||||||
|
The service provider will be auto-discovered.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Publish the config file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan vendor:publish --tag=core-config
|
||||||
|
```
|
||||||
|
|
||||||
|
Configure your module paths in `config/core.php`:
|
||||||
|
|
||||||
|
```php
|
||||||
|
return [
|
||||||
|
'module_paths' => [
|
||||||
|
app_path('Core'),
|
||||||
|
app_path('Mod'),
|
||||||
|
],
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
|
## Creating Modules
|
||||||
|
|
||||||
|
Use the artisan commands to scaffold modules:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Create a full module
|
||||||
|
php artisan make:mod Commerce
|
||||||
|
|
||||||
|
# Create a website module (domain-scoped)
|
||||||
|
php artisan make:website Marketing
|
||||||
|
|
||||||
|
# Create a plugin
|
||||||
|
php artisan make:plug Stripe
|
||||||
|
```
|
||||||
|
|
||||||
|
## Module Structure
|
||||||
|
|
||||||
|
Modules are organised with a `Boot.php` entry point:
|
||||||
|
|
||||||
|
```
|
||||||
|
app/Mod/Commerce/
|
||||||
|
├── Boot.php
|
||||||
|
├── Routes/
|
||||||
|
│ ├── web.php
|
||||||
|
│ ├── admin.php
|
||||||
|
│ └── api.php
|
||||||
|
├── Views/
|
||||||
|
└── config.php
|
||||||
|
```
|
||||||
|
|
||||||
|
## Lifecycle Events
|
||||||
|
|
||||||
|
Modules declare interest in lifecycle events via a static `$listens` array:
|
||||||
|
|
||||||
|
```php
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Mod\Commerce;
|
||||||
|
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
use Core\Events\AdminPanelBooting;
|
||||||
|
|
||||||
|
class Boot
|
||||||
|
{
|
||||||
|
public static array $listens = [
|
||||||
|
WebRoutesRegistering::class => 'onWebRoutes',
|
||||||
|
AdminPanelBooting::class => 'onAdmin',
|
||||||
|
];
|
||||||
|
|
||||||
|
public function onWebRoutes(WebRoutesRegistering $event): void
|
||||||
|
{
|
||||||
|
$event->views('commerce', __DIR__.'/Views');
|
||||||
|
$event->routes(fn () => require __DIR__.'/Routes/web.php');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onAdmin(AdminPanelBooting $event): void
|
||||||
|
{
|
||||||
|
$event->routes(fn () => require __DIR__.'/Routes/admin.php');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Available Events
|
||||||
|
|
||||||
|
| Event | Purpose |
|
||||||
|
|-------|---------|
|
||||||
|
| `WebRoutesRegistering` | Public-facing web routes |
|
||||||
|
| `AdminPanelBooting` | Admin panel routes and navigation |
|
||||||
|
| `ApiRoutesRegistering` | REST API endpoints |
|
||||||
|
| `ClientRoutesRegistering` | Authenticated client/workspace routes |
|
||||||
|
| `ConsoleBooting` | Artisan commands |
|
||||||
|
| `McpToolsRegistering` | MCP tool handlers |
|
||||||
|
| `FrameworkBooted` | Late-stage initialisation |
|
||||||
|
|
||||||
|
### Event Methods
|
||||||
|
|
||||||
|
Events collect requests from modules:
|
||||||
|
|
||||||
|
```php
|
||||||
|
// Register routes
|
||||||
|
$event->routes(fn () => require __DIR__.'/routes.php');
|
||||||
|
|
||||||
|
// Register view namespace
|
||||||
|
$event->views('namespace', __DIR__.'/Views');
|
||||||
|
|
||||||
|
// Register Livewire component
|
||||||
|
$event->livewire('alias', ComponentClass::class);
|
||||||
|
|
||||||
|
// Register navigation item
|
||||||
|
$event->navigation(['label' => 'Products', 'icon' => 'box']);
|
||||||
|
|
||||||
|
// Register Artisan command (ConsoleBooting)
|
||||||
|
$event->command(MyCommand::class);
|
||||||
|
|
||||||
|
// Register middleware alias
|
||||||
|
$event->middleware('alias', MiddlewareClass::class);
|
||||||
|
|
||||||
|
// Register translations
|
||||||
|
$event->translations('namespace', __DIR__.'/lang');
|
||||||
|
|
||||||
|
// Register Blade component path
|
||||||
|
$event->bladeComponentPath(__DIR__.'/components', 'prefix');
|
||||||
|
|
||||||
|
// Register policy
|
||||||
|
$event->policy(Model::class, Policy::class);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Firing Events
|
||||||
|
|
||||||
|
Create frontage service providers to fire events at appropriate times:
|
||||||
|
|
||||||
|
```php
|
||||||
|
use Core\LifecycleEventProvider;
|
||||||
|
|
||||||
|
class WebServiceProvider extends ServiceProvider
|
||||||
|
{
|
||||||
|
public function boot(): void
|
||||||
|
{
|
||||||
|
LifecycleEventProvider::fireWebRoutes();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Lazy Loading
|
||||||
|
|
||||||
|
Modules are only instantiated when their subscribed events fire. A web request doesn't load admin-only modules. An API request doesn't load web modules. This keeps your application fast.
|
||||||
|
|
||||||
|
## Custom Namespace Mapping
|
||||||
|
|
||||||
|
For non-standard directory structures:
|
||||||
|
|
||||||
|
```php
|
||||||
|
$scanner = app(ModuleScanner::class);
|
||||||
|
$scanner->setNamespaceMap([
|
||||||
|
'CustomMod' => 'App\\CustomMod',
|
||||||
|
]);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contracts
|
||||||
|
|
||||||
|
### AdminMenuProvider
|
||||||
|
|
||||||
|
Implement for admin navigation:
|
||||||
|
|
||||||
|
```php
|
||||||
|
use Core\Front\Admin\Contracts\AdminMenuProvider;
|
||||||
|
|
||||||
|
class Boot implements AdminMenuProvider
|
||||||
|
{
|
||||||
|
public function adminMenuItems(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
[
|
||||||
|
'group' => 'services',
|
||||||
|
'priority' => 20,
|
||||||
|
'item' => fn () => [
|
||||||
|
'label' => 'Products',
|
||||||
|
'icon' => 'box',
|
||||||
|
'href' => route('admin.products.index'),
|
||||||
|
],
|
||||||
|
],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### ServiceDefinition
|
||||||
|
|
||||||
|
For SaaS service registration:
|
||||||
|
|
||||||
|
```php
|
||||||
|
use Core\Service\Contracts\ServiceDefinition;
|
||||||
|
|
||||||
|
class Boot implements ServiceDefinition
|
||||||
|
{
|
||||||
|
public static function definition(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'code' => 'commerce',
|
||||||
|
'module' => 'Commerce',
|
||||||
|
'name' => 'Commerce',
|
||||||
|
'tagline' => 'E-commerce platform',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer test
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
EUPL-1.2. See [LICENSE](LICENSE) for details.
|
||||||
42
composer.json
Normal file
42
composer.json
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
{
|
||||||
|
"name": "host-uk/core",
|
||||||
|
"description": "Modular monolith framework for Laravel - event-driven architecture with lazy module loading",
|
||||||
|
"keywords": ["laravel", "modular", "monolith", "framework", "events", "modules"],
|
||||||
|
"license": "EUPL-1.2",
|
||||||
|
"authors": [
|
||||||
|
{
|
||||||
|
"name": "Host UK",
|
||||||
|
"email": "dev@host.uk.com"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"require": {
|
||||||
|
"php": "^8.2",
|
||||||
|
"laravel/framework": "^11.0|^12.0"
|
||||||
|
},
|
||||||
|
"require-dev": {
|
||||||
|
"orchestra/testbench": "^9.0|^10.0",
|
||||||
|
"phpunit/phpunit": "^11.0"
|
||||||
|
},
|
||||||
|
"autoload": {
|
||||||
|
"psr-4": {
|
||||||
|
"Core\\": "src/Core/"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"autoload-dev": {
|
||||||
|
"psr-4": {
|
||||||
|
"Core\\Tests\\": "tests/"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"extra": {
|
||||||
|
"laravel": {
|
||||||
|
"providers": [
|
||||||
|
"Core\\CoreServiceProvider"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"config": {
|
||||||
|
"sort-packages": true
|
||||||
|
},
|
||||||
|
"minimum-stability": "stable",
|
||||||
|
"prefer-stable": true
|
||||||
|
}
|
||||||
26
config/core.php
Normal file
26
config/core.php
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
return [
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Module Paths
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Directories to scan for module Boot.php files with $listens declarations.
|
||||||
|
| Each path should be an absolute path to a directory containing modules.
|
||||||
|
|
|
||||||
|
| Example:
|
||||||
|
| 'module_paths' => [
|
||||||
|
| app_path('Core'),
|
||||||
|
| app_path('Mod'),
|
||||||
|
| ],
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'module_paths' => [
|
||||||
|
// app_path('Core'),
|
||||||
|
// app_path('Mod'),
|
||||||
|
],
|
||||||
|
|
||||||
|
];
|
||||||
26
phpunit.xml
Normal file
26
phpunit.xml
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
|
||||||
|
bootstrap="vendor/autoload.php"
|
||||||
|
colors="true"
|
||||||
|
cacheDirectory=".phpunit.cache"
|
||||||
|
executionOrder="random"
|
||||||
|
requireCoverageMetadata="false"
|
||||||
|
beStrictAboutCoverageMetadata="false"
|
||||||
|
beStrictAboutOutputDuringTests="true"
|
||||||
|
failOnRisky="true"
|
||||||
|
failOnWarning="true">
|
||||||
|
<testsuites>
|
||||||
|
<testsuite name="Feature">
|
||||||
|
<directory>tests/Feature</directory>
|
||||||
|
</testsuite>
|
||||||
|
<testsuite name="Unit">
|
||||||
|
<directory>tests/Unit</directory>
|
||||||
|
</testsuite>
|
||||||
|
</testsuites>
|
||||||
|
<source>
|
||||||
|
<include>
|
||||||
|
<directory>src</directory>
|
||||||
|
</include>
|
||||||
|
</source>
|
||||||
|
</phpunit>
|
||||||
107
src/Core/Console/Commands/MakeModCommand.php
Normal file
107
src/Core/Console/Commands/MakeModCommand.php
Normal file
|
|
@ -0,0 +1,107 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Console\Commands;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Filesystem\Filesystem;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
|
||||||
|
class MakeModCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'make:mod {name : The name of the module (e.g., Commerce)}';
|
||||||
|
|
||||||
|
protected $description = 'Create a new module with Boot.php and route files';
|
||||||
|
|
||||||
|
public function handle(Filesystem $files): int
|
||||||
|
{
|
||||||
|
$name = $this->argument('name');
|
||||||
|
$slug = Str::kebab($name);
|
||||||
|
$upperSlug = Str::upper(Str::snake($name));
|
||||||
|
|
||||||
|
$modulePath = app_path("Mod/{$name}");
|
||||||
|
|
||||||
|
if ($files->isDirectory($modulePath)) {
|
||||||
|
$this->error("Module [{$name}] already exists!");
|
||||||
|
|
||||||
|
return self::FAILURE;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create directory structure
|
||||||
|
$files->makeDirectory($modulePath, 0755, true);
|
||||||
|
$files->makeDirectory("{$modulePath}/Routes", 0755, true);
|
||||||
|
$files->makeDirectory("{$modulePath}/Views", 0755, true);
|
||||||
|
|
||||||
|
// Copy and process stubs
|
||||||
|
$stubPath = $this->getStubPath();
|
||||||
|
|
||||||
|
$replacements = [
|
||||||
|
'{{ name }}' => $name,
|
||||||
|
'{{ slug }}' => $slug,
|
||||||
|
'{{ upper_slug }}' => $upperSlug,
|
||||||
|
];
|
||||||
|
|
||||||
|
// Boot.php
|
||||||
|
$bootContent = $this->processStub(
|
||||||
|
$files->get("{$stubPath}/Boot.php.stub"),
|
||||||
|
$replacements
|
||||||
|
);
|
||||||
|
$files->put("{$modulePath}/Boot.php", $bootContent);
|
||||||
|
|
||||||
|
// Routes
|
||||||
|
$webRoutesContent = $this->processStub(
|
||||||
|
$files->get("{$stubPath}/Routes/web.php.stub"),
|
||||||
|
$replacements
|
||||||
|
);
|
||||||
|
$files->put("{$modulePath}/Routes/web.php", $webRoutesContent);
|
||||||
|
|
||||||
|
$adminRoutesContent = $this->processStub(
|
||||||
|
$files->get("{$stubPath}/Routes/admin.php.stub"),
|
||||||
|
$replacements
|
||||||
|
);
|
||||||
|
$files->put("{$modulePath}/Routes/admin.php", $adminRoutesContent);
|
||||||
|
|
||||||
|
$apiRoutesContent = $this->processStub(
|
||||||
|
$files->get("{$stubPath}/Routes/api.php.stub"),
|
||||||
|
$replacements
|
||||||
|
);
|
||||||
|
$files->put("{$modulePath}/Routes/api.php", $apiRoutesContent);
|
||||||
|
|
||||||
|
// Config
|
||||||
|
$configContent = $this->processStub(
|
||||||
|
$files->get("{$stubPath}/config.php.stub"),
|
||||||
|
$replacements
|
||||||
|
);
|
||||||
|
$files->put("{$modulePath}/config.php", $configContent);
|
||||||
|
|
||||||
|
$this->info("Module [{$name}] created successfully.");
|
||||||
|
$this->line(" <comment>app/Mod/{$name}/Boot.php</comment>");
|
||||||
|
$this->line(" <comment>app/Mod/{$name}/Routes/web.php</comment>");
|
||||||
|
$this->line(" <comment>app/Mod/{$name}/Routes/admin.php</comment>");
|
||||||
|
$this->line(" <comment>app/Mod/{$name}/Routes/api.php</comment>");
|
||||||
|
$this->line(" <comment>app/Mod/{$name}/config.php</comment>");
|
||||||
|
|
||||||
|
return self::SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getStubPath(): string
|
||||||
|
{
|
||||||
|
$customPath = base_path('stubs/core/Mod/Example');
|
||||||
|
|
||||||
|
if (is_dir($customPath)) {
|
||||||
|
return $customPath;
|
||||||
|
}
|
||||||
|
|
||||||
|
return __DIR__.'/../../../stubs/Mod/Example';
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function processStub(string $content, array $replacements): string
|
||||||
|
{
|
||||||
|
return str_replace(
|
||||||
|
array_keys($replacements),
|
||||||
|
array_values($replacements),
|
||||||
|
$content
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
73
src/Core/Console/Commands/MakePlugCommand.php
Normal file
73
src/Core/Console/Commands/MakePlugCommand.php
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Console\Commands;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Filesystem\Filesystem;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
|
||||||
|
class MakePlugCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'make:plug {name : The name of the plugin (e.g., Stripe)}';
|
||||||
|
|
||||||
|
protected $description = 'Create a new plugin module for third-party integrations';
|
||||||
|
|
||||||
|
public function handle(Filesystem $files): int
|
||||||
|
{
|
||||||
|
$name = $this->argument('name');
|
||||||
|
$slug = Str::kebab($name);
|
||||||
|
|
||||||
|
$modulePath = app_path("Plug/{$name}");
|
||||||
|
|
||||||
|
if ($files->isDirectory($modulePath)) {
|
||||||
|
$this->error("Plugin [{$name}] already exists!");
|
||||||
|
|
||||||
|
return self::FAILURE;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create directory structure
|
||||||
|
$files->makeDirectory($modulePath, 0755, true);
|
||||||
|
|
||||||
|
// Copy and process stubs
|
||||||
|
$stubPath = $this->getStubPath();
|
||||||
|
|
||||||
|
$replacements = [
|
||||||
|
'{{ name }}' => $name,
|
||||||
|
'{{ slug }}' => $slug,
|
||||||
|
];
|
||||||
|
|
||||||
|
// Boot.php
|
||||||
|
$bootContent = $this->processStub(
|
||||||
|
$files->get("{$stubPath}/Boot.php.stub"),
|
||||||
|
$replacements
|
||||||
|
);
|
||||||
|
$files->put("{$modulePath}/Boot.php", $bootContent);
|
||||||
|
|
||||||
|
$this->info("Plugin [{$name}] created successfully.");
|
||||||
|
$this->line(" <comment>app/Plug/{$name}/Boot.php</comment>");
|
||||||
|
|
||||||
|
return self::SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getStubPath(): string
|
||||||
|
{
|
||||||
|
$customPath = base_path('stubs/core/Plug/Example');
|
||||||
|
|
||||||
|
if (is_dir($customPath)) {
|
||||||
|
return $customPath;
|
||||||
|
}
|
||||||
|
|
||||||
|
return __DIR__.'/../../../stubs/Plug/Example';
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function processStub(string $content, array $replacements): string
|
||||||
|
{
|
||||||
|
return str_replace(
|
||||||
|
array_keys($replacements),
|
||||||
|
array_values($replacements),
|
||||||
|
$content
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
113
src/Core/Console/Commands/MakeWebsiteCommand.php
Normal file
113
src/Core/Console/Commands/MakeWebsiteCommand.php
Normal file
|
|
@ -0,0 +1,113 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Console\Commands;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Filesystem\Filesystem;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
|
||||||
|
class MakeWebsiteCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'make:website {name : The name of the website module (e.g., Marketing)}';
|
||||||
|
|
||||||
|
protected $description = 'Create a new website module for domain-scoped web properties';
|
||||||
|
|
||||||
|
public function handle(Filesystem $files): int
|
||||||
|
{
|
||||||
|
$name = $this->argument('name');
|
||||||
|
$slug = Str::kebab($name);
|
||||||
|
|
||||||
|
$modulePath = app_path("Website/{$name}");
|
||||||
|
|
||||||
|
if ($files->isDirectory($modulePath)) {
|
||||||
|
$this->error("Website [{$name}] already exists!");
|
||||||
|
|
||||||
|
return self::FAILURE;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create directory structure
|
||||||
|
$files->makeDirectory($modulePath, 0755, true);
|
||||||
|
$files->makeDirectory("{$modulePath}/Routes", 0755, true);
|
||||||
|
$files->makeDirectory("{$modulePath}/Views", 0755, true);
|
||||||
|
|
||||||
|
// Copy and process stubs
|
||||||
|
$stubPath = $this->getStubPath();
|
||||||
|
|
||||||
|
$replacements = [
|
||||||
|
'{{ name }}' => $name,
|
||||||
|
'{{ slug }}' => $slug,
|
||||||
|
];
|
||||||
|
|
||||||
|
// Boot.php
|
||||||
|
$bootContent = $this->processStub(
|
||||||
|
$files->get("{$stubPath}/Boot.php.stub"),
|
||||||
|
$replacements
|
||||||
|
);
|
||||||
|
$files->put("{$modulePath}/Boot.php", $bootContent);
|
||||||
|
|
||||||
|
// Create basic web routes file
|
||||||
|
$webRoutes = <<<PHP
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| {$name} Website Routes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
*/
|
||||||
|
|
||||||
|
Route::get('/', function () {
|
||||||
|
return view('{$slug}::index');
|
||||||
|
})->name('{$slug}.home');
|
||||||
|
PHP;
|
||||||
|
|
||||||
|
$files->put("{$modulePath}/Routes/web.php", $webRoutes);
|
||||||
|
|
||||||
|
// Create basic view
|
||||||
|
$indexView = <<<BLADE
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>{$name}</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>{$name}</h1>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
BLADE;
|
||||||
|
|
||||||
|
$files->put("{$modulePath}/Views/index.blade.php", $indexView);
|
||||||
|
|
||||||
|
$this->info("Website [{$name}] created successfully.");
|
||||||
|
$this->line(" <comment>app/Website/{$name}/Boot.php</comment>");
|
||||||
|
$this->line(" <comment>app/Website/{$name}/Routes/web.php</comment>");
|
||||||
|
$this->line(" <comment>app/Website/{$name}/Views/index.blade.php</comment>");
|
||||||
|
|
||||||
|
return self::SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getStubPath(): string
|
||||||
|
{
|
||||||
|
$customPath = base_path('stubs/core/Website/Example');
|
||||||
|
|
||||||
|
if (is_dir($customPath)) {
|
||||||
|
return $customPath;
|
||||||
|
}
|
||||||
|
|
||||||
|
return __DIR__.'/../../../stubs/Website/Example';
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function processStub(string $content, array $replacements): string
|
||||||
|
{
|
||||||
|
return str_replace(
|
||||||
|
array_keys($replacements),
|
||||||
|
array_values($replacements),
|
||||||
|
$content
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
73
src/Core/CoreServiceProvider.php
Normal file
73
src/Core/CoreServiceProvider.php
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core;
|
||||||
|
|
||||||
|
use Core\Console\Commands\MakeModCommand;
|
||||||
|
use Core\Console\Commands\MakePlugCommand;
|
||||||
|
use Core\Console\Commands\MakeWebsiteCommand;
|
||||||
|
use Core\Events\FrameworkBooted;
|
||||||
|
use Core\Module\ModuleRegistry;
|
||||||
|
use Core\Module\ModuleScanner;
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Core framework service provider.
|
||||||
|
*
|
||||||
|
* Manages lifecycle events for lazy module loading:
|
||||||
|
* 1. Scans modules for $listens declarations during register()
|
||||||
|
* 2. Wires up lazy listeners for each event-module pair
|
||||||
|
* 3. Fires lifecycle events at appropriate times during boot()
|
||||||
|
*
|
||||||
|
* Modules declare interest via static $listens arrays:
|
||||||
|
*
|
||||||
|
* public static array $listens = [
|
||||||
|
* WebRoutesRegistering::class => 'onWebRoutes',
|
||||||
|
* AdminPanelBooting::class => 'onAdmin',
|
||||||
|
* ];
|
||||||
|
*
|
||||||
|
* The module is only instantiated when its events fire.
|
||||||
|
*/
|
||||||
|
class CoreServiceProvider extends ServiceProvider
|
||||||
|
{
|
||||||
|
public function register(): void
|
||||||
|
{
|
||||||
|
$this->mergeConfigFrom(__DIR__.'/../../config/core.php', 'core');
|
||||||
|
|
||||||
|
$this->app->singleton(ModuleScanner::class);
|
||||||
|
$this->app->singleton(ModuleRegistry::class, function ($app) {
|
||||||
|
return new ModuleRegistry($app->make(ModuleScanner::class));
|
||||||
|
});
|
||||||
|
|
||||||
|
$paths = config('core.module_paths', []);
|
||||||
|
|
||||||
|
if (! empty($paths)) {
|
||||||
|
$registry = $this->app->make(ModuleRegistry::class);
|
||||||
|
$registry->register($paths);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function boot(): void
|
||||||
|
{
|
||||||
|
if ($this->app->runningInConsole()) {
|
||||||
|
$this->commands([
|
||||||
|
MakeModCommand::class,
|
||||||
|
MakeWebsiteCommand::class,
|
||||||
|
MakePlugCommand::class,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->publishes([
|
||||||
|
__DIR__.'/../../config/core.php' => config_path('core.php'),
|
||||||
|
], 'core-config');
|
||||||
|
|
||||||
|
$this->publishes([
|
||||||
|
__DIR__.'/../../stubs' => base_path('stubs/core'),
|
||||||
|
], 'core-stubs');
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->app->booted(function () {
|
||||||
|
event(new FrameworkBooted);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
21
src/Core/Events/AdminPanelBooting.php
Normal file
21
src/Core/Events/AdminPanelBooting.php
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the admin panel is being bootstrapped.
|
||||||
|
*
|
||||||
|
* Modules listen to this event to register:
|
||||||
|
* - Admin navigation items
|
||||||
|
* - Admin routes (wrapped with admin middleware)
|
||||||
|
* - Admin view namespaces
|
||||||
|
* - Admin Livewire components
|
||||||
|
*
|
||||||
|
* Only fired for requests to admin routes, not public pages or API calls.
|
||||||
|
*/
|
||||||
|
class AdminPanelBooting extends LifecycleEvent
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
18
src/Core/Events/ApiRoutesRegistering.php
Normal file
18
src/Core/Events/ApiRoutesRegistering.php
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when API routes are being registered.
|
||||||
|
*
|
||||||
|
* Modules listen to this event to register their REST API endpoints.
|
||||||
|
* Routes are automatically wrapped with the 'api' middleware group.
|
||||||
|
*
|
||||||
|
* Only fired for API requests, not web or admin requests.
|
||||||
|
*/
|
||||||
|
class ApiRoutesRegistering extends LifecycleEvent
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
23
src/Core/Events/ClientRoutesRegistering.php
Normal file
23
src/Core/Events/ClientRoutesRegistering.php
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when client routes are being registered.
|
||||||
|
*
|
||||||
|
* Modules listen to this event to register routes for authenticated
|
||||||
|
* SaaS customers managing their namespace/workspace.
|
||||||
|
*
|
||||||
|
* Routes are automatically wrapped with the 'client' middleware group.
|
||||||
|
*
|
||||||
|
* Use this for authenticated namespace management pages:
|
||||||
|
* - Settings pages
|
||||||
|
* - Analytics dashboards
|
||||||
|
* - Content editors
|
||||||
|
*/
|
||||||
|
class ClientRoutesRegistering extends LifecycleEvent
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
19
src/Core/Events/ConsoleBooting.php
Normal file
19
src/Core/Events/ConsoleBooting.php
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when running in console/CLI context.
|
||||||
|
*
|
||||||
|
* Modules listen to this event to register Artisan commands.
|
||||||
|
* Commands are registered via the command() method inherited
|
||||||
|
* from LifecycleEvent.
|
||||||
|
*
|
||||||
|
* Only fired when running artisan commands, not web requests.
|
||||||
|
*/
|
||||||
|
class ConsoleBooting extends LifecycleEvent
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
18
src/Core/Events/FrameworkBooted.php
Normal file
18
src/Core/Events/FrameworkBooted.php
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired after the framework has fully booted.
|
||||||
|
*
|
||||||
|
* Use this for late-stage initialisation that needs the full
|
||||||
|
* application context available. Most modules should use more
|
||||||
|
* specific events (AdminPanelBooting, ApiRoutesRegistering, etc.)
|
||||||
|
* rather than this general event.
|
||||||
|
*/
|
||||||
|
class FrameworkBooted extends LifecycleEvent
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
180
src/Core/Events/LifecycleEvent.php
Normal file
180
src/Core/Events/LifecycleEvent.php
Normal file
|
|
@ -0,0 +1,180 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base class for lifecycle events.
|
||||||
|
*
|
||||||
|
* Lifecycle events are fired at key points during application bootstrap.
|
||||||
|
* Modules listen to these events via static $listens arrays and register
|
||||||
|
* their resources (routes, views, navigation, etc.) through request methods.
|
||||||
|
*
|
||||||
|
* Core collects all requests and processes them with validation, ensuring
|
||||||
|
* modules cannot directly mutate infrastructure.
|
||||||
|
*/
|
||||||
|
abstract class LifecycleEvent
|
||||||
|
{
|
||||||
|
protected array $navigationRequests = [];
|
||||||
|
|
||||||
|
protected array $routeRequests = [];
|
||||||
|
|
||||||
|
protected array $viewRequests = [];
|
||||||
|
|
||||||
|
protected array $middlewareRequests = [];
|
||||||
|
|
||||||
|
protected array $livewireRequests = [];
|
||||||
|
|
||||||
|
protected array $commandRequests = [];
|
||||||
|
|
||||||
|
protected array $translationRequests = [];
|
||||||
|
|
||||||
|
protected array $bladeComponentRequests = [];
|
||||||
|
|
||||||
|
protected array $policyRequests = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request a navigation item be added.
|
||||||
|
*/
|
||||||
|
public function navigation(array $item): void
|
||||||
|
{
|
||||||
|
$this->navigationRequests[] = $item;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request routes be registered.
|
||||||
|
*/
|
||||||
|
public function routes(callable $callback): void
|
||||||
|
{
|
||||||
|
$this->routeRequests[] = $callback;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request a view namespace be registered.
|
||||||
|
*/
|
||||||
|
public function views(string $namespace, string $path): void
|
||||||
|
{
|
||||||
|
$this->viewRequests[] = [$namespace, $path];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request a middleware alias be registered.
|
||||||
|
*/
|
||||||
|
public function middleware(string $alias, string $class): void
|
||||||
|
{
|
||||||
|
$this->middlewareRequests[] = [$alias, $class];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request a Livewire component be registered.
|
||||||
|
*/
|
||||||
|
public function livewire(string $alias, string $class): void
|
||||||
|
{
|
||||||
|
$this->livewireRequests[] = [$alias, $class];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request an Artisan command be registered.
|
||||||
|
*/
|
||||||
|
public function command(string $class): void
|
||||||
|
{
|
||||||
|
$this->commandRequests[] = $class;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request translations be loaded for a namespace.
|
||||||
|
*/
|
||||||
|
public function translations(string $namespace, string $path): void
|
||||||
|
{
|
||||||
|
$this->translationRequests[] = [$namespace, $path];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request an anonymous Blade component path be registered.
|
||||||
|
*/
|
||||||
|
public function bladeComponentPath(string $path, ?string $namespace = null): void
|
||||||
|
{
|
||||||
|
$this->bladeComponentRequests[] = [$path, $namespace];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request a policy be registered for a model.
|
||||||
|
*/
|
||||||
|
public function policy(string $model, string $policy): void
|
||||||
|
{
|
||||||
|
$this->policyRequests[] = [$model, $policy];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all navigation requests for processing.
|
||||||
|
*/
|
||||||
|
public function navigationRequests(): array
|
||||||
|
{
|
||||||
|
return $this->navigationRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all route requests for processing.
|
||||||
|
*/
|
||||||
|
public function routeRequests(): array
|
||||||
|
{
|
||||||
|
return $this->routeRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all view namespace requests for processing.
|
||||||
|
*/
|
||||||
|
public function viewRequests(): array
|
||||||
|
{
|
||||||
|
return $this->viewRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all middleware alias requests for processing.
|
||||||
|
*/
|
||||||
|
public function middlewareRequests(): array
|
||||||
|
{
|
||||||
|
return $this->middlewareRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all Livewire component requests for processing.
|
||||||
|
*/
|
||||||
|
public function livewireRequests(): array
|
||||||
|
{
|
||||||
|
return $this->livewireRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all command requests for processing.
|
||||||
|
*/
|
||||||
|
public function commandRequests(): array
|
||||||
|
{
|
||||||
|
return $this->commandRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all translation requests for processing.
|
||||||
|
*/
|
||||||
|
public function translationRequests(): array
|
||||||
|
{
|
||||||
|
return $this->translationRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all Blade component path requests for processing.
|
||||||
|
*/
|
||||||
|
public function bladeComponentRequests(): array
|
||||||
|
{
|
||||||
|
return $this->bladeComponentRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all policy requests for processing.
|
||||||
|
*/
|
||||||
|
public function policyRequests(): array
|
||||||
|
{
|
||||||
|
return $this->policyRequests;
|
||||||
|
}
|
||||||
|
}
|
||||||
36
src/Core/Events/McpToolsRegistering.php
Normal file
36
src/Core/Events/McpToolsRegistering.php
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when MCP tools are being registered.
|
||||||
|
*
|
||||||
|
* Modules listen to this event to register their MCP tool handlers.
|
||||||
|
* Each handler class must implement the McpToolHandler interface
|
||||||
|
* (to be provided by the consuming application).
|
||||||
|
*
|
||||||
|
* Fired at MCP server startup (stdio transport) or when MCP routes
|
||||||
|
* are accessed (HTTP transport).
|
||||||
|
*/
|
||||||
|
class McpToolsRegistering extends LifecycleEvent
|
||||||
|
{
|
||||||
|
protected array $handlers = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register an MCP tool handler class.
|
||||||
|
*/
|
||||||
|
public function handler(string $handlerClass): void
|
||||||
|
{
|
||||||
|
$this->handlers[] = $handlerClass;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all registered handler classes.
|
||||||
|
*/
|
||||||
|
public function handlers(): array
|
||||||
|
{
|
||||||
|
return $this->handlers;
|
||||||
|
}
|
||||||
|
}
|
||||||
19
src/Core/Events/WebRoutesRegistering.php
Normal file
19
src/Core/Events/WebRoutesRegistering.php
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Events;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when web routes are being registered.
|
||||||
|
*
|
||||||
|
* Modules listen to this event to register public-facing web routes.
|
||||||
|
* Routes are automatically wrapped with the 'web' middleware group.
|
||||||
|
*
|
||||||
|
* Use this for marketing pages, public product pages, etc.
|
||||||
|
* For authenticated dashboard routes, use AdminPanelBooting instead.
|
||||||
|
*/
|
||||||
|
class WebRoutesRegistering extends LifecycleEvent
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
48
src/Core/Front/Admin/Contracts/AdminMenuProvider.php
Normal file
48
src/Core/Front/Admin/Contracts/AdminMenuProvider.php
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Front\Admin\Contracts;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for modules that provide admin menu items.
|
||||||
|
*
|
||||||
|
* Modules implement this interface and register themselves with an admin menu
|
||||||
|
* registry during boot. The registry collects all items and builds the final
|
||||||
|
* menu structure.
|
||||||
|
*/
|
||||||
|
interface AdminMenuProvider
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return admin menu items for this module.
|
||||||
|
*
|
||||||
|
* Each item should specify:
|
||||||
|
* - group: string (e.g., dashboard, settings, services)
|
||||||
|
* - priority: int (lower = earlier in group)
|
||||||
|
* - item: Closure (lazy-evaluated menu item data)
|
||||||
|
*
|
||||||
|
* Example:
|
||||||
|
* ```php
|
||||||
|
* return [
|
||||||
|
* [
|
||||||
|
* 'group' => 'services',
|
||||||
|
* 'priority' => 20,
|
||||||
|
* 'item' => fn() => [
|
||||||
|
* 'label' => 'Products',
|
||||||
|
* 'icon' => 'box',
|
||||||
|
* 'href' => route('admin.products.index'),
|
||||||
|
* 'active' => request()->routeIs('admin.products.*'),
|
||||||
|
* 'children' => [...],
|
||||||
|
* ],
|
||||||
|
* ],
|
||||||
|
* ];
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @return array<int, array{
|
||||||
|
* group: string,
|
||||||
|
* priority: int,
|
||||||
|
* item: \Closure
|
||||||
|
* }>
|
||||||
|
*/
|
||||||
|
public function adminMenuItems(): array;
|
||||||
|
}
|
||||||
171
src/Core/LifecycleEventProvider.php
Normal file
171
src/Core/LifecycleEventProvider.php
Normal file
|
|
@ -0,0 +1,171 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core;
|
||||||
|
|
||||||
|
use Core\Events\AdminPanelBooting;
|
||||||
|
use Core\Events\ApiRoutesRegistering;
|
||||||
|
use Core\Events\ClientRoutesRegistering;
|
||||||
|
use Core\Events\ConsoleBooting;
|
||||||
|
use Core\Events\McpToolsRegistering;
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fires lifecycle events and processes their requests.
|
||||||
|
*
|
||||||
|
* This class provides static methods for frontage service providers
|
||||||
|
* to fire events and process the collected requests from modules.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* // In a web service provider:
|
||||||
|
* LifecycleEventProvider::fireWebRoutes();
|
||||||
|
*/
|
||||||
|
class LifecycleEventProvider
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Fire WebRoutesRegistering and process requests.
|
||||||
|
*
|
||||||
|
* Called by your web frontage when web routes are being set up.
|
||||||
|
*/
|
||||||
|
public static function fireWebRoutes(): void
|
||||||
|
{
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
event($event);
|
||||||
|
|
||||||
|
// Process view namespace requests
|
||||||
|
foreach ($event->viewRequests() as [$namespace, $path]) {
|
||||||
|
if (is_dir($path)) {
|
||||||
|
view()->addNamespace($namespace, $path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process Livewire component requests if Livewire is available
|
||||||
|
if (class_exists(\Livewire\Livewire::class)) {
|
||||||
|
foreach ($event->livewireRequests() as [$alias, $class]) {
|
||||||
|
\Livewire\Livewire::component($alias, $class);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process route requests
|
||||||
|
foreach ($event->routeRequests() as $callback) {
|
||||||
|
Route::middleware('web')->group($callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Refresh route lookups after adding routes
|
||||||
|
app('router')->getRoutes()->refreshNameLookups();
|
||||||
|
app('router')->getRoutes()->refreshActionLookups();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fire AdminPanelBooting and process requests.
|
||||||
|
*
|
||||||
|
* Called by your admin frontage when admin routes are being set up.
|
||||||
|
*/
|
||||||
|
public static function fireAdminBooting(): void
|
||||||
|
{
|
||||||
|
$event = new AdminPanelBooting;
|
||||||
|
event($event);
|
||||||
|
|
||||||
|
// Process view namespace requests
|
||||||
|
foreach ($event->viewRequests() as [$namespace, $path]) {
|
||||||
|
if (is_dir($path)) {
|
||||||
|
view()->addNamespace($namespace, $path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process Livewire component requests if Livewire is available
|
||||||
|
if (class_exists(\Livewire\Livewire::class)) {
|
||||||
|
foreach ($event->livewireRequests() as [$alias, $class]) {
|
||||||
|
\Livewire\Livewire::component($alias, $class);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process route requests with admin middleware
|
||||||
|
foreach ($event->routeRequests() as $callback) {
|
||||||
|
Route::middleware('admin')->group($callback);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fire ClientRoutesRegistering and process requests.
|
||||||
|
*
|
||||||
|
* Called by your client frontage when client routes are being set up.
|
||||||
|
*/
|
||||||
|
public static function fireClientRoutes(): void
|
||||||
|
{
|
||||||
|
$event = new ClientRoutesRegistering;
|
||||||
|
event($event);
|
||||||
|
|
||||||
|
// Process view namespace requests
|
||||||
|
foreach ($event->viewRequests() as [$namespace, $path]) {
|
||||||
|
if (is_dir($path)) {
|
||||||
|
view()->addNamespace($namespace, $path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process Livewire component requests if Livewire is available
|
||||||
|
if (class_exists(\Livewire\Livewire::class)) {
|
||||||
|
foreach ($event->livewireRequests() as [$alias, $class]) {
|
||||||
|
\Livewire\Livewire::component($alias, $class);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process route requests with client middleware
|
||||||
|
foreach ($event->routeRequests() as $callback) {
|
||||||
|
Route::middleware('client')->group($callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Refresh route lookups after adding routes
|
||||||
|
app('router')->getRoutes()->refreshNameLookups();
|
||||||
|
app('router')->getRoutes()->refreshActionLookups();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fire ApiRoutesRegistering and process requests.
|
||||||
|
*
|
||||||
|
* Called by your API frontage when API routes are being set up.
|
||||||
|
*/
|
||||||
|
public static function fireApiRoutes(): void
|
||||||
|
{
|
||||||
|
$event = new ApiRoutesRegistering;
|
||||||
|
event($event);
|
||||||
|
|
||||||
|
// Process route requests with api middleware
|
||||||
|
foreach ($event->routeRequests() as $callback) {
|
||||||
|
Route::middleware('api')->prefix('api')->group($callback);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fire McpToolsRegistering and return collected handlers.
|
||||||
|
*
|
||||||
|
* Called by MCP server command when loading tools.
|
||||||
|
*
|
||||||
|
* @return array<string> Handler class names
|
||||||
|
*/
|
||||||
|
public static function fireMcpTools(): array
|
||||||
|
{
|
||||||
|
$event = new McpToolsRegistering;
|
||||||
|
event($event);
|
||||||
|
|
||||||
|
return $event->handlers();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fire ConsoleBooting and process requests.
|
||||||
|
*
|
||||||
|
* @param \Illuminate\Support\ServiceProvider $provider The service provider to register commands on
|
||||||
|
*/
|
||||||
|
public static function fireConsoleBooting(\Illuminate\Support\ServiceProvider $provider): void
|
||||||
|
{
|
||||||
|
$event = new ConsoleBooting;
|
||||||
|
event($event);
|
||||||
|
|
||||||
|
// Process command requests
|
||||||
|
if (! empty($event->commandRequests())) {
|
||||||
|
$provider->commands($event->commandRequests());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
92
src/Core/Module/LazyModuleListener.php
Normal file
92
src/Core/Module/LazyModuleListener.php
Normal file
|
|
@ -0,0 +1,92 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Module;
|
||||||
|
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wraps a module method as an event listener.
|
||||||
|
*
|
||||||
|
* The module is only instantiated when the event fires,
|
||||||
|
* enabling lazy loading of modules based on actual usage.
|
||||||
|
*
|
||||||
|
* Handles both plain classes and ServiceProviders correctly.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* Event::listen(
|
||||||
|
* AdminPanelBooting::class,
|
||||||
|
* new LazyModuleListener(Commerce\Boot::class, 'registerAdmin')
|
||||||
|
* );
|
||||||
|
*/
|
||||||
|
class LazyModuleListener
|
||||||
|
{
|
||||||
|
private ?object $instance = null;
|
||||||
|
|
||||||
|
public function __construct(
|
||||||
|
private string $moduleClass,
|
||||||
|
private string $method
|
||||||
|
) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle the event by instantiating the module and calling its method.
|
||||||
|
*
|
||||||
|
* This is the callable interface for Laravel's event dispatcher.
|
||||||
|
*/
|
||||||
|
public function __invoke(object $event): void
|
||||||
|
{
|
||||||
|
$module = $this->resolveModule();
|
||||||
|
$module->{$this->method}($event);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Alias for __invoke for explicit calls.
|
||||||
|
*/
|
||||||
|
public function handle(object $event): void
|
||||||
|
{
|
||||||
|
$this->__invoke($event);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolve the module instance.
|
||||||
|
*
|
||||||
|
* ServiceProviders are resolved via resolveProvider() to get proper $app injection.
|
||||||
|
* Plain classes are resolved via make().
|
||||||
|
*/
|
||||||
|
private function resolveModule(): object
|
||||||
|
{
|
||||||
|
if ($this->instance !== null) {
|
||||||
|
return $this->instance;
|
||||||
|
}
|
||||||
|
|
||||||
|
$app = app();
|
||||||
|
|
||||||
|
// Check if this is a ServiceProvider
|
||||||
|
if (is_subclass_of($this->moduleClass, ServiceProvider::class)) {
|
||||||
|
// Use resolveProvider for ServiceProviders - handles $app injection
|
||||||
|
$this->instance = $app->resolveProvider($this->moduleClass);
|
||||||
|
} else {
|
||||||
|
// Plain class - just make it
|
||||||
|
$this->instance = $app->make($this->moduleClass);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->instance;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the module class this listener wraps.
|
||||||
|
*/
|
||||||
|
public function getModuleClass(): string
|
||||||
|
{
|
||||||
|
return $this->moduleClass;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the method this listener will call.
|
||||||
|
*/
|
||||||
|
public function getMethod(): string
|
||||||
|
{
|
||||||
|
return $this->method;
|
||||||
|
}
|
||||||
|
}
|
||||||
106
src/Core/Module/ModuleRegistry.php
Normal file
106
src/Core/Module/ModuleRegistry.php
Normal file
|
|
@ -0,0 +1,106 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Module;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Event;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Manages lazy module registration via events.
|
||||||
|
*
|
||||||
|
* Scans module directories, extracts $listens declarations,
|
||||||
|
* and wires up lazy listeners for each event-module pair.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* $registry = new ModuleRegistry(new ModuleScanner());
|
||||||
|
* $registry->register([app_path('Core'), app_path('Mod')]);
|
||||||
|
*/
|
||||||
|
class ModuleRegistry
|
||||||
|
{
|
||||||
|
private array $mappings = [];
|
||||||
|
|
||||||
|
private bool $registered = false;
|
||||||
|
|
||||||
|
public function __construct(
|
||||||
|
private ModuleScanner $scanner
|
||||||
|
) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Scan paths and register lazy listeners for all declared events.
|
||||||
|
*
|
||||||
|
* @param array<string> $paths Directories containing modules
|
||||||
|
*/
|
||||||
|
public function register(array $paths): void
|
||||||
|
{
|
||||||
|
if ($this->registered) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->mappings = $this->scanner->scan($paths);
|
||||||
|
|
||||||
|
foreach ($this->mappings as $event => $listeners) {
|
||||||
|
foreach ($listeners as $moduleClass => $method) {
|
||||||
|
Event::listen($event, new LazyModuleListener($moduleClass, $method));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->registered = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all scanned mappings.
|
||||||
|
*
|
||||||
|
* @return array<string, array<string, string>> Event => [Module => method]
|
||||||
|
*/
|
||||||
|
public function getMappings(): array
|
||||||
|
{
|
||||||
|
return $this->mappings;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get modules that listen to a specific event.
|
||||||
|
*
|
||||||
|
* @return array<string, string> Module => method
|
||||||
|
*/
|
||||||
|
public function getListenersFor(string $event): array
|
||||||
|
{
|
||||||
|
return $this->mappings[$event] ?? [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if registration has been performed.
|
||||||
|
*/
|
||||||
|
public function isRegistered(): bool
|
||||||
|
{
|
||||||
|
return $this->registered;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all events that have listeners.
|
||||||
|
*
|
||||||
|
* @return array<string>
|
||||||
|
*/
|
||||||
|
public function getEvents(): array
|
||||||
|
{
|
||||||
|
return array_keys($this->mappings);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all modules that have declared listeners.
|
||||||
|
*
|
||||||
|
* @return array<string>
|
||||||
|
*/
|
||||||
|
public function getModules(): array
|
||||||
|
{
|
||||||
|
$modules = [];
|
||||||
|
|
||||||
|
foreach ($this->mappings as $listeners) {
|
||||||
|
foreach (array_keys($listeners) as $module) {
|
||||||
|
$modules[$module] = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return array_keys($modules);
|
||||||
|
}
|
||||||
|
}
|
||||||
157
src/Core/Module/ModuleScanner.php
Normal file
157
src/Core/Module/ModuleScanner.php
Normal file
|
|
@ -0,0 +1,157 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Module;
|
||||||
|
|
||||||
|
use ReflectionClass;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Scans module Boot.php files for event listener declarations.
|
||||||
|
*
|
||||||
|
* Reads the static $listens property from Boot classes without
|
||||||
|
* instantiating them, enabling lazy loading of modules.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* $scanner = new ModuleScanner();
|
||||||
|
* $mappings = $scanner->scan([app_path('Core'), app_path('Mod')]);
|
||||||
|
* // Returns: [EventClass => [ModuleClass => 'methodName']]
|
||||||
|
*/
|
||||||
|
class ModuleScanner
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Namespace mappings for path resolution.
|
||||||
|
*
|
||||||
|
* Maps directory names to their PSR-4 namespaces.
|
||||||
|
*/
|
||||||
|
protected array $namespaceMap = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set custom namespace mappings.
|
||||||
|
*
|
||||||
|
* @param array<string, string> $map Directory name => namespace prefix
|
||||||
|
*/
|
||||||
|
public function setNamespaceMap(array $map): self
|
||||||
|
{
|
||||||
|
$this->namespaceMap = $map;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Scan directories for Boot.php files with $listens declarations.
|
||||||
|
*
|
||||||
|
* @param array<string> $paths Directories to scan
|
||||||
|
* @return array<string, array<string, string>> Event => [Module => method] mappings
|
||||||
|
*/
|
||||||
|
public function scan(array $paths): array
|
||||||
|
{
|
||||||
|
$mappings = [];
|
||||||
|
|
||||||
|
foreach ($paths as $path) {
|
||||||
|
if (! is_dir($path)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (glob("{$path}/*/Boot.php") as $file) {
|
||||||
|
$class = $this->classFromFile($file, $path);
|
||||||
|
|
||||||
|
if (! $class || ! class_exists($class)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
$listens = $this->extractListens($class);
|
||||||
|
|
||||||
|
foreach ($listens as $event => $method) {
|
||||||
|
$mappings[$event][$class] = $method;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $mappings;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract the $listens array from a class without instantiation.
|
||||||
|
*
|
||||||
|
* @return array<string, string> Event => method mappings
|
||||||
|
*/
|
||||||
|
public function extractListens(string $class): array
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
$reflection = new ReflectionClass($class);
|
||||||
|
|
||||||
|
if (! $reflection->hasProperty('listens')) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
$prop = $reflection->getProperty('listens');
|
||||||
|
|
||||||
|
if (! $prop->isStatic() || ! $prop->isPublic()) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
$listens = $prop->getValue();
|
||||||
|
|
||||||
|
if (! is_array($listens)) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
return $listens;
|
||||||
|
} catch (\ReflectionException) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Derive class name from file path.
|
||||||
|
*
|
||||||
|
* Converts: app/Mod/Commerce/Boot.php => Mod\Commerce\Boot
|
||||||
|
* Converts: app/Core/Cdn/Boot.php => Core\Cdn\Boot
|
||||||
|
*/
|
||||||
|
private function classFromFile(string $file, string $basePath): ?string
|
||||||
|
{
|
||||||
|
// Normalise paths
|
||||||
|
$file = str_replace('\\', '/', realpath($file) ?: $file);
|
||||||
|
$basePath = str_replace('\\', '/', realpath($basePath) ?: $basePath);
|
||||||
|
|
||||||
|
// Get relative path from base
|
||||||
|
if (! str_starts_with($file, $basePath)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$relative = substr($file, strlen($basePath) + 1);
|
||||||
|
|
||||||
|
// Remove .php extension
|
||||||
|
$relative = preg_replace('/\.php$/', '', $relative);
|
||||||
|
|
||||||
|
// Convert path separators to namespace separators
|
||||||
|
$namespace = str_replace('/', '\\', $relative);
|
||||||
|
|
||||||
|
// Check custom namespace map first
|
||||||
|
$dirName = basename($basePath);
|
||||||
|
if (isset($this->namespaceMap[$dirName])) {
|
||||||
|
return $this->namespaceMap[$dirName].'\\'.$namespace;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default namespace detection based on common patterns
|
||||||
|
if (str_contains($basePath, '/Core')) {
|
||||||
|
return "Core\\{$namespace}";
|
||||||
|
}
|
||||||
|
|
||||||
|
if (str_contains($basePath, '/Mod')) {
|
||||||
|
return "Mod\\{$namespace}";
|
||||||
|
}
|
||||||
|
|
||||||
|
if (str_contains($basePath, '/Website')) {
|
||||||
|
return "Website\\{$namespace}";
|
||||||
|
}
|
||||||
|
|
||||||
|
if (str_contains($basePath, '/Plug')) {
|
||||||
|
return "Plug\\{$namespace}";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback - use directory name as namespace
|
||||||
|
return "{$dirName}\\{$namespace}";
|
||||||
|
}
|
||||||
|
}
|
||||||
35
src/Core/Service/Contracts/ServiceDefinition.php
Normal file
35
src/Core/Service/Contracts/ServiceDefinition.php
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Service\Contracts;
|
||||||
|
|
||||||
|
use Core\Front\Admin\Contracts\AdminMenuProvider;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contract for service definitions.
|
||||||
|
*
|
||||||
|
* Services are the product layer - they define how modules are presented
|
||||||
|
* to users as SaaS products. Each service has a definition used for
|
||||||
|
* registration and admin menu integration.
|
||||||
|
*
|
||||||
|
* Extends AdminMenuProvider to integrate with the admin menu system.
|
||||||
|
*/
|
||||||
|
interface ServiceDefinition extends AdminMenuProvider
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Get the service definition.
|
||||||
|
*
|
||||||
|
* @return array{
|
||||||
|
* code: string,
|
||||||
|
* module: string,
|
||||||
|
* name: string,
|
||||||
|
* tagline?: string,
|
||||||
|
* description?: string,
|
||||||
|
* icon?: string,
|
||||||
|
* color?: string,
|
||||||
|
* sort_order?: int,
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
public static function definition(): array;
|
||||||
|
}
|
||||||
44
stubs/Mod/Example/Boot.php.stub
Normal file
44
stubs/Mod/Example/Boot.php.stub
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Mod\{{ name }};
|
||||||
|
|
||||||
|
use Core\Events\AdminPanelBooting;
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
|
||||||
|
class Boot extends ServiceProvider
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Events this module listens to.
|
||||||
|
*
|
||||||
|
* The module is only instantiated when these events fire.
|
||||||
|
*/
|
||||||
|
public static array $listens = [
|
||||||
|
WebRoutesRegistering::class => 'onWebRoutes',
|
||||||
|
AdminPanelBooting::class => 'onAdmin',
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle web routes registration.
|
||||||
|
*/
|
||||||
|
public function onWebRoutes(WebRoutesRegistering $event): void
|
||||||
|
{
|
||||||
|
$event->views('{{ slug }}', __DIR__.'/Views');
|
||||||
|
|
||||||
|
$event->routes(function () {
|
||||||
|
require __DIR__.'/Routes/web.php';
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle admin panel booting.
|
||||||
|
*/
|
||||||
|
public function onAdmin(AdminPanelBooting $event): void
|
||||||
|
{
|
||||||
|
$event->routes(function () {
|
||||||
|
require __DIR__.'/Routes/admin.php';
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
19
stubs/Mod/Example/Routes/admin.php.stub
Normal file
19
stubs/Mod/Example/Routes/admin.php.stub
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| {{ name }} Admin Routes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Admin routes for the {{ name }} module.
|
||||||
|
| These routes are wrapped with the 'admin' middleware group.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Route::prefix('admin/{{ slug }}')->name('admin.{{ slug }}.')->group(function () {
|
||||||
|
// Route::get('/', function () {
|
||||||
|
// return view('{{ slug }}::admin.index');
|
||||||
|
// })->name('index');
|
||||||
|
// });
|
||||||
19
stubs/Mod/Example/Routes/api.php.stub
Normal file
19
stubs/Mod/Example/Routes/api.php.stub
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| {{ name }} API Routes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| API routes for the {{ name }} module.
|
||||||
|
| These routes are wrapped with the 'api' middleware group.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Route::prefix('{{ slug }}')->name('api.{{ slug }}.')->group(function () {
|
||||||
|
// Route::get('/', function () {
|
||||||
|
// return response()->json(['module' => '{{ name }}']);
|
||||||
|
// })->name('index');
|
||||||
|
// });
|
||||||
17
stubs/Mod/Example/Routes/web.php.stub
Normal file
17
stubs/Mod/Example/Routes/web.php.stub
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| {{ name }} Web Routes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Public-facing routes for the {{ name }} module.
|
||||||
|
| These routes are wrapped with the 'web' middleware group.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Route::get('/{{ slug }}', function () {
|
||||||
|
// return view('{{ slug }}::index');
|
||||||
|
// })->name('{{ slug }}.index');
|
||||||
13
stubs/Mod/Example/config.php.stub
Normal file
13
stubs/Mod/Example/config.php.stub
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
return [
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| {{ name }} Module Configuration
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
*/
|
||||||
|
|
||||||
|
'enabled' => env('{{ upper_slug }}_ENABLED', true),
|
||||||
|
|
||||||
|
];
|
||||||
33
stubs/Plug/Example/Boot.php.stub
Normal file
33
stubs/Plug/Example/Boot.php.stub
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Plug\{{ name }};
|
||||||
|
|
||||||
|
use Core\Events\FrameworkBooted;
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plugin module for {{ name }}.
|
||||||
|
*
|
||||||
|
* Plugins extend core functionality without being a full module.
|
||||||
|
* They typically integrate third-party services or add cross-cutting
|
||||||
|
* features.
|
||||||
|
*/
|
||||||
|
class Boot extends ServiceProvider
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Events this plugin listens to.
|
||||||
|
*/
|
||||||
|
public static array $listens = [
|
||||||
|
FrameworkBooted::class => 'onBooted',
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle framework booted event.
|
||||||
|
*/
|
||||||
|
public function onBooted(FrameworkBooted $event): void
|
||||||
|
{
|
||||||
|
// Register plugin functionality
|
||||||
|
}
|
||||||
|
}
|
||||||
36
stubs/Website/Example/Boot.php.stub
Normal file
36
stubs/Website/Example/Boot.php.stub
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Website\{{ name }};
|
||||||
|
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Website module for {{ name }}.
|
||||||
|
*
|
||||||
|
* Website modules are domain-scoped and typically serve
|
||||||
|
* marketing sites, landing pages, or standalone web properties.
|
||||||
|
*/
|
||||||
|
class Boot extends ServiceProvider
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Events this website listens to.
|
||||||
|
*/
|
||||||
|
public static array $listens = [
|
||||||
|
WebRoutesRegistering::class => 'onWebRoutes',
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle web routes registration.
|
||||||
|
*/
|
||||||
|
public function onWebRoutes(WebRoutesRegistering $event): void
|
||||||
|
{
|
||||||
|
$event->views('{{ slug }}', __DIR__.'/Views');
|
||||||
|
|
||||||
|
$event->routes(function () {
|
||||||
|
require __DIR__.'/Routes/web.php';
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
84
tests/Feature/LazyModuleListenerTest.php
Normal file
84
tests/Feature/LazyModuleListenerTest.php
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Tests\Feature;
|
||||||
|
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
use Core\Module\LazyModuleListener;
|
||||||
|
use Core\Tests\TestCase;
|
||||||
|
|
||||||
|
class LazyModuleListenerTest extends TestCase
|
||||||
|
{
|
||||||
|
public function test_listener_stores_module_class(): void
|
||||||
|
{
|
||||||
|
$listener = new LazyModuleListener(
|
||||||
|
'App\\Mod\\Test\\Boot',
|
||||||
|
'onWebRoutes'
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertEquals('App\\Mod\\Test\\Boot', $listener->getModuleClass());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_listener_stores_method(): void
|
||||||
|
{
|
||||||
|
$listener = new LazyModuleListener(
|
||||||
|
'App\\Mod\\Test\\Boot',
|
||||||
|
'onWebRoutes'
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertEquals('onWebRoutes', $listener->getMethod());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_listener_invokes_module_method(): void
|
||||||
|
{
|
||||||
|
// Create a test module class
|
||||||
|
$moduleClass = new class
|
||||||
|
{
|
||||||
|
public bool $called = false;
|
||||||
|
|
||||||
|
public function onWebRoutes(WebRoutesRegistering $event): void
|
||||||
|
{
|
||||||
|
$this->called = true;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Bind it to the container
|
||||||
|
$this->app->instance($moduleClass::class, $moduleClass);
|
||||||
|
|
||||||
|
$listener = new LazyModuleListener(
|
||||||
|
$moduleClass::class,
|
||||||
|
'onWebRoutes'
|
||||||
|
);
|
||||||
|
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
$listener($event);
|
||||||
|
|
||||||
|
$this->assertTrue($moduleClass->called);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_handle_is_alias_for_invoke(): void
|
||||||
|
{
|
||||||
|
$moduleClass = new class
|
||||||
|
{
|
||||||
|
public int $callCount = 0;
|
||||||
|
|
||||||
|
public function onWebRoutes(WebRoutesRegistering $event): void
|
||||||
|
{
|
||||||
|
$this->callCount++;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
$this->app->instance($moduleClass::class, $moduleClass);
|
||||||
|
|
||||||
|
$listener = new LazyModuleListener(
|
||||||
|
$moduleClass::class,
|
||||||
|
'onWebRoutes'
|
||||||
|
);
|
||||||
|
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
$listener->handle($event);
|
||||||
|
|
||||||
|
$this->assertEquals(1, $moduleClass->callCount);
|
||||||
|
}
|
||||||
|
}
|
||||||
136
tests/Feature/LifecycleEventsTest.php
Normal file
136
tests/Feature/LifecycleEventsTest.php
Normal file
|
|
@ -0,0 +1,136 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Tests\Feature;
|
||||||
|
|
||||||
|
use Core\Events\AdminPanelBooting;
|
||||||
|
use Core\Events\ApiRoutesRegistering;
|
||||||
|
use Core\Events\ClientRoutesRegistering;
|
||||||
|
use Core\Events\ConsoleBooting;
|
||||||
|
use Core\Events\FrameworkBooted;
|
||||||
|
use Core\Events\McpToolsRegistering;
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
use Core\Tests\TestCase;
|
||||||
|
|
||||||
|
class LifecycleEventsTest extends TestCase
|
||||||
|
{
|
||||||
|
public function test_web_routes_event_collects_route_requests(): void
|
||||||
|
{
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
|
||||||
|
$event->routes(fn () => 'test');
|
||||||
|
|
||||||
|
$this->assertCount(1, $event->routeRequests());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_web_routes_event_collects_view_requests(): void
|
||||||
|
{
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
|
||||||
|
$event->views('test', '/path/to/views');
|
||||||
|
|
||||||
|
$requests = $event->viewRequests();
|
||||||
|
$this->assertCount(1, $requests);
|
||||||
|
$this->assertEquals(['test', '/path/to/views'], $requests[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_admin_event_collects_navigation_requests(): void
|
||||||
|
{
|
||||||
|
$event = new AdminPanelBooting;
|
||||||
|
|
||||||
|
$event->navigation(['label' => 'Test', 'icon' => 'cog']);
|
||||||
|
|
||||||
|
$this->assertCount(1, $event->navigationRequests());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_api_event_collects_route_requests(): void
|
||||||
|
{
|
||||||
|
$event = new ApiRoutesRegistering;
|
||||||
|
|
||||||
|
$event->routes(fn () => 'api-test');
|
||||||
|
|
||||||
|
$this->assertCount(1, $event->routeRequests());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_client_event_collects_livewire_requests(): void
|
||||||
|
{
|
||||||
|
$event = new ClientRoutesRegistering;
|
||||||
|
|
||||||
|
$event->livewire('test-component', 'App\\Livewire\\TestComponent');
|
||||||
|
|
||||||
|
$requests = $event->livewireRequests();
|
||||||
|
$this->assertCount(1, $requests);
|
||||||
|
$this->assertEquals(['test-component', 'App\\Livewire\\TestComponent'], $requests[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_console_event_collects_command_requests(): void
|
||||||
|
{
|
||||||
|
$event = new ConsoleBooting;
|
||||||
|
|
||||||
|
$event->command('App\\Console\\Commands\\TestCommand');
|
||||||
|
|
||||||
|
$this->assertCount(1, $event->commandRequests());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_mcp_event_collects_handlers(): void
|
||||||
|
{
|
||||||
|
$event = new McpToolsRegistering;
|
||||||
|
|
||||||
|
$event->handler('App\\Mcp\\TestHandler');
|
||||||
|
|
||||||
|
$this->assertCount(1, $event->handlers());
|
||||||
|
$this->assertEquals(['App\\Mcp\\TestHandler'], $event->handlers());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_framework_booted_event_exists(): void
|
||||||
|
{
|
||||||
|
$event = new FrameworkBooted;
|
||||||
|
|
||||||
|
$this->assertInstanceOf(FrameworkBooted::class, $event);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_lifecycle_event_collects_middleware_requests(): void
|
||||||
|
{
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
|
||||||
|
$event->middleware('custom', 'App\\Http\\Middleware\\Custom');
|
||||||
|
|
||||||
|
$requests = $event->middlewareRequests();
|
||||||
|
$this->assertCount(1, $requests);
|
||||||
|
$this->assertEquals(['custom', 'App\\Http\\Middleware\\Custom'], $requests[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_lifecycle_event_collects_translation_requests(): void
|
||||||
|
{
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
|
||||||
|
$event->translations('test', '/path/to/lang');
|
||||||
|
|
||||||
|
$requests = $event->translationRequests();
|
||||||
|
$this->assertCount(1, $requests);
|
||||||
|
$this->assertEquals(['test', '/path/to/lang'], $requests[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_lifecycle_event_collects_policy_requests(): void
|
||||||
|
{
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
|
||||||
|
$event->policy('App\\Models\\User', 'App\\Policies\\UserPolicy');
|
||||||
|
|
||||||
|
$requests = $event->policyRequests();
|
||||||
|
$this->assertCount(1, $requests);
|
||||||
|
$this->assertEquals(['App\\Models\\User', 'App\\Policies\\UserPolicy'], $requests[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_lifecycle_event_collects_blade_component_requests(): void
|
||||||
|
{
|
||||||
|
$event = new WebRoutesRegistering;
|
||||||
|
|
||||||
|
$event->bladeComponentPath('/path/to/components', 'custom');
|
||||||
|
|
||||||
|
$requests = $event->bladeComponentRequests();
|
||||||
|
$this->assertCount(1, $requests);
|
||||||
|
$this->assertEquals(['/path/to/components', 'custom'], $requests[0]);
|
||||||
|
}
|
||||||
|
}
|
||||||
72
tests/Feature/ModuleRegistryTest.php
Normal file
72
tests/Feature/ModuleRegistryTest.php
Normal file
|
|
@ -0,0 +1,72 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Tests\Feature;
|
||||||
|
|
||||||
|
use Core\Module\ModuleRegistry;
|
||||||
|
use Core\Module\ModuleScanner;
|
||||||
|
use Core\Tests\TestCase;
|
||||||
|
|
||||||
|
class ModuleRegistryTest extends TestCase
|
||||||
|
{
|
||||||
|
public function test_registry_starts_unregistered(): void
|
||||||
|
{
|
||||||
|
$registry = new ModuleRegistry(new ModuleScanner);
|
||||||
|
|
||||||
|
$this->assertFalse($registry->isRegistered());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_registry_marks_as_registered_after_register(): void
|
||||||
|
{
|
||||||
|
$registry = new ModuleRegistry(new ModuleScanner);
|
||||||
|
|
||||||
|
$registry->register([]);
|
||||||
|
|
||||||
|
$this->assertTrue($registry->isRegistered());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_registry_only_registers_once(): void
|
||||||
|
{
|
||||||
|
$registry = new ModuleRegistry(new ModuleScanner);
|
||||||
|
|
||||||
|
$registry->register([]);
|
||||||
|
$registry->register([$this->getFixturePath('Mod')]);
|
||||||
|
|
||||||
|
// Should still be empty since it only registers once
|
||||||
|
$this->assertEmpty($registry->getMappings());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_get_mappings_returns_array(): void
|
||||||
|
{
|
||||||
|
$registry = new ModuleRegistry(new ModuleScanner);
|
||||||
|
|
||||||
|
$this->assertIsArray($registry->getMappings());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_get_listeners_for_returns_empty_for_unknown_event(): void
|
||||||
|
{
|
||||||
|
$registry = new ModuleRegistry(new ModuleScanner);
|
||||||
|
|
||||||
|
$result = $registry->getListenersFor('Unknown\\Event');
|
||||||
|
|
||||||
|
$this->assertIsArray($result);
|
||||||
|
$this->assertEmpty($result);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_get_events_returns_array(): void
|
||||||
|
{
|
||||||
|
$registry = new ModuleRegistry(new ModuleScanner);
|
||||||
|
$registry->register([]);
|
||||||
|
|
||||||
|
$this->assertIsArray($registry->getEvents());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_get_modules_returns_array(): void
|
||||||
|
{
|
||||||
|
$registry = new ModuleRegistry(new ModuleScanner);
|
||||||
|
$registry->register([]);
|
||||||
|
|
||||||
|
$this->assertIsArray($registry->getModules());
|
||||||
|
}
|
||||||
|
}
|
||||||
56
tests/Feature/ModuleScannerTest.php
Normal file
56
tests/Feature/ModuleScannerTest.php
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Tests\Feature;
|
||||||
|
|
||||||
|
use Core\Module\ModuleScanner;
|
||||||
|
use Core\Tests\TestCase;
|
||||||
|
|
||||||
|
class ModuleScannerTest extends TestCase
|
||||||
|
{
|
||||||
|
protected ModuleScanner $scanner;
|
||||||
|
|
||||||
|
protected function setUp(): void
|
||||||
|
{
|
||||||
|
parent::setUp();
|
||||||
|
$this->scanner = new ModuleScanner;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_scan_returns_empty_array_for_nonexistent_path(): void
|
||||||
|
{
|
||||||
|
$result = $this->scanner->scan(['/nonexistent/path']);
|
||||||
|
|
||||||
|
$this->assertIsArray($result);
|
||||||
|
$this->assertEmpty($result);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_scan_finds_modules_with_listens_property(): void
|
||||||
|
{
|
||||||
|
$result = $this->scanner->scan([$this->getFixturePath('Mod')]);
|
||||||
|
|
||||||
|
$this->assertIsArray($result);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_extract_listens_returns_empty_for_class_without_property(): void
|
||||||
|
{
|
||||||
|
// Create a temporary class without $listens
|
||||||
|
$class = new class {
|
||||||
|
public function handle(): void {}
|
||||||
|
};
|
||||||
|
|
||||||
|
$result = $this->scanner->extractListens($class::class);
|
||||||
|
|
||||||
|
$this->assertIsArray($result);
|
||||||
|
$this->assertEmpty($result);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_namespace_map_can_be_configured(): void
|
||||||
|
{
|
||||||
|
$scanner = (new ModuleScanner)->setNamespaceMap([
|
||||||
|
'CustomMod' => 'App\\CustomMod',
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertInstanceOf(ModuleScanner::class, $scanner);
|
||||||
|
}
|
||||||
|
}
|
||||||
19
tests/Fixtures/Mod/Example/Boot.php
Normal file
19
tests/Fixtures/Mod/Example/Boot.php
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Mod\Example;
|
||||||
|
|
||||||
|
use Core\Events\WebRoutesRegistering;
|
||||||
|
|
||||||
|
class Boot
|
||||||
|
{
|
||||||
|
public static array $listens = [
|
||||||
|
WebRoutesRegistering::class => 'onWebRoutes',
|
||||||
|
];
|
||||||
|
|
||||||
|
public function onWebRoutes(WebRoutesRegistering $event): void
|
||||||
|
{
|
||||||
|
$event->views('example', __DIR__.'/Views');
|
||||||
|
}
|
||||||
|
}
|
||||||
30
tests/TestCase.php
Normal file
30
tests/TestCase.php
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Core\Tests;
|
||||||
|
|
||||||
|
use Core\CoreServiceProvider;
|
||||||
|
use Orchestra\Testbench\TestCase as BaseTestCase;
|
||||||
|
|
||||||
|
abstract class TestCase extends BaseTestCase
|
||||||
|
{
|
||||||
|
protected function getPackageProviders($app): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
CoreServiceProvider::class,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function defineEnvironment($app): void
|
||||||
|
{
|
||||||
|
$app['config']->set('core.module_paths', [
|
||||||
|
$this->getFixturePath('Mod'),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getFixturePath(string $path = ''): string
|
||||||
|
{
|
||||||
|
return __DIR__.'/Fixtures'.($path ? "/{$path}" : '');
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Add table
Reference in a new issue