Spiral\Scaffolder\Declaration\ControllerDeclaration

Complexity

Total Complexity

4

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	addPrototypeTrait()	0	4	1
A	declare()	0	4	1
A	addAction()	0	10	1
A	getInstructions()	0	4	1

<?php

declare(strict_types=1);

namespace Spiral\Scaffolder\Declaration;

use Psr\Http\Message\ResponseInterface;
use Spiral\Prototype\Traits\PrototypeTrait;
use Spiral\Reactor\Partial\Method;
use Spiral\Router\Annotation\Route;

/**
 * Declares controller.
 */
class ControllerDeclaration extends AbstractDeclaration implements HasInstructions
{
    public const TYPE = 'controller';

    public function addAction(string $action): Method
    {
        return $this->class
            ->addMethod($action)
            ->addComment(
                'Please, don\'t forget to configure the Route attribute or remove it and register the route manually.'
            )
            ->setPublic()
            ->addAttribute(Route::class, ['route' => 'path', 'name' => 'name'])
            ->setReturnType(ResponseInterface::class);
    }

    public function addPrototypeTrait(): void
    {
        $this->namespace->addUse(PrototypeTrait::class);
        $this->class->addTrait(PrototypeTrait::class);
    }

    public function declare(): void
    {
        $this->namespace->addUse(Route::class);
        $this->namespace->addUse(ResponseInterface::class);
    }

    public function getInstructions(): array
    {
        return [
            'Read more about Controllers in the documentation: https://spiral.dev/docs/http-routing',
        ];
    }
}