Attributing

Last modified: 24 March 2024

To attribute request you need an attribute - class that implements Articus\PathHandler\Attribute\AttributeInterface:

namespace My;

use Articus\PathHandler\Attribute\AttributeInterface;
use Psr\Http\Message\ServerRequestInterface;

class Attribute implements AttributeInterface
{
    public function __invoke(ServerRequestInterface $request): ServerRequestInterface
    {
        return $request->withAttribute('some', 'thing');
    }
}

... and is registered in configuration:

#Add entry in attribute plugin manager
Articus\PathHandler\Attribute\PluginManager:
  invokables:
    MyAttribute: My\Attribute

To use attribute for operation in your handler you just need to annotate operation method:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity")]
class Handler
{
    #[PHA\Post()]
    #[PHA\Attribute("MyAttribute")]
    public function handlePost(ServerRequestInterface $request)
    {
        $value = $request->getAttribute('some');
    }
}

It is possible to pass configuration options to your attribute factory:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity")]
class Handler
{
    #[PHA\Post()]
    #[PHA\Attribute("MyAttribute", ["key" => "value"])]
    public function handlePost(ServerRequestInterface $request)
    {
        $value = $request->getAttribute('some');
    }
}

If all operations in your handler need same attribute you can just annotate handler class insteadof annotating each method:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity")]
#[PHA\Attribute("MyAttribute")]
class Handler
{
    #[PHA\Post()]
    public function handlePost(ServerRequestInterface $request)
    {
        $value = $request->getAttribute('some');
    }
    #[PHA\Patch()]
    public function handlePatch(ServerRequestInterface $request)
    {
        $value = $request->getAttribute('some');
    }
}

If you set multiple attributes for operation they will be invoked in the same order they appear in code:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity")]
#[PHA\Attribute("First")]
#[PHA\Attribute("Second")]
class Handler
{
    #[PHA\Post()]
    #[PHA\Attribute("Third")]
    #[PHA\Attribute("Fourth")]
    public function handlePost(ServerRequestInterface $request)
    {
    }
}

Or you can adjust this order with priority setting (default value is 1). Attributes with higher priority will be executed earlier:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity")]
class Handler
{
    #[PHA\Post()]
    #[PHA\Attribute("Second")]
    #[PHA\Attribute("First", priority: 10)]
    public function handlePost(ServerRequestInterface $request)
    {
    }
}

Build-in attributes

Library provides three attributes out of the box:

  • IdentifiableValueLoad that uses Data Transfer library to load some value by its identifier stored in request attribute

  • IdentifiableValueListLoad that uses Data Transfer library to load list of values by their identifiers stored in request

  • Transfer that uses Data Transfer library to construct DTO and fill it with request data only if this data is valid.

IdentifiableValueLoad usage

Add Articus\DataTransfer\IdentifiableValueLoader service inside your container, for example with a factory like:

namespace My;

use Articus\DataTransfer\IdentifiableValueLoader;
use Psr\Container\ContainerInterface;

class LoaderFactory
{
    public function __invoke(ContainerInterface $container)
    {
        return new IdentifiableValueLoader([
            "entity_type" => [
                static function (EntityClass $value) {
                    return $value->getId();//...or any other ay to get id from EntityClass instance
                },
                static function (array $ids) {
                    /** @var EntityClass[] $result */
                    $result = []
                    // load EntityClass instances for specified ids from database, external service, etc...
                    return $result;
                }
            ]
        ]);
    }
}

And then just add attribute to your handler:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity/{entity_id:[1-9][0-9]*}")]
#[PHA\Attribute("IdentifiableValueLoad", ["id_attr" => "entity_id", "type" => "entity_type", "value_attr" => "entity"])
class Handler
{
    #[PHA\Get()]
    public function handleGet(ServerRequestInterface $request)
    {
        /** @var EntityClass $entity */
        $entity = $request->getAttribute('entity');//This attribute will store loaded identifiable value
    }
}

For details see available options: Articus\PathHandler\Attribute\Options\IdentifiableValueLoad.

IdentifiableValueListLoad usage

Add Articus\DataTransfer\IdentifiableValueLoader service inside your container, for example with a factory like:

namespace My;

use Articus\DataTransfer\IdentifiableValueLoader;
use Psr\Container\ContainerInterface;

class LoaderFactory
{
    public function __invoke(ContainerInterface $container)
    {
        return new IdentifiableValueLoader([
            "entity_type" => [
                static function (EntityClass $value) {
                    return $value->getId();//...or any other ay to get id from EntityClass instance
                },
                static function (array $ids) {
                    /** @var EntityClass[] $result */
                    $result = []
                    // load EntityClass instances for specified ids from database, external service, etc...
                    return $result;
                }
            ]
        ]);
    }
}

Then provide custom callable service inside your container for emitting identifiers from request, for example entity_id_emitter with a factory like:

namespace My;

use Psr\Container\ContainerInterface;
use Psr\Http\Message\ServerRequestInterface as Request;

class EmitterFactory
{
    public function __invoke(ContainerInterface $container)
    {
        return static function (string $type, Request $request)/*: array<int|string> */
        {
            return $request->getAttribute('attr_with_array_of_ids');
        };
    }
}

And then just add attribute to your handler:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity/{entity_id:[1-9][0-9]*}")]
#[PHA\Attribute("IdentifiableValueLoad", ["id_emitter" => "entity_id_emitter", "type" => "entity_type", "list_attr" => "entity_list"])
class Handler
{
    #[PHA\Get()]
    public function handleGet(ServerRequestInterface $request)
    {
        /** @var EntityClass[] $entities */
        $entities = $request->getAttribute('entity_list');//This attribute will store list of loaded identifiable values
    }
}

For details see available options: Articus\PathHandler\Attribute\Options\IdentifiableValueListLoad.

Transfer usage

Set up Articus\DataTransfer\Service (check Data Transfer documentation for details) and then just add attribute to your handler:

namespace My;

use Articus\PathHandler\PhpAttribute as PHA;
use Psr\Http\Message\ServerRequestInterface;

#[PHA\Route("/entity")]
class Handler
{
    #[PHA\Post()]
    #[PHA\Attribute("Transfer", ["type"=>DTO::class,"subset"=>"part","source"=>"get","objectAttr"=>"dto","errorAttr"=>"errors"])]
    public function handlePost(ServerRequestInterface $request)
    {
        $errors = $request->getAttribute('errors');//This attribute will store validation errors
        if (empty($errors))
        {
            /** @var DTO $dto */
            $dto = $request->getAttribute('dto');//Valid DTO filled with data from query params
        }
    }
}

For details see available options: Articus\PathHandler\Attribute\Options\Transfer.