AuditBlockService::__construct() - Code Metrics - Inspection of "Prepare support for BlockBundle 4" - sonata-project/SonataDoctrineORMAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.x (#1067)

by Vincent

created 2020-07-12 09:55 UTC

AuditBlockService::__construct() B

↳ Parent: AuditBlockService

Complexity

Conditions	7
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	50
rs	8.1575
c	0
b	0
f	0
cc	7
nc	5
nop	3

<?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\DoctrineORMAdminBundle\Block;

use SimpleThings\EntityAudit\AuditReader;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\BlockBundle\Block\BlockContextInterface;
use Sonata\BlockBundle\Block\Service\AbstractBlockService;
use Sonata\BlockBundle\Model\BlockInterface;
use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Twig\Environment;

/**
 * @author Thomas Rabaix <[email protected]>
 */
class AuditBlockService extends AbstractBlockService
{
    /**
     * @var AuditReader
     */
    protected $auditReader;

    /**
     * NEXT_MAJOR: Allow only Environment|EngineInterface for argument 1 and AuditReader for argument 2.
     *
     * @param Environment|EngineInterface|string $templatingOrDeprecatedName
     * @param EngineInterface|AuditReader        $templatingOrAuditReader
     */
    public function __construct($templatingOrDeprecatedName, object $templatingOrAuditReader, ?AuditReader $auditReader = null)
    {
        if ($templatingOrAuditReader 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 an instance of %s instead.',
                EngineInterface::class,
                __METHOD__,
                AuditReader::class
            ), E_USER_DEPRECATED);

            if (null === $auditReader) {
                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,
                    AuditReader::class
                ));
            }

            parent::__construct($templatingOrDeprecatedName, $templatingOrAuditReader);

            $this->auditReader = $auditReader;
        } elseif ($templatingOrAuditReader instanceof AuditReader) {
            if (!$templatingOrDeprecatedName instanceof Environment
                && !$templatingOrDeprecatedName instanceof EngineInterface
            ) {
                throw new \TypeError(sprintf(

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

            parent::__construct($templatingOrDeprecatedName);

            $this->auditReader = $templatingOrAuditReader;
        } else {
            throw new \TypeError(sprintf(

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

    public function execute(BlockContextInterface $blockContext, ?Response $response = null)
    {
        $revisions = [];

        foreach ($this->auditReader->findRevisionHistory($blockContext->getSetting('limit'), 0) as $revision) {
            $revisions[] = [
                'revision' => $revision,
                'entities' => $this->auditReader->findEntitiesChangedAtRevision($revision->getRev()),
            ];
        }

        return $this->renderResponse($blockContext->getTemplate(), [
            'block' => $blockContext->getBlock(),
            'settings' => $blockContext->getSettings(),
            'revisions' => $revisions,
        ], $response);
    }

    public function buildEditForm(FormMapper $formMapper, BlockInterface $block)

    {
    }

    public function getName()
    {
        return 'Audit List';
    }

    public function configureSettings(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            'limit' => 10,
            'template' => '@SonataDoctrineORMAdmin/Block/block_audit.html.twig',
        ]);
    }
}


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\DoctrineORMAdminBundle\Block;
15
16			use SimpleThings\EntityAudit\AuditReader;
17			use Sonata\AdminBundle\Form\FormMapper;
18			use Sonata\BlockBundle\Block\BlockContextInterface;
19			use Sonata\BlockBundle\Block\Service\AbstractBlockService;
20			use Sonata\BlockBundle\Model\BlockInterface;
21			use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
22			use Symfony\Component\HttpFoundation\Response;
23			use Symfony\Component\OptionsResolver\OptionsResolver;
24			use Twig\Environment;
25
26			/**
27			* @author Thomas Rabaix <[email protected]>
28			*/
29			class AuditBlockService extends AbstractBlockService
30			{
31			/**
32			* @var AuditReader
33			*/
34			protected $auditReader;
35
36			/**
37			* NEXT_MAJOR: Allow only Environment\|EngineInterface for argument 1 and AuditReader for argument 2.
38			*
39			* @param Environment\|EngineInterface\|string $templatingOrDeprecatedName
40			* @param EngineInterface\|AuditReader $templatingOrAuditReader
41			*/
42			public function __construct($templatingOrDeprecatedName, object $templatingOrAuditReader, ?AuditReader $auditReader = null)
43			{
44			if ($templatingOrAuditReader instanceof EngineInterface) {
45			@trigger_error(sprintf(
			0 ignored issues – show Security Best Practice introduced 2020-07-11 21:22 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...
46			'Passing %s as argument 2 to %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.x'
47			.' and will throw a \TypeError in version 4.0. You must pass an instance of %s instead.',
48			EngineInterface::class,
49			__METHOD__,
50			AuditReader::class
51			), E_USER_DEPRECATED);
52
53			if (null === $auditReader) {
54			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-11 21:22 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Passing null as...dit\AuditReader::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...
55			'Passing null as argument 3 to %s() is not allowed when %s is passed as argument 2.'
56			.' You must pass an instance of %s instead.',
57			__METHOD__,
58			EngineInterface::class,
59			AuditReader::class
60			));
61			}
62
63			parent::__construct($templatingOrDeprecatedName, $templatingOrAuditReader);
64
65			$this->auditReader = $auditReader;
66			} elseif ($templatingOrAuditReader instanceof AuditReader) {
67			if (!$templatingOrDeprecatedName instanceof Environment
68			&& !$templatingOrDeprecatedName instanceof EngineInterface
69			) {
70			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-12 09:57 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 1 pass...atingOrDeprecatedName))`. 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...
71			'Argument 1 passed to %s() must be either an instance of %s or preferably %s, %s given.',
72			__METHOD__,
73			EngineInterface::class,
74			Environment::class,
75			\is_object($templatingOrDeprecatedName) ? \get_class($templatingOrDeprecatedName) : \gettype($templatingOrDeprecatedName)
76			));
77			}
78
79			parent::__construct($templatingOrDeprecatedName);
80
81			$this->auditReader = $templatingOrAuditReader;
82			} else {
83			throw new \TypeError(sprintf(
			0 ignored issues – show Unused Code introduced 2020-07-12 09:57 UTC by Report Bug Copy Issue Report The call to `TypeError::__construct()` has too many arguments starting with `sprintf('Argument 2 pass...mplatingOrAuditReader))`. 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...
84			'Argument 2 passed to %s() must be either an instance of %s or preferably %s, %s given.',
85			__METHOD__,
86			EngineInterface::class,
87			AuditReader::class,
88			\get_class($templatingOrAuditReader)
89			));
90			}
91			}
92
93			public function execute(BlockContextInterface $blockContext, ?Response $response = null)
94			{
95			$revisions = [];
96
97			foreach ($this->auditReader->findRevisionHistory($blockContext->getSetting('limit'), 0) as $revision) {
98			$revisions[] = [
99			'revision' => $revision,
100			'entities' => $this->auditReader->findEntitiesChangedAtRevision($revision->getRev()),
101			];
102			}
103
104			return $this->renderResponse($blockContext->getTemplate(), [
105			'block' => $blockContext->getBlock(),
106			'settings' => $blockContext->getSettings(),
107			'revisions' => $revisions,
108			], $response);
109			}
110
111			public function buildEditForm(FormMapper $formMapper, BlockInterface $block)
			0 ignored issues – show Unused Code introduced 2020-03-31 13:01 UTC by Report Bug Copy Issue Report The parameter `$formMapper` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2020-03-31 13:01 UTC by Report Bug Copy Issue Report The parameter `$block` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
112			{
113			}
114
115			public function getName()
116			{
117			return 'Audit List';
118			}
119
120			public function configureSettings(OptionsResolver $resolver)
121			{
122			$resolver->setDefaults([
123			'limit' => 10,
124			'template' => '@SonataDoctrineORMAdmin/Block/block_audit.html.twig',
125			]);
126			}
127			}
128

sonata-project / SonataDoctrineORMAdminBundle

Pull Request — 3.x (#1067)

AuditBlockService::__construct() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like