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

Completed

Pull Request — 3.x (#6212)

by Jordi Sala

created 2020-07-20 16:52 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: Remove `$deprecatedTemplatingOrNull` argument.
     *
     * @param Environment|string $twigOrDeprecatedName
     */
    public function __construct(
        $twigOrDeprecatedName,
        ?EngineInterface $deprecatedTemplatingOrNull,
        Pool $pool,
        SearchHandler $searchHandler
    ) {
        // NEXT_MAJOR: Remove conditions, only pass the Environment
        if ($deprecatedTemplatingOrNull 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/doctrine-orm-admin-bundle 3.x'
                . ' and will throw a \TypeError in version 4.0. You must pass null instead.',
                EngineInterface::class,
                __METHOD__
            ), E_USER_DEPRECATED);

            if (!\is_string($twigOrDeprecatedName)) {
                throw new \TypeError(sprintf(

                    'Passing other than string as argument 1 to %s() is not allowed when %s is passed as argument 2.'
                    . ' You must pass an string instead.',
                    __METHOD__,
                    EngineInterface::class
                ));
            }

            parent::__construct($twigOrDeprecatedName, $deprecatedTemplatingOrNull);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } elseif ($twigOrDeprecatedName instanceof Environment) {
            if (!\is_null($deprecatedTemplatingOrNull)) {
                throw new \TypeError(sprintf(

                    'Argument 2 passed to %s() must be null if you passing %s as first argument, %s given.',
                    __METHOD__,
                    Environment::class,
                    EngineInterface::class
                ));
            }

            parent::__construct($twigOrDeprecatedName);
        } else {
            throw new \TypeError(sprintf(

                'Argument 1 passed to %s() should be an instance of %s, and you should leave argument 2 as null.',
                __METHOD__,
                Environment::class
            ));
        }

        $this->pool = $pool;
        $this->searchHandler = $searchHandler;
    }

    public function execute(BlockContextInterface $blockContext, ?Response $response = null): Response
    {
        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): void
    {
        $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: Remove `$deprecatedTemplatingOrNull` argument.
46			*
47			* @param Environment\|string $twigOrDeprecatedName
48			*/
49			public function __construct(
50			$twigOrDeprecatedName,
51			?EngineInterface $deprecatedTemplatingOrNull,
52			Pool $pool,
53			SearchHandler $searchHandler
54			) {
55			// NEXT_MAJOR: Remove conditions, only pass the Environment
56			if ($deprecatedTemplatingOrNull instanceof EngineInterface) {
57			@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...
58			'Passing %s as argument 2 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.x'
59			. ' and will throw a \TypeError in version 4.0. You must pass null instead.',
60			EngineInterface::class,
61			__METHOD__
62			), E_USER_DEPRECATED);
63
64			if (!\is_string($twigOrDeprecatedName)) {
65			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-20 16:45 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Passing other t...EngineInterface::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...
66			'Passing other than string as argument 1 to %s() is not allowed when %s is passed as argument 2.'
67			. ' You must pass an string instead.',
68			__METHOD__,
69			EngineInterface::class
70			));
71			}
72
73			parent::__construct($twigOrDeprecatedName, $deprecatedTemplatingOrNull);
			0 ignored issues – show Documentation introduced 2020-07-20 16:55 UTC by Report Bug Copy Issue Report `$twigOrDeprecatedName` is of type `string`, but the function expects a `object<Twig\Environment>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2020-07-20 16:55 UTC by Report Bug Copy Issue Report The call to `AbstractBlockService::__construct()` has too many arguments starting with `$deprecatedTemplatingOrNull`. 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...
74			} elseif ($twigOrDeprecatedName instanceof Environment) {
75			if (!\is_null($deprecatedTemplatingOrNull)) {
76			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-20 16:45 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 2 pass...EngineInterface::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...
77			'Argument 2 passed to %s() must be null if you passing %s as first argument, %s given.',
78			__METHOD__,
79			Environment::class,
80			EngineInterface::class
81			));
82			}
83
84			parent::__construct($twigOrDeprecatedName);
85			} else {
86			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-20 16:45 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 1 pass...wig\Environment::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...
87			'Argument 1 passed to %s() should be an instance of %s, and you should leave argument 2 as null.',
88			__METHOD__,
89			Environment::class
90			));
91			}
92
93			$this->pool = $pool;
94			$this->searchHandler = $searchHandler;
95			}
96
97			public function execute(BlockContextInterface $blockContext, ?Response $response = null): Response
98			{
99			try {
100			$admin = $this->pool->getAdminByAdminCode($blockContext->getSetting('admin_code'));
101			} catch (ServiceNotFoundException $e) {
102			throw new \RuntimeException('Unable to find the Admin instance', $e->getCode(), $e);
103			}
104
105			if (!$admin instanceof AdminInterface) {
106			throw new \RuntimeException('The requested service is not an Admin instance');
107			}
108
109			$admin->checkAccess('list');
110
111			$pager = $this->searchHandler->search(
112			$admin,
113			$blockContext->getSetting('query'),
114			$blockContext->getSetting('page'),
115			$blockContext->getSetting('per_page')
116			);
117
118			if (false === $pager) {
119			$response = $response ?: new Response();
120
121			return $response->setContent('')->setStatusCode(204);
122			}
123
124			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...
125			'block' => $blockContext->getBlock(),
126			'settings' => $blockContext->getSettings(),
127			'admin_pool' => $this->pool,
128			'pager' => $pager,
129			'admin' => $admin,
130			], $response);
131			}
132
133			public function getName()
134			{
135			return 'Admin Search Result';
136			}
137
138			public function configureSettings(OptionsResolver $resolver): void
139			{
140			$resolver
141			->setDefaults([
142			'admin_code' => '',
143			'query' => '',
144			'page' => 0,
145			'per_page' => 10,
146			'icon' => '<i class="fa fa-list"></i>',
147			])
148			->setRequired('admin_code')
149			->setAllowedTypes('admin_code', ['string']);
150			}
151			}
152

sonata-project / SonataAdminBundle

Pull Request — 3.x (#6212)

AdminSearchBlockService::execute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like