README

Code generators that follow the Zana module layout. Conventions produce plain, explicit code you own, not runtime magic. Requires PHP 8.5 or later.

composer require --dev mj-zana/maker

Generated classes use the namespace Modules\<Module> under modules/<Module>/, so map it in your composer.json:

"autoload": { "psr-4": { "Modules\\": "modules/" } }

Maker is a dev dependency, so register MakerServiceProvider (with ConsoleServiceProvider) only where it is installed, for example in bin/zana:

if (class_exists(\Zana\Maker\MakerServiceProvider::class)) {
    $builder->withProviders(\Zana\Maker\MakerServiceProvider::class);
}

Run the generators with APP_ENV=development. In production a compiled container that no longer matches the registrations is an error, and every make:* command changes the registrations.

Commands

php bin/zana make:module Patients                      # PatientsModule, its folders, and config/modules.php
php bin/zana make:feature Patients RegisterPatient     # command, #[Handles] handler, handler test
php bin/zana make:feature Patients FindPatient --query # query instead of command
php bin/zana make:entity Patients Patient              # aggregate root, PatientId, repository interface
php bin/zana make:controller Patients Measurements     # Presentation/Api/MeasurementsController, routed at /api/measurements

For websites:

php bin/zana make:module Site --web                    # plus Presentation/Web, Resources/views, Resources/translations
php bin/zana make:controller Site News --web           # Presentation/Web/NewsController returning a View, and its template
php bin/zana make:page Site About --path=en:/about --path=fr:/a-propos   # a localised page with SEO metadata and its template
php bin/zana make:crud Blog Post --translatable        # back-office screens for posts in every locale

make:crud generates a back office that works as soon as it is written. It needs mj-zana/view, session, security (with a PasswordUserProviderInterface) and database.

• Status: a draft, published or archived enum.

• Storage: a migration with a translations table (one row per locale, with a slug), and a repository.

• Screens: list, create and edit, with one fieldset per locale. Publish, archive and delete are POST requests with CSRF, and delete has a confirmation step.

• Preview: drafts get a signed preview link, valid for an hour.

• Access: the screens are behind session login and the <items>.edit permission (e.g. posts.edit).

• Wiring: a generated module works straight away.

  • make:module writes two marker comments into the module class, one in register() and one in boot().
  • make:feature adds lines above them that register the handler and map it in the HandlerMap.
  • make:controller adds lines that register the controller and load its #[Route] attributes.
  • Generating the same thing twice wires it once. Keep the marker lines.
  • A module class without markers, such as one written by hand, is left alone. The command prints the lines to add instead.

• Names: module and class names are StudlyCase.

• config/modules.php: make:module adds the module there, creating the file if needed. The file must only return a list of ::class entries. Comments are kept.

• Existing files: they are never replaced. The command lists them and writes nothing. Add --force to replace them, or --dry-run to see what would be written.

Stubs

The built-in stubs live in this package's stubs/ folder. Copy one to <project>/stubs/<name>.stub to change it. Placeholders look like {{ name }}, and a placeholder the generator does not know is an error.

The generated code uses mj-zana/ddd, mj-zana/mediator and mj-zana/routing. Install the ones your modules need.

License

MIT — see LICENSE.