Installation¶

1

$ composer require sensio/generator-bundle

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        if (in_array($this->getEnvironment(), array('dev', 'test'))) {
            $bundles[] = new Sensio\Bundle\GeneratorBundle\SensioGeneratorBundle();
            // ...
        }

        // ...
    }

    // ...
}

List of Available Commands¶

All the commands provided by this bundle can be run in interactive or non-interactive mode. The interactive mode asks you some questions to configure the command parameters that actually generate the code.

Read the following articles to learn how to use the new commands:

Overriding Skeleton Templates¶

All generators use a template skeleton to generate files. By default, the commands use templates provided by the bundle under its Resources/skeleton/ directory.

You can define custom skeleton templates by creating the same directory and file structure in the following locations (displayed from highest to lowest priority):

• <BUNDLE_PATH>/Resources/SensioGeneratorBundle/skeleton/
• app/Resources/SensioGeneratorBundle/skeleton/

The <BUNDLE_PATH> value refers to the base path of the bundle where you are scaffolding a controller, a form or a CRUD backend.

For instance, if you want to override the edit template for the CRUD generator, create a crud/views/edit.html.twig.twig file under app/Resources/SensioGeneratorBundle/skeleton/.

When overriding a template, have a look at the default templates to learn more about the available templates, their paths and the variables they have access.

Instead of copy/pasting the original template to create your own, you can also extend it and only override the relevant parts:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{# app/Resources/SensioGeneratorBundle/skeleton/crud/actions/create.php.twig #}

{# notice the "skeleton" prefix here -- more about it below #}
{% extends "skeleton/crud/actions/create.php.twig" %}

{% block phpdoc_header %}
     {{ parent() }}
     *
     * This is going to be inserted after the phpdoc title
     * but before the annotations.
{% endblock phpdoc_header %}

Complex templates in the default skeleton are split into Twig blocks to allow easy inheritance and to avoid copy/pasting large chunks of code.

In some cases, templates in the skeleton include other ones, like in the crud/views/edit.html.twig.twig template for instance:

1

{{ include('crud/views/others/record_actions.html.twig.twig') }}

If you have defined a custom template for this template, it is going to be used instead of the default one. But you can explicitly include the original skeleton template by prefixing its path with skeleton/ like we did above:

1

{{ include('skeleton/crud/views/others/record_actions.html.twig.twig') }}

You can learn more about this neat "trick" in the official Twig documentation.