TwigBulkActionGridRenderer::__construct() - Code Metrics - Inspection of "Merge pull request #8940 from pamil/bulk-action-no..." - Sylius/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 1.1-coding-standard-fixes ( 71011e...6e4dd7 )

by Kamil

created 2017-11-07 14:39 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

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

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
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.
    }
}
    {
        $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(),
            $data
        );

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


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace Sylius\Bundle\ResourceBundle\Grid\Renderer;
15
16			use Sylius\Bundle\ResourceBundle\Grid\Parser\OptionsParserInterface;
17			use Sylius\Component\Grid\Definition\Action;
18			use Sylius\Component\Grid\Renderer\BulkActionGridRendererInterface;
19			use Sylius\Component\Grid\View\GridViewInterface;
20
21			final class TwigBulkActionGridRenderer implements BulkActionGridRendererInterface
22			{
23			/**
24			* @var \Twig_Environment
25			*/
26			private $twig;
27
28			/**
29			* @var OptionsParserInterface
30			*/
31			private $optionsParser;
32
33			/**
34			* @var array
35			*/
36			private $bulkActionTemplates;
37
38			/**
39			* @param \Twig_Environment $twig
40			* @param OptionsParserInterface $optionsParser
41			* @param array $bulkActionTemplates
42			*/
43			public function __construct(
44			\Twig_Environment $twig,
45			OptionsParserInterface $optionsParser,
46			array $bulkActionTemplates = []
47			) {
48			$this->twig = $twig;
49			$this->optionsParser = $optionsParser;
50			$this->bulkActionTemplates = $bulkActionTemplates;
51			}
52
53			/**
54			* {@inheritdoc}
55			*/
56			public function renderBulkAction(GridViewInterface $gridView, Action $bulkAction, $data = null): string
			0 ignored issues – show Bug introduced 2017-10-23 13:22 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			{
58			$type = $bulkAction->getType();
59			if (!isset($this->bulkActionTemplates[$type])) {
60			throw new \InvalidArgumentException(sprintf('Missing template for bulk action type "%s".', $type));
61			}
62
63			$options = $this->optionsParser->parseOptions(
64			$bulkAction->getOptions(),
65			$gridView->getRequestConfiguration()->getRequest(),
66			$data
67			);
68
69			return (string) $this->twig->render($this->bulkActionTemplates[$type], [
70			'grid' => $gridView,
71			'action' => $bulkAction,
72			'data' => $data,
73			'options' => $options,
74			]);
75			}
76			}
77

Sylius / Sylius

Push — 1.1-coding-standard-fixes ( 71011e...6e4dd7 )

TwigBulkActionGridRenderer::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like