architecture.md

Architecture

The application uses a command / event based architecture. The system is implemented using Simplebus

Controllers

The controllers main functionality is to accept HTTP requests and initialize the correct bussiness service. Controllers should contain no business logic.

Controllers can call the business logic using:

• the command bus
• provided services (example ProjectService)

Services and storages

Services and storages are currently used to load certain data (from API or local storage). The main class always comes with an interface. (Exampes: IntegrationTypeStorage and [ProjectService](src/Project/ProjectService.php

Entities

The entities are used to load and save data to the database using ORM. You can use the entity manager to load entities. Example of loading and saving:

$coupon = $this->entityManager->getRepository('ProjectAanvraag:Coupon')->find($activateProject->getCouponToUse());
$coupon->setUsed(true);
$this->entityManager->persist($coupon);
$this->entityManager->flush(); 

Commands

To implement a command, following steps are required:

• Create your command class (example RequestActivation)
• Create a handler class. The handler class should contain a handle method that receives the type of command it can handle. (example RequestActivation)
• Add your handler in the configuration). You can add dependencies for your handler as arguments.

handlers:
    create_project_handler:
        command: CultuurNet\ProjectAanvraag\Project\Command\CreateProject
        class: \CultuurNet\ProjectAanvraag\Project\CommandHandler\CreateProjectCommandHandler
        arguments:
            - event_bus
            - orm.em
            - culturefeed_test
            - culturefeed
            - uitid_user_session_data_complete

Events

To implement an event and related event listers. Following steps are required:

• Create your event class (example ProjectActivated)
  • An event can be thrown async or sync. If you want it to be consumed by rabbitmq, implement the AsynchronousMessageInterface interface.
  • By implementing the DelayableMessageInterface interface, an event can be thrown with a delay.
• Create an event listener. (example ProjectActivatedEventListener).
  • An event listener should always contain a handle method that receives the event.