Moved to wame/GeneratorBundle

This repo will be removed. Content has been moved over to https://github.com/wame/GeneratorBundle

WameSensioGeneratorBundle

Extension and modification of the SensioGeneratorBundle. Basic usage is quite similar, except that 'doctrine' is replaced with 'wame' in the command names: doctrine:generate:entity becomes wame:generate:entity

For more information about the sensioGeneratorBundle, see the official SensioGeneratorBundle documentation.

The SensioGenerator lacks what we want:

• PHP 7.1 enables more typehints. We intent to use them.
• Generation of entity relationships (many2one, one2many, one2one, many2many)
• Ability to use enum-types.
• Gedmo traits: we often use softdeleteable, timestampable and/or blameable.
• Datatables: for large sets of data a simple table won't do, so we use sg_datatables for them.
• Voters: for many entities with CRUD, we use specific voters.
• Translations: even though we may not need a multilanguage application, we use translation files for many names such as column names.

This bundle adds these features.

Required / Recommended bundles

By default, the following bundles are assumed to be installed and configured:

• DatatablesBundle for datatables.
  If you do not wish to use datatables, you could add wame_sensio_generator.enable_datatables: false to your config.yml, so that you won't be bothered with the question of using datatables.
• StofDoctrineExtensionsBundle for Gedmo trait-options. If you do not wish to use these traits, you could add wame_sensio_generator.enable_traits: false to your config.yml, so that you won't be bothered with questions about using traits.
• DoctrineEnumBundle for enumerables.
  If you do not intent to use enum, simply do not use it when asked for a property type.

Configuration options

No configuration is required, but you might want to alter some settings to specific needs. The following configuration show the default settings:

wame_sensio_bundle:
    default_bundle: 'AppBundle' #The bundle used whenever none is specified.
    enable_voters: true         #use false if you don't plan on using voters
    enable_traits: true         #use false if you don't plan on using gedmo traits
    enable_datatables: true     #use false if you don't plan on using SgDatatables

Entity generation

command: wame:generate:entity

Similar to doctrine:generate:entity command, but with changes described below.

Removed options:

Compared to doctrine's entity generator, some options are not available in this bundle:

• --entity
  Since there's already an argument 'entity' it'll also be removed in symfony 4, this option is left out for this generator.
• --format
  The 'annotation' format is the only format in this bundle. The entity generator is rendered through twig files. Support for multiple formats hasn't been implemented.

Additional options:

• --no-blameable
  Set this option to ensure blameable isn't used.
• --no-timestampable
  Set this option to ensure timestampable isn't used.
• --no-softdeleteable
  Set this option to ensure softdeleteable isn't used.
• --behaviours
  Use to define one of the behaviors 'softdeleteable', 'timestampable' or 'blameable'. Can be used multiple times for adding multiple behaviours.
  eg --behaviours=timestampable --behaviours=blameable
• --display-field
  define which property will be used in the __toString method.
  eg --display-field=title
• --no-validation
  Set this option to skip questions about validation

Default bundle (Appbundle)

After dozens of times, even typing a simple AppBundle:EntityName becomes cumbersome. Since many application will only use the AppBundle, the generator assumes this bundle should be used whenever no bundle is provided. So instead of wame:generate:entity AppBundle:Product you can use wame:generate:entity Product.

If you wish to use a different default bundle, you can override this setting in your config.yml

wame_sensio_generator:
    default_bundle: AppBundle

You can replace AppBundle with any bundle name you need it to be.

Additional types

In interactive mode, you can add additional types for relations and enums:

• many2one
• one2many
• one2one
• many2many
• enum

If you whish to pass these types as fields without interaction, you'll have to specifiy the targetEntity for relations and the enumType for enum.
Example:

`php bin/console wame:generate:entity Product --fields="
bookStore:many2one(targetEntity=BookStore)
type:enum(enumType=BookType)
"` -n

Validations

In interactive mode, for each field you'll be asked to add validations.

You can also pass validations to the fields in non-interactive mode, for example:

`php bin/console wame:generate:entity Customer --fields="
email:string(validation=Email;NotBlank)
"` -n

Multiple validations can be passed by seperating them by a ';' as shown in the example.

It is not possible to set validation-options. You'll still need to modify the entity if you need them.

Savepoint

In interactive mode, after every field you've added, a savepoint-file will be updated. If during the next field you make a mistake, you can cancel the generation and start from the savepoint by using the savepoint option, eg:

php bin/console wame:generate:entity --savepoint

For instance, if you're creating an entity Product, and you just added the fields 'name', 'product_type' and you're currently adding the field 'active_from', but mistakenly choose the type 'string' instead of date, you can cancelt the command, use the command above and start adding 'active_from' again.

CRUD generation

command: wame:generate:crud

Similar to doctrine:generate:crud command, but with changes described below.

Removed options:

For the exact same reasons as the entity generator, the --entity and --format options have been removed.

Additional options

• --with-datatable
  add this option if you want to have the datatable generated.
• ---with-voter add this option if you want to have the voter generated.

These options only need to be used in non-interactive mode, since they will be asked for during interactive mode.

Form generation

For an entity a form can be generated either during CRUD generation or if you wish to generate the form only, you can use the specific form-command.

command: wame:generate:form
argument: entity
options: --overwrite

The generated form will contain all entity-fields with the exception of the id-field and the fields that are defined in the gedmo-traits.

Datatable generation

For an entity a datatable can be generated either during CRUD generation or if you only wish to generate the datatable, you can use the specific command for datatable generation.

command: wame:generate:datatable
argument: entity
options: --overwrite

The datatable that is generated will contain all fields, except relationships and fields that are defined in the traits. Most likely you'll need to make some changes to this file to fit your needs.

If you generate the first datatable, two extra classes will be generated:

• AppDatatable`
  This is an abstract class that other datatables will extend.
• DatatableResultService
  This is a service class that will be used in controllers. It will call for a modifyquery callback which you can set in your datatables to change queries to your specific needs. This way you do not need to mess with code inside your controllers.

You can change these files to your needs, but make sure you won't break the code that is being generated for controllers.

The generator will generate the files for these classes only if they do not exist yet. The --overwrite option has no effect on these files.

Voter generation

For an entity a voter can be generated either during CRUD generation or if you only wish to generate the voter, you can use the specific voter-command.

command: wame:generate:voter
argument: entity
options: --overwrite

The generated voter will always contain attributes for action that could possibily be generated, no matter if they are actually generated or not:

• INDEX
  intended for the index action
• SEARCH
  intended for the results action (which is generated when you're using datatables)
• VIEW
  intended for the show action
• CREATE
  intended for the new action
• EDIT
  intended for the edit action
• DELETE
  intended for the delete action

Each attribute is prefixed with the upper cased underscored entity name. Eg a voter for the entity ProductStore would have an attribute PRODUCT_STORE_INDEX.

By default all attributes will only return true for the admin, so you'll most likely need to change this file.

When you generate the first voter an additional class will be generated:

• AppVoter
  This class is extended by the other voters that are generated. You can alter this file to fit your needs. This file will only be generated if it doesn't exist yet and is not affected by the --overwrite option.

Enum generation

command: wame:generate:enum
argument: enum
options: --overwrite, --options

For --options a string can be provided that contains sets for each options in the following format:
"value,CONST,Label|value-two,CONST_TWO,Label two"

For example, if you wish to create a StatusType with 'new', 'in-progress' and 'completed' options, you could use the following command:

php bin/console wame:generate:enum StatusType --options="new,NEW,New|in-progress,IN_PROGRESS,In progress|completed,COMPLETED,Completed"

If you so prefer, you can also use the array format, but make sure it is provided as a string:

php bin/console wame:generate:enum StatusType --options="[
    [new,NEW,New],
    [in-progress,IN_PROGRESS,In progress]
    [completed,COMPLETED,Completed]
]"

If you're feeling extra lazy, you can leave out the constant and label. These will then automatically be determined by the generator.

php bin/console wame:generate:enum StatusType --options="new|in-progress|completed"

Overwriting twig files

Just like the SensioGenerator, you can overwrite the twig skeleton files of the WameSensioGenerator in the following directory: App/Resources/WameSensioGeneratorBundle/skeleton

For more information about overwriting skeleton files, see: http://symfony.com/doc/2.5/bundles/SensioGeneratorBundle/index.html#overriding-skeleton-templates

More than just crud, this bundle allows you to overwrite the following parts as well:

• entity
• form
• repository
• voter
• translation

TODO's

• usage of the 'Resources/translations/roles.(en|nl).yml.twig'
• interface: a concept is created, but no longer works after several changes.
• configuration:
  • there are configuration settings for using different trait-classes, but the generator does not take these settings into account. This should be implemented or the settings should be removed.
  • a setting for using datatables by default exists, but the generator currently ignores this setting. This is still to be implemented.
  • More settings/defaults:
    we may want to set specific traits to be used or not by default. For instance, some application may never use datatables, so that option should be possible to disable for those applications.
• tests
  • currently, this bundle still holds the sensio-testfiles, but these no longer are compatible with this bundle. These tests need to be modified and extended.
  • The sensiogenerator also generated test-files. Since files are rather empty, they are left out, but generating test files still might be quite helpful.
• rename bundle:
  This bundle started as a fork from SensioGeneratorBundle to just make a few modifications in the original code. Since we already have a WameGeneratorBundle, we named this form to WameSensioGeneratorBundle. However, for most code an entirely different approached is used and 'few' has become alot, so the 'Sensio' part feels a bit odd at this point.