Shlinkio\Shlink\Rest\Action\ListShortcodesAction

Complexity

Total Complexity

8

Size/Duplication

Total Lines	66
Duplicated Lines	13.64 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	9	9	1
A	dispatch()	0	14	2
B	queryToListParams()	0	9	5

<?php
namespace Shlinkio\Shlink\Rest\Action;

use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
use Shlinkio\Shlink\Core\Service\ShortUrlService;
use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
use Shlinkio\Shlink\Rest\Util\RestUtils;
use Zend\Diactoros\Response\JsonResponse;
use Zend\I18n\Translator\TranslatorInterface;

class ListShortcodesAction extends AbstractRestAction
{
    use PaginatorUtilsTrait;

    /**
     * @var ShortUrlServiceInterface
     */
    private $shortUrlService;
    /**
     * @var TranslatorInterface
     */
    private $translator;

    /**
     * ListShortcodesAction constructor.
     * @param ShortUrlServiceInterface|ShortUrlService $shortUrlService
     * @param TranslatorInterface $translator
     * @param LoggerInterface $logger
     *
     * @Inject({ShortUrlService::class, "translator", "Logger_Shlink"})
     */
    public function __construct(

This method seems to be duplicated in your project.

        ShortUrlServiceInterface $shortUrlService,
        TranslatorInterface $translator,
        LoggerInterface $logger = null
    ) {
        parent::__construct($logger);
        $this->shortUrlService = $shortUrlService;
        $this->translator = $translator;
    }

    /**
     * @param Request $request
     * @param Response $response
     * @param callable|null $out
     * @return null|Response
     */
    public function dispatch(Request $request, Response $response, callable $out = null)
    {
        try {
            $params = $this->queryToListParams($request->getQueryParams());
            $shortUrls = $this->shortUrlService->listShortUrls(...$params);

$params is of type array<integer,?,{"0":"?","1":"?","2":"?","3":"?"}>, but the function expects a integer.

            return new JsonResponse(['shortUrls' => $this->serializePaginator($shortUrls)]);

It seems like $shortUrls defined by $this->shortUrlService->listShortUrls(...$params) on line 57 can also be of type array<integer,object<Shlinkio\Shlink\Core\Entity\ShortUrl>>; however, Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait::serializePaginator() does only seem to accept object<Zend\Paginator\Paginator>, maybe add an additional type check?

        } catch (\Exception $e) {
            $this->logger->error('Unexpected error while listing short URLs.' . PHP_EOL . $e);
            return new JsonResponse([
                'error' => RestUtils::UNKNOWN_ERROR,
                'message' => $this->translator->translate('Unexpected error occurred'),
            ], 500);
        }
    }

    /**
     * @param array $query
     * @return string
     */
    public function queryToListParams(array $query)
    {
        return [
            isset($query['page']) ? $query['page'] : 1,
            isset($query['searchTerm']) ? $query['searchTerm'] : null,
            isset($query['tags']) ? $query['tags'] : [],
            isset($query['orderBy']) ? $query['orderBy'] : null,
        ];
    }
}