tbbc/symfony-cqrs-edition

The Big Brains Company "Symfony CQRS Edition"

The Big Brains Company - Symfony CQRS Edition

A default structure for CQRS oriented project and Symfony., _(*1)

What's inside?

TODO, _(*2)

Requirements

• PHP >= 5.3.3

1. Quick start

1.1 Install composer if it is not installed yet

Composer installation instructions, _(*3)

1.2 Create a new project with composer

$ php composer.phar create-project -s dev tbbc/symfony-cqrs-edition path/to/install dev-master

Composer will install the project and all its dependencies under the path/to/install directory., _(*4)

Note 1: Because it is not stable yet, you have to explicity set the dev-master version., _(*5)

1.3 Visit the project URL

After composer installation is complete, visit the url to the project in your brower for further instructions!, _(*6)

2. Overview

2.1 The project structure

DDD (Domain Driven Development) and CQRS (Command/Query Responsability Segregation) aims to focus on the domain (ie: your business)., _(*7)

This project structure tries to properly separate the technical aspects and the actual business logic., _(*8)

Based on previous experiments, POO paradigms, DDD best practices, we have defined three main "layers" for an application., _(*9)

2.1.1 The Domain

It gathers the actual business logic, business rules, free of any framework implementations, _(*10)

This layers is splitted in two parts, as defined by the CQRS abbreviation., _(*11)

The Command layer is somewhat the write layer, in charge of updating the state of your domain, while the Query is in charge of Reporting., _(*12)

2.1.2 The Infrastructure

Infrastructure relates to any components that are not part of your domain and which interchangeables. This can be a Doctrine/DBAL repository, a Mailer service, or any third parties adapter. This is also here that we do the glue between the domain and any MVC framework., _(*13)

2.1.3 The UI

CQRS/DDD mainly focus on a "Task Based UI", this means tasks are often mapped to actual command of your domain. UI, User Interface, is usually a website with HTML views, but it is also any CLI commands or even a REST API., _(*14)

2.1.4 Default structure

src
└── Acme
    └── Task
        ├── Command
        ├── Domain
        │   ├── Event
        │   ├── Handler
        │   ├── Model
        │   └── Repository
        ├── Infrastructure
        │   ├── InfrastructureBundle
        │   └── Persistence
        ├── Query
        │   ├── EventHandler
        │   ├── Repository
        │   └── ViewModel
        └── Ui
            ├── CliBundle
            ├── SharedBundle
            └── WebBundle

In the Symfony CQRS Edition, the InfrastructureBundle is the heart of the application. It is the glue between your domain and the actual Symfony framework., _(*15)

The UI layer contains all the Controllers, as well as views, themes, or any configuration which will be passed through container parameters to your Domain., _(*16)

Note: the term Command may apply to both CLI Command and Command in CQRS, it should not be confused as it refers to two different concepts, _(*17)

3. Getting started with CQRS

TODO, _(*18)

4. Contributing

1. Take a look at the list of issues.
2. Fork
3. Write a test (for either new feature or bug)
4. Make a PR

5. Authors

• Boris Guéry - guery.b@gmail.com - @borisguery - http://borisguery.com
• Benjamin Dulau - benjamin.dulau@gmail.com - @delendial - http://benjamindulau.com

6. License

The Big Brains Company - Symfony CQRS Edition is licensed under the MIT License - see the LICENSE file for details, _(*19)

, _(*20)