hprotravel/composer-service-handler

Composer script handling for generating service definitions from class annotation

v1.3.0 2024-01-30 13:51 UTC

Requires

• php: >=8.1
• doctrine/annotations: ^2.0
• symfony/finder: ^6.4|^7.0
• symfony/yaml: ^6.4|^7.0

Requires (Dev)

• composer/composer: ^2.0
• phpspec/prophecy-phpunit: ^2.1
• phpunit/phpunit: ^10.5

MIT

• Burak Bolat

• dependency injection
• annotations
• service injection

README

Symfony annotation-based services.yml generator

Use Case

Minimizing conflict issues occurred by single-file based services.yml dependency injections

Installation

1. Install with composer

1. Add `Compass\ServiceHandler\ScriptHandler::buildServices` command of "symfony-scripts" list in composer.json. It should look like following:

    "scripts": {
        ...
        "post-install-cmd": [
           "Compass\\ServiceHandler\\ScriptHandler::buildServices",
           "@auto-scripts"
        ],
        "post-update-cmd": [
           "Compass\\ServiceHandler\\ScriptHandler::buildServices",
           "@auto-scripts"
        ],
        "post-autoload-dump": [
           "Compass\\ServiceHandler\\ScriptHandler::buildServices"
        ],
    }
       
       
   

2. Define which bundles will have automatic generated services.yml in app folder

   service.yml

    parameters:
        locale: en
        service_handler:
            App\:
                resource: 'src/'
                exclude: 'src/{Controller,Entity,Exclude,Repository,Kernel.php}'
   

1. Define which file will be handle in composer.json file extra section as compass-services

   composer.json

    "extra": {
         ...
         "compass-services": {
            "file": "config/services.yaml"
         }
    }
   
   

2. Add services.yml to .gitignore

Usage

services.yml will be auto-generated after each each execution composer install or composer update command

Usage of @Service annotation at repository class

namespace App\Repository;

use Compass\ServiceHandler\Annotation\Service;

/**
 * @Service(
 *     id="app.repository.my_repository",
 *     factory= {"@doctrine.orm.default_entity_manager", "getRepository"},
 *     arguments={"App:MyEntity"},
 *     calls={
 *          {"setSender", {"@App\Mailer\Sender"}}
 *     }
 *    )
 */
class MyRepository {

}

Usage of @Service annotation at event listener class

namespace App\EventListener;

use Compass\ServiceHandler\Annotation\Service;
use Compass\ServiceHandler\Annotation\Tag;

/**
 * @Service(
 *     id="app.event_listener.my_listener",
 *     arguments={
 *          "@App\Repository\MyRepository",
 *          "@App\Mailer\Sender"     
 *     },
 *     tags={
 *          @Tag(name="kernel.event_listener", event="success", method="onSuccess"),
 *          @Tag(name="kernel.event_listener", event="fail", method="onFail")
 *     }
 *    )
 */
class MyListener {

}

@Service annotation does not have any different usage than a services.yml based definition.