Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/becklyn/ddd-generator-bundle
Code generator for common Domain Driven Design patterns in the Becklyn DDD framework.
https://github.com/becklyn/ddd-generator-bundle
code-generation code-generator ddd ddd-architecture php symfony symfony-bundle
Last synced: 23 days ago
JSON representation
Code generator for common Domain Driven Design patterns in the Becklyn DDD framework.
- Host: GitHub
- URL: https://github.com/becklyn/ddd-generator-bundle
- Owner: Becklyn
- Created: 2021-08-09T13:28:16.000Z (over 3 years ago)
- Default Branch: 1.x
- Last Pushed: 2022-01-18T15:03:31.000Z (almost 3 years ago)
- Last Synced: 2024-10-11T19:53:06.324Z (about 1 month ago)
- Topics: code-generation, code-generator, ddd, ddd-architecture, php, symfony, symfony-bundle
- Language: PHP
- Size: 296 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
DDD Generator Bundle
=====================
Make sure Composer is installed globally, as explained in the
[installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
Applications that use Symfony Flex
----------------------------------
Open a command console, enter your project directory and execute:
```console
composer require becklyn/ddd-generator-bundle --dev
```
Applications that don't use Symfony Flex
----------------------------------------
### Step 1: Download the Bundle
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:
```console
composer require becklyn/ddd-generator-bundle --dev
```
### Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the `config/bundles.php` file of your project:
```php
// config/bundles.php
return [
// ...
Becklyn\DddGeneratorBundle\BecklynDddGeneratorBundle::class => ['dev' => true],
];
```
Creating your own Generator/Maker
----------------------------------------
If you want to create your own Generator based on the DddMaker
you'll need to extend either of the abstract Maker classes.
Be sure not to extend a non-abstract class unless you can ensure that
their implementation will never change.
If you can't ensure that it would be a better idea to use one of the following:
- DddMaker: The most general abstraction. In only provides functionality
without having a base implementation.
- DddEntityMaker: This is the easiest to use for implementing a generator based
on some input options. In fact most generator of this bundle use the DddEntityMaker.
- DddEntityTestMaker: A specialized DddEntityMaker for generating Test files.
- DddEntityCommandMaker: A specialized DddEntityMaker for generating Command and CommandHandler classes.
All you need to do to generate your own Generator is to create a class,
that extends a Maker in `src/Maker` and to create a template file.
The template file may be placed in `res/skeleton/ddd` or
`src/Resources/skeleton/ddd` and use the file extension `.tpl.php`.
If you cannot place the templates there you can also override the Makers `getTemplatePath()`.
Refer to the Templating section for more information about how to create templates.
Lastly you need to register your Maker as a Maker in your service configuration file.
This is done by providing the `maker.command` tag to the service.
A word about i18n
----------------------------------------
If you want to use the localization feature you should provide it using the
`getExtraVariables()` method and use as `$extra` in the template.
Alternatively you can override the `internationalize()` method, but you'll need to
provide any key the bundle defines internally to continue to use the pre-defined features.
Because these keys can change between every patch version it could be very hard for you
to ensure that no functionality breaks.
Templating
-----------
The template files itself are plain text files that get php variables injected using
`= $variableName; ?>`.
If you're using the `DddEntityMaker` or a class that extends it you can use the following variables:
- `$domain_namespace`: The Sub-Namespace of the Domain. E.g. `\App\Authorization\Domain\Foo` in this
Namespace `Foo` would be the Sub-Namespace. This is a can also be multi-level e.g. `Foo\Bar`
- `$entity`: Name of the Entity that should be generated. E.g. `User
- `$domain`:Name of the Domain that everything should be created in. E.g. `Authorization`
- `$psr4Root`: The Name of the PSR-4 Root as defined by Composer.
- `$i18n`: A array of i18n strings. The available keys are stored inside yaml files located at `src/Resources/i18n`.
This array should only be used for internal makers e.g. if you want to make a PR to this bundle.
Please refer to the i18n section.
- `$version`: The current date formatted as `YYYY-MM-DD`. This is used to auto-generate PHP-doc comments
- `$author`: The current git user formatted as `USERNAME ` or `Code Generator ` if the git user can not be read.
- `$extra`: A array that can be used to provide any information that is needed.
NOTE: If you override `getExtraVariables()` be sure to merge your array with the array of `super()` to ensure that nothing breaks.