Sonata\AdminBundle\Block\AdminSearchBlockService

Complexity

Total Complexity

17

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
C	__construct()	0	67	10
A	execute()	0	35	5
A	getName()	0	4	1
A	configureSettings()	0	13	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Block;

use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\Pool;
use Sonata\AdminBundle\Search\SearchHandler;
use Sonata\BlockBundle\Block\BlockContextInterface;
use Sonata\BlockBundle\Block\Service\AbstractBlockService;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Twig\Environment;

/**
 * @final since sonata-project/admin-bundle 3.52
 *
 * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
 */
class AdminSearchBlockService extends AbstractBlockService
{
    /**
     * @var Pool
     */
    protected $pool;

    /**
     * @var SearchHandler
     */
    protected $searchHandler;

    /**
     * NEXT_MAJOR: Change signature for (Environment $twig, Pool $pool, SearchHandler $searchHandler).
     *
     * @param Environment|string        $twigOrName
     * @param Pool|EngineInterface|null $poolOrTemplating
     * @param SearchHandler|Pool        $searchHandlerOrPool
     */
    public function __construct($twigOrName, ?object $poolOrTemplating, object $searchHandlerOrPool, ?SearchHandler $searchHandler = null)
    {
        if ($poolOrTemplating instanceof Pool) {
            if (!$twigOrName instanceof Environment) {
                throw new \TypeError(sprintf(

The call to TypeError::__construct() has too many arguments starting with sprintf('Argument 1 passed to %s() must be an instance of %s, %s given.', __METHOD__, \Twig\Environment::class, \is_object($twigOrName) ? 'instance of ' . \get_class($twigOrName) : \gettype($twigOrName)).

                    'Argument 1 passed to %s() must be an instance of %s, %s given.',
                    __METHOD__,
                    Environment::class,
                    \is_object($twigOrName) ? 'instance of '.\get_class($twigOrName) : \gettype($twigOrName)
                ));
            }

            if (!$searchHandlerOrPool instanceof SearchHandler) {
                throw new \TypeError(sprintf(

The call to TypeError::__construct() has too many arguments starting with sprintf('Argument 3 passed to %s() must be an instance of %s, instance of %s given.', __METHOD__, \Sonata\AdminBundle\Search\SearchHandler::class, \get_class($twigOrName)).

                    'Argument 3 passed to %s() must be an instance of %s, instance of %s given.',
                    __METHOD__,
                    SearchHandler::class,
                    \get_class($twigOrName)
                ));
            }

            parent::__construct($twigOrName);

            $this->pool = $poolOrTemplating;
            $this->searchHandler = $searchHandlerOrPool;
        } elseif (null === $poolOrTemplating || $poolOrTemplating instanceof EngineInterface) {
            @trigger_error(sprintf(

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

                'Passing %s as argument 2 to %s() is deprecated since sonata-project/admin-bundle 3.x'
                .' and will throw a \TypeError in version 4.0. You must pass an instance of %s instead.',
                null === $poolOrTemplating ? 'null' : EngineInterface::class,
                __METHOD__,
                Pool::class
            ), E_USER_DEPRECATED);

            if (!$searchHandlerOrPool instanceof Pool) {
                throw new \TypeError(sprintf(

The call to TypeError::__construct() has too many arguments starting with sprintf('Argument 2 passed to %s() must be an instance of %s, instance of %s given.', __METHOD__, \Sonata\AdminBundle\Admin\Pool::class, \get_class($twigOrName)).

                    'Argument 2 passed to %s() must be an instance of %s, instance of %s given.',
                    __METHOD__,
                    Pool::class,
                    \get_class($twigOrName)
                ));
            }

            if (null === $searchHandler) {
                throw new \TypeError(sprintf(

The call to TypeError::__construct() has too many arguments starting with sprintf('Passing null as argument 3 to %s() is not allowed when %s is passed as argument 2.' . ' You must pass an instance of %s instead.', __METHOD__, \Symfony\Bundle\FrameworkBundle\Templating\EngineInterface::class, \Sonata\AdminBundle\Search\SearchHandler::class).

                    'Passing null as argument 3 to %s() is not allowed when %s is passed as argument 2.'
                    .' You must pass an instance of %s instead.',
                    __METHOD__,
                    EngineInterface::class,
                    SearchHandler::class
                ));
            }

            parent::__construct($twigOrName, $poolOrTemplating);

            $this->pool = $searchHandlerOrPool;
            $this->searchHandler = $searchHandler;
        } else {
            throw new \TypeError(sprintf(

The call to TypeError::__construct() has too many arguments starting with sprintf('Argument 2 passed to %s() must be either null or an instance of %s or preferably %s, instance of %s given.', __METHOD__, \Symfony\Bundle\FrameworkBundle\Templating\EngineInterface::class, \Sonata\AdminBundle\Admin\Pool::class, \get_class($poolOrTemplating)).

                'Argument 2 passed to %s() must be either null or an instance of %s or preferably %s, instance of %s given.',
                __METHOD__,
                EngineInterface::class,
                Pool::class,
                \get_class($poolOrTemplating)
            ));
        }
    }

    public function execute(BlockContextInterface $blockContext, ?Response $response = null)
    {
        try {
            $admin = $this->pool->getAdminByAdminCode($blockContext->getSetting('admin_code'));
        } catch (ServiceNotFoundException $e) {
            throw new \RuntimeException('Unable to find the Admin instance', $e->getCode(), $e);
        }

        if (!$admin instanceof AdminInterface) {
            throw new \RuntimeException('The requested service is not an Admin instance');
        }

        $admin->checkAccess('list');

        $pager = $this->searchHandler->search(
            $admin,
            $blockContext->getSetting('query'),
            $blockContext->getSetting('page'),
            $blockContext->getSetting('per_page')
        );

        if (false === $pager) {
            $response = $response ?: new Response();

            return $response->setContent('')->setStatusCode(204);
        }

        return $this->renderPrivateResponse($admin->getTemplate('search_result_block'), [

The method Sonata\AdminBundle\Admin\AdminInterface::getTemplate() has been deprecated with message: since sonata-project/admin-bundle 3.35. To be removed in 4.0. Use TemplateRegistry services instead

            'block' => $blockContext->getBlock(),
            'settings' => $blockContext->getSettings(),
            'admin_pool' => $this->pool,
            'pager' => $pager,
            'admin' => $admin,
        ], $response);
    }

    public function getName()
    {
        return 'Admin Search Result';
    }

    public function configureSettings(OptionsResolver $resolver)
    {
        $resolver
            ->setDefaults([
                'admin_code' => '',
                'query' => '',
                'page' => 0,
                'per_page' => 10,
                'icon' => '<i class="fa fa-list"></i>',
            ])
            ->setRequired('admin_code')
            ->setAllowedTypes('admin_code', ['string']);
    }
}