Yoanm\SymfonyJsonRpcHttpServerDoc\Listener\ServerDocCreatedListener

Complexity

Total Complexity

4

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	appendJsonRpcServerErrorsDoc()	0	63	4

<?php
namespace Yoanm\SymfonyJsonRpcHttpServerDoc\Listener;

use Yoanm\JsonRpcServer\Domain\Exception\JsonRpcInternalErrorException;
use Yoanm\JsonRpcServer\Domain\Exception\JsonRpcInvalidParamsException;
use Yoanm\JsonRpcServer\Domain\Exception\JsonRpcInvalidRequestException;
use Yoanm\JsonRpcServer\Domain\Exception\JsonRpcMethodNotFoundException;
use Yoanm\JsonRpcServer\Domain\Exception\JsonRpcParseErrorException;
use Yoanm\JsonRpcServerDoc\Domain\Model\ErrorDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ArrayDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\IntegerDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ObjectDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\Type\StringDoc;
use Yoanm\SymfonyJsonRpcHttpServerDoc\Event\ServerDocCreatedEvent;

/**
 * Class ServerDocCreatedListener
 */
class ServerDocCreatedListener
{
    /**
     * @param ServerDocCreatedEvent $event
     */
    public function appendJsonRpcServerErrorsDoc(ServerDocCreatedEvent $event) : void
    {
        $event->getDoc()
            ->addServerError( // Parse Error
                new ErrorDoc('Parse error', JsonRpcParseErrorException::CODE)
            )
            ->addServerError( // Invalid request
                (new ErrorDoc('Invalid request', JsonRpcInvalidRequestException::CODE))
            )
            ->addServerError( // Method not found
                (new ErrorDoc('Method not found', JsonRpcMethodNotFoundException::CODE))
            )
        ;

        $addParamsValidationError = true;
        // Search for existing error in server errors list (could have been already defined by an another bundle)
        // @see "yoanm/symfony-jsonrpc-params-sf-constraints-doc" package
        foreach ($event->getDoc()->getServerErrorList() as $serverError) {
            if (JsonRpcInvalidParamsException::CODE === $serverError->getCode()) {
                $addParamsValidationError = false;
                break;
            }
        }

        if (true === $addParamsValidationError) {
            $event->getDoc()->addServerError( // Params validations error
                (new ErrorDoc('Params validations error', JsonRpcInvalidParamsException::CODE))
                    ->setDataDoc(
                        (new ObjectDoc())
                            ->setAllowMissingSibling(false)
                            ->setAllowExtraSibling(false)
                            ->setRequired(true)
                            ->addSibling(
                                (new ArrayDoc())
                                    ->setName(JsonRpcInvalidParamsException::DATA_VIOLATIONS_KEY)
                            )
                    )
            );
        }

        $event->getDoc()->addServerError( // Internal error
            (new ErrorDoc('Internal error', JsonRpcInternalErrorException::CODE))
                ->setDataDoc(
                    (new ObjectDoc())
                        ->setAllowMissingSibling(true)
                        ->setAllowExtraSibling(false)
                        ->setRequired(false)
                        ->addSibling((
                            new StringDoc())
                                ->setName('_class')
                                ->setDescription('Exception class'))
                        ->addSibling((
                            new IntegerDoc())
                                ->setName('_code')
                                ->setDescription('Exception code'))
                        ->addSibling((
                            new StringDoc())
                                ->setName('_message')
                                ->setDescription('Exception message'))
                        ->addSibling((
                            new ArrayDoc())
                                ->setName('_trace')
                                ->setDescription('PHP stack trace'))
                )
        );
    }
}