Skip to content
No description, website, or topics provided.
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
.php_cs.dist
LICENSE
README.md
composer.json

README.md

terminal42/service-annotation-bundle

This bundle allows to add tags to container services using annotations. Similar to services subscribers for events, this allows the class to contain all necessary information within the same file.

This is most helpful if you use autowiring and autoconfiguration in your service definitions, but it works without it (e.g. for bundles) nonetheless.

Installation

$ composer.phar require terminal42/service-annotation-bundle ^1.0

Afterwards, make sure to enable the Terminal42\ServiceAnnotation\Terminal42ServiceAnnotationBundle in your kernel.

Configuration

The bundle currently does not provide any service configuration.

How to use

Using autowiring and autoconfiguration (for apps)

If you're using this bundle in your app, you can enable autowiring and autoconfiguration in your service definition.

Example:

// config/services.yml

services:
    _defaults:
        autoconfigure: true
        autowiring: true

    App\:
        resource: ../src/*
// src/EventListener/KernelListener.php

namespace App\EventListener;

use Psr\Log\LoggerInterface;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Terminal42\ServiceAnnotationBundle\ServiceAnnotationInterface;
use Terminal42\ServiceAnnotationBundle\Annotation\ServiceTag;

/**
 * @ServiceTag("monolog.logger", channel="routing")
 */
class KernelListener implements ServiceAnnotationInterface
{
    private $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    /**
     * @ServiceTag("kernel.event_listener", event="kernel.request")
     */
    public function onKernelRequest(GetResponseEvent $event)
    {
        $this->logger->debug('Request for '.$event->getRequest()->getRequestUri());
    }
}

If an annotation is added to a method instead of the class, the method name is automatically added to the service tag "method" argument.

Without autowiring (for bundles)

For bundles, it is not best practice to use autowiring. Autoconfig can still be used, so the only change is to manually set the arguments in your service definition. Everything else will work as shown in the example above.

Without autoconfig (everything manual)

If you refrain from using autoconfig, you can still use this feature. Instead of using the marker interface Terminal42\ServiceAnnotationBundle\Annotation\ServiceAnnotationInterface, you need to add one tag to your service so they can be found in the container. It can then load an unlimited number of tags from annotations.

Example:

// config/services.yml

services:
    _defaults:
        autoconfigure: false
        autowiring: false

    foo_bar.listener.kernel:
        class: Foo\BarBundle\EventListener\KernelListener
        arguments:
            - '@logger'
        tags: ['terminal42_service_annotation']

Extending the annotations

If your bundle provides new tags to other services, you can improve DX by providing your own annotations. Good IDEs like PhpStorm can then provide autocomplete support.

Example:


use Doctrine\Common\Annotations\Annotation\Attribute;
use Doctrine\Common\Annotations\Annotation\Attributes;
use Doctrine\Common\Annotations\Annotation\Target;
use Terminal42\ServiceAnnotationBundle\Annotation\ServiceTagInterface;

/**
 * @Annotation
 * @Target("CLASS")
 * @Attributes({
 *     @Attribute("channel", type = "string", required = true),
 * })
 */
class Logger implements ServiceTagInterface
{
    public $channel;

    public function getName(): string
    {
        return 'monolog.logger';
    }

    public function getAttributes(): array
    {
        return ['channel' => $this->channel];
    }
}

Applying this to the example above, the class annotation can be simplified like this:

// src/EventListener/KernelListener.php

namespace App\EventListener;

use Terminal42\ServiceAnnotationBundle\ServiceAnnotationInterface;

/**
 * @Logger(channel="routing")
 */
class KernelListener implements ServiceAnnotationInterface
{
    // Same class as before
}
You can’t perform that action at this time.