AdminSearchBlockService::execute() - Code Metrics - Inspection of "Prepare support for block 4" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.x (#6220)

by Vincent

created 2020-07-22 21:11 UTC

AdminSearchBlockService::execute() A

↳ Parent: AdminSearchBlockService

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	35
rs	9.0488
c	0
b	0
f	0
cc	5
nc	5
nop	2

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * 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 <[email protected]>
 */
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(

                    'Argument 1 passed to %s() must be either 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(

                    'Argument 3 passed to %s() must be either 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(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                '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(

                    '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(

                    '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(

                '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'), [

            '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']);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\AdminBundle\Block;
15
16			use Sonata\AdminBundle\Admin\AdminInterface;
17			use Sonata\AdminBundle\Admin\Pool;
18			use Sonata\AdminBundle\Search\SearchHandler;
19			use Sonata\BlockBundle\Block\BlockContextInterface;
20			use Sonata\BlockBundle\Block\Service\AbstractBlockService;
21			use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
22			use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
23			use Symfony\Component\HttpFoundation\Response;
24			use Symfony\Component\OptionsResolver\OptionsResolver;
25			use Twig\Environment;
26
27			/**
28			* @final since sonata-project/admin-bundle 3.52
29			*
30			* @author Thomas Rabaix <[email protected]>
31			*/
32			class AdminSearchBlockService extends AbstractBlockService
33			{
34			/**
35			* @var Pool
36			*/
37			protected $pool;
38
39			/**
40			* @var SearchHandler
41			*/
42			protected $searchHandler;
43
44			/**
45			* NEXT_MAJOR: Change signature for
46			* - Environment $twig
47			* - Pool $pool
48			* - SearchHandler $searchHandler
49			*
50			* @param Environment\|string $twigOrName
51			* @param Pool\|EngineInterface\|null $poolOrTemplating
52			* @param SearchHandler\|Pool $searchHandlerOrPool
53			*/
54			public function __construct($twigOrName, ?object $poolOrTemplating, object $searchHandlerOrPool, ?SearchHandler $searchHandler = null)
55			{
56			if ($poolOrTemplating instanceof Pool) {
57			if (!$twigOrName instanceof Environment) {
58			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-22 21:14 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 1 pass... \gettype($twigOrName))`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
59			'Argument 1 passed to %s() must be either an instance of %s, %s given.',
60			__METHOD__,
61			Environment::class,
62			\is_object($twigOrName) ? 'instance of '.\get_class($twigOrName) : \gettype($twigOrName)
63			));
64			}
65
66			if (!$searchHandlerOrPool instanceof SearchHandler) {
67			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-22 21:14 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 3 pass...get_class($twigOrName))`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
68			'Argument 3 passed to %s() must be either an instance of %s, instance of %s given.',
69			__METHOD__,
70			SearchHandler::class,
71			\get_class($twigOrName)
72			));
73			}
74
75			parent::__construct($twigOrName);
76
77			$this->pool = $poolOrTemplating;
78			$this->searchHandler = $searchHandlerOrPool;
79			} elseif (null === $poolOrTemplating \|\| $poolOrTemplating instanceof EngineInterface) {
80			@trigger_error(sprintf(
			0 ignored issues – show Security Best Practice introduced 2020-07-20 16:45 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
81			'Passing %s as argument 2 to %s() is deprecated since sonata-project/admin-bundle 3.x'
82			.' and will throw a \TypeError in version 4.0. You must pass an instance of %s instead.',
83			null === $poolOrTemplating ? 'null' : EngineInterface::class,
84			__METHOD__,
85			Pool::class
86			), E_USER_DEPRECATED);
87
88			if (!$searchHandlerOrPool instanceof Pool) {
89			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-22 21:14 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 2 pass...get_class($twigOrName))`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
90			'Argument 2 passed to %s() must be an instance of %s, instance of %s given.',
91			__METHOD__,
92			Pool::class,
93			\get_class($twigOrName)
94			));
95			}
96
97			if (null === $searchHandler) {
98			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-22 21:14 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Passing null as...h\SearchHandler::class)`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
99			'Passing null as argument 3 to %s() is not allowed when %s is passed as argument 2.'
100			.' You must pass an instance of %s instead.',
101			__METHOD__,
102			EngineInterface::class,
103			SearchHandler::class
104			));
105			}
106
107			parent::__construct($twigOrName, $poolOrTemplating);
108
109			$this->pool = $searchHandlerOrPool;
110			$this->searchHandler = $searchHandler;
111			} else {
112			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-22 21:14 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 2 pass...ass($poolOrTemplating))`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
113			'Argument 2 passed to %s() must be either null or an instance of %s or preferably %s, instance of %s given.',
114			__METHOD__,
115			EngineInterface::class,
116			Pool::class,
117			\get_class($poolOrTemplating)
118			));
119			}
120			}
121
122			public function execute(BlockContextInterface $blockContext, ?Response $response = null)
123			{
124			try {
125			$admin = $this->pool->getAdminByAdminCode($blockContext->getSetting('admin_code'));
126			} catch (ServiceNotFoundException $e) {
127			throw new \RuntimeException('Unable to find the Admin instance', $e->getCode(), $e);
128			}
129
130			if (!$admin instanceof AdminInterface) {
131			throw new \RuntimeException('The requested service is not an Admin instance');
132			}
133
134			$admin->checkAccess('list');
135
136			$pager = $this->searchHandler->search(
137			$admin,
138			$blockContext->getSetting('query'),
139			$blockContext->getSetting('page'),
140			$blockContext->getSetting('per_page')
141			);
142
143			if (false === $pager) {
144			$response = $response ?: new Response();
145
146			return $response->setContent('')->setStatusCode(204);
147			}
148
149			return $this->renderPrivateResponse($admin->getTemplate('search_result_block'), [
			0 ignored issues – show Deprecated Code introduced 2020-01-09 07:32 UTC by Report Bug Copy Issue Report The method `Sonata\AdminBundle\Admin...nterface::getTemplate()` has been deprecated with message: since sonata-project/admin-bundle 3.35. To be removed in 4.0. Use TemplateRegistry services instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
150			'block' => $blockContext->getBlock(),
151			'settings' => $blockContext->getSettings(),
152			'admin_pool' => $this->pool,
153			'pager' => $pager,
154			'admin' => $admin,
155			], $response);
156			}
157
158			public function getName()
159			{
160			return 'Admin Search Result';
161			}
162
163			public function configureSettings(OptionsResolver $resolver)
164			{
165			$resolver
166			->setDefaults([
167			'admin_code' => '',
168			'query' => '',
169			'page' => 0,
170			'per_page' => 10,
171			'icon' => '<i class="fa fa-list"></i>',
172			])
173			->setRequired('admin_code')
174			->setAllowedTypes('admin_code', ['string']);
175			}
176			}
177

sonata-project / SonataAdminBundle

Pull Request — 3.x (#6220)

AdminSearchBlockService::execute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like