Feature/ADF-660/ParamConverter

[shpran]

ADF-660

Examples

Method: GET
URL: extension/SomeController/someAction?uri=someUri&value=someValue&data[uri]=anotherUri&data[value]=anotherValue

Old code

class SomeController
{
    public function someAction(): void
    {
        $uri = $this->getGetParameter('uri', '');
        $value = $this->getGetParameter('value', 0);

        $this->someMethod($uri, $value);

        $data = $this->getGetParameter('data', []);
        $dataUri = $data['uri'] ?? null;
        $dataValue = $data['value'] ?? null;

        $this->anotherMethod($dataUri, $dataValue);
    }

    private function someMethod(string $uri, int $value): void
    {
        ... code ...
    }

    private function anotherMethod(?string $uri, ?string $value): void
    {
        ... code ...
    }
}

New code

use TestClass;
use AnotherClass;
use oat\tao\model\ParamConverter\Configuration\ParamConverter;

class SomeController
{
    /**
     * @ParamConverter("class", converter="oat.tao.param_converter.query")
     */
    public function someAction(TestClass $class): void
    {
        $this->someMethod($class);
        $this->anotherMethod($class->getData())
    }

    private function someMethod(TestClass $class): void
    {
        ... code ...
    }

    private function anotherMethod(AnotherClass $anotherClass): void
    {
        ... code ...
    }
}

use AnotherClass;

class TestClass
{
    /** @var string */
    private $uri;

    /** @var int */
    private $value;

    /** @var AnotherClass */
    private $data;

    public function __construct(string $uri, int $value)
    {
        $this->uri = $uri;
        $this->value = $value;
    }

    public function getUri(): string
    {
        return $this->uri;
    }

    public function getValue(): int
    {
        return $this->value;
    }

    public function getData(): AnotherClass
    {
        return $this->data;
    }

    public function setData(AnotherClass $anotherClass): void
    {
        $this->data = $anotherClass;
    }
}

class AnotherClass
{
    /** @var string/null */
    private $uri;

    /** @var string|null */
    private $value;

    public function getUri(): ?string
    {
        return $this->uri;
    }

    public function setUri(string $uri): void
    {
        $this->uri = $uri;
    }

    public function getValue(): ?string
    {
        return $this->value;
    }

    public function setValue(string $value): void
    {
        $this->value = $value;
    }
}

Require PRs

• Feature/ADF-660/Use new container to get services generis#925

Tasks

• Add unit tests
• Add / Update README.md
• Update composer.json dependencies

[gabrielfs7]

Really good initiative! Good job 🚀

[github-actions]

Version

Target Version	50.7.0
Last version	50.6.1

There are 0 BREAKING CHANGE, 2 features, 0 fix