Symfony MakerBundle

If you need to debug documentation issues or read the MakerBundle documentation offline, you can build it locally using the following steps:

1. Navigate to the documentation build directory.
2. Install dependencies via Composer.
3. Run the build script.
4. Serve the generated output using the PHP built-in server.

cd _docs_build/

composer install

php build.php

# After generating docs, serve them:
php -S localhost:8000 -t output/

To generate custom boilerplate code for your application, create a class that extends AbstractMaker in your src/Maker/ directory.

Ensure your class is registered as a service and tagged with maker.command. If you are using the standard Symfony services.yaml configuration, this tagging happens automatically.

To install and enable the MakerBundle in your Symfony application, run the following command in your terminal. It is recommended to install it as a dev dependency.

$ composer require --dev symfony/maker-bundle

The bundle provides several commands under the make: namespace to generate boilerplate code like controllers, entities, and commands.

To see a full list of available commands, run:

$ php bin/console list make

To see the specific arguments and options for a command, use the --help flag:

$ php bin/console make:controller --help

Note: make:entity requires doctrine/orm to be installed and configured. This maker only supports ORM, not ODM.

You can customize the behavior of generated classes in config/packages/maker.yaml.

Available configuration keys:

• root_namespace (string): The root namespace used for all generated classes (default: App).
• generate_final_classes (boolean): If true, all generated classes (except doctrine entities) will use the final keyword (default: true).
• generate_final_entities (boolean): If true, doctrine entity classes will also use the final keyword (default: false).

# config/packages/maker.yaml
when@dev:
    maker:
        root_namespace: 'App'
        generate_final_classes: true
        generate_final_entities: false

The make:reset-password command attempts to automatically configure the symfonycasts/reset-password-bundle by setting the request_password_repository key in config/packages/reset_password.yaml.

If the configuration file does not exist, you must manually set the repository class in your configuration to ensure the bundle knows which repository to use for managing reset requests.

The mercure service can be configured using environment variables to set the server name, JWT keys for publishing and subscribing, and extra directives.

Note: The default JWT keys (!ChangeThisMercureHubJWTSecretKey!) should be changed to secure values in a production environment.

services:
    mercure:
        image: dunglas/mercure
        environment:
            SERVER_NAME: :1337
            MERCURE_PUBLISHER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'
            MERCURE_SUBSCRIBER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'
            MERCURE_EXTRA_DIRECTIVES: |
                anonymous
                cors_origins *
        ports:
            - 1337:1337

MakerBundle uses php-cs-fixer to enforce coding standards on generated .php files. You can override the default bundled version and configuration by setting the following environment variables:

• MAKER_PHP_CS_FIXER_BINARY_PATH: Path to a custom php-cs-fixer binary.
• MAKER_PHP_CS_FIXER_CONFIG_PATH: Path to a custom php-cs-fixer configuration file.

The MakerBundle follows the Symfony backwards compatibility promise, with two important clarifications for users:

1. Command Interfaces: Input arguments or options for commands may change between minor releases. If you use MakerBundle commands in automated scripts, you should account for potential changes in command signatures.
2. Generated Code: The code generated by the bundle may change between minor releases to allow for continuous improvements to the templates.