TwigBulkActionGridRenderer::__construct() - Code Metrics - Inspection of "Change bulk action implementation and remove the n..." - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — bulk-action-no-bc-break ( fbd3c4 )

by Kamil

created 2017-11-07 09:07 UTC

TwigBulkActionGridRenderer::__construct() A

↳ Parent: TwigBulkActionGridRenderer

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	3

<?php

declare(strict_types=1);

namespace Sylius\Bundle\ResourceBundle\Grid\Renderer;

use Sylius\Bundle\ResourceBundle\Grid\Parser\OptionsParserInterface;
use Sylius\Component\Grid\Definition\Action;
use Sylius\Component\Grid\Renderer\BulkActionGridRendererInterface;
use Sylius\Component\Grid\View\GridViewInterface;

final class TwigBulkActionGridRenderer implements BulkActionGridRendererInterface
{
    /**
     * @var \Twig_Environment
     */
    private $twig;

    /**
     * @var OptionsParserInterface
     */
    private $optionsParser;

    /**
     * @var array
     */
    private $bulkActionTemplates;

    /**
     * @param \Twig_Environment $twig
     * @param OptionsParserInterface $optionsParser
     * @param array $bulkActionTemplates
     */
    public function __construct(
        \Twig_Environment $twig,
        OptionsParserInterface $optionsParser,
        array $bulkActionTemplates = []
    ) {
        $this->twig = $twig;
        $this->optionsParser = $optionsParser;
        $this->bulkActionTemplates = $bulkActionTemplates;
    }

    /**
     * {@inheritdoc}
     */
    public function renderBulkAction(GridViewInterface $gridView, Action $bulkAction, $data = null): string
    {
        $type = $bulkAction->getType();
        if (!isset($this->bulkActionTemplates[$type])) {
            throw new \InvalidArgumentException(sprintf('Missing template for bulk action type "%s".', $type));
        }

        $options = $this->optionsParser->parseOptions(
            $bulkAction->getOptions(),
            $gridView->getRequestConfiguration()->getRequest(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $data
        );

        return (string) $this->twig->render($this->bulkActionTemplates[$type], [
            'grid' => $gridView,
            'action' => $bulkAction,
            'data' => $data,
            'options' => $options,
        ]);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Sylius\Bundle\ResourceBundle\Grid\Renderer;
6
7			use Sylius\Bundle\ResourceBundle\Grid\Parser\OptionsParserInterface;
8			use Sylius\Component\Grid\Definition\Action;
9			use Sylius\Component\Grid\Renderer\BulkActionGridRendererInterface;
10			use Sylius\Component\Grid\View\GridViewInterface;
11
12			final class TwigBulkActionGridRenderer implements BulkActionGridRendererInterface
13			{
14			/**
15			* @var \Twig_Environment
16			*/
17			private $twig;
18
19			/**
20			* @var OptionsParserInterface
21			*/
22			private $optionsParser;
23
24			/**
25			* @var array
26			*/
27			private $bulkActionTemplates;
28
29			/**
30			* @param \Twig_Environment $twig
31			* @param OptionsParserInterface $optionsParser
32			* @param array $bulkActionTemplates
33			*/
34			public function __construct(
35			\Twig_Environment $twig,
36			OptionsParserInterface $optionsParser,
37			array $bulkActionTemplates = []
38			) {
39			$this->twig = $twig;
40			$this->optionsParser = $optionsParser;
41			$this->bulkActionTemplates = $bulkActionTemplates;
42			}
43
44			/**
45			* {@inheritdoc}
46			*/
47			public function renderBulkAction(GridViewInterface $gridView, Action $bulkAction, $data = null): string
48			{
49			$type = $bulkAction->getType();
50			if (!isset($this->bulkActionTemplates[$type])) {
51			throw new \InvalidArgumentException(sprintf('Missing template for bulk action type "%s".', $type));
52			}
53
54			$options = $this->optionsParser->parseOptions(
55			$bulkAction->getOptions(),
56			$gridView->getRequestConfiguration()->getRequest(),
			0 ignored issues – show Bug introduced 2016-11-22 13:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Component\Grid\View\GridViewInterface` as the method `getRequestConfiguration()` does only exist in the following implementations of said interface: `Sylius\Bundle\ResourceBu...d\View\ResourceGridView`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
57			$data
58			);
59
60			return (string) $this->twig->render($this->bulkActionTemplates[$type], [
61			'grid' => $gridView,
62			'action' => $bulkAction,
63			'data' => $data,
64			'options' => $options,
65			]);
66			}
67			}
68

pamil / Sylius

Push — bulk-action-no-bc-break ( fbd3c4 )

TwigBulkActionGridRenderer::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like