ActionCollection::render() - Code Metrics - Inspection of "V.1.0" - larriereguichet/AdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#90)

by Arnaud

created 2017-05-08 14:43 UTC

ActionCollection::render() A

↳ Parent: ActionCollection

Complexity

Conditions	2
Paths	2

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	0
cts	18
cp	0
rs	9.3142
c	0
b	0
f	0
cc	2
eloc	12
nc	2
nop	1
crap	6

<?php

namespace LAG\AdminBundle\Field\Field;

use LAG\AdminBundle\Field\AbstractField;
use LAG\AdminBundle\Field\EntityAwareInterface;
use LAG\AdminBundle\Field\TwigAwareInterface;
use LogicException;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Twig_Environment;

class ActionCollection extends AbstractField implements TwigAwareInterface, EntityAwareInterface
{
    /**
     * @var Twig_Environment
     */
    protected $twig;
    
    /**
     * @var mixed
     */
    protected $entity;
    
    /**
     * Render value of the field.
     *
     * @param mixed $value Value to render
     *
     * @return mixed
     */
    public function render($value)
    {
        $actions = $this
            ->options
            ->get('actions')
        ;
        $normalizedActions = [];
        
        foreach ($actions as $action => $options) {
            $this->normalizeRoute($options, $action);
            $normalizedActions[$action] = $options;
        }
        
        
        return $this
            ->twig
            ->render('@LAGAdmin/Field/actionCollection.html.twig', [
                'actions' => $normalizedActions,
            ])
        ;
    }
    
    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver
            ->setRequired('actions')
            ->setAllowedTypes('actions', 'array')
            ->setNormalizer('actions', function (Options $options, $actions) {
    
                $normalizedActions = [];
                
                foreach ($actions as $action => $options) {
                    $this->normalizeIcon($options, $action);
                    $this->normalizeClass($options, $action);
                    $this->normalizeText($options, $action);
                    
                    $normalizedActions[$action] = $options;
                }
    
                return $normalizedActions;
            })
        ;
    }
    
    /**
     * Return field type.
     *
     * @return string
     */
    public function getType()
    {
        return AbstractField::TYPE_ACTION_COLLECTION;
    }
    
    /**
     * Defines entity for field.
     *
     * @param $entity
     *
     * @return void
     */
    public function setEntity($entity)
    {
        $this->entity = $entity;
    }
    
    /**
     * Define twig environment.
     *
     * @param Twig_Environment $twig
     *
     * @return void
     */
    public function setTwig(Twig_Environment $twig)
    {
        $this->twig = $twig;
    }
    
    protected function normalizeIcon(array &$options, $action)
    {
        $iconMapping = [
            'delete' => 'fa fa-times',
            'edit' => 'fa fa-pencil',
        ];
    
        if (!array_key_exists('icon', $options)) {
            $options['icon'] = '';
        
            if (array_key_exists($action, $iconMapping)) {
                $options['icon'] = $iconMapping[$action];
            }
        }
    }
    
    protected function normalizeClass(array &$options, $action)
    {
        $classMapping = [
            'delete' => 'btn btn-danger',
            'edit' => 'btn btn-default',
        ];
    
        if (!array_key_exists('class', $options)) {
            $options['class'] = '';
        
            if (array_key_exists($action, $classMapping)) {
                $options['class'] = $classMapping[$action];
            }
        }
        $normalizedActions[$action] = $options;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
    }
    
    protected function normalizeRoute(array &$options, $action)
    {
        if (!array_key_exists('route', $options)) {
            throw new LogicException(
                'You should provide a route for the Action "'.$action.'" in ActionCollection Field'
            );
        }
    
        if (array_key_exists('parameters', $options)) {
    
            if (!is_array($options['parameters'])) {
                throw new LogicException(
                    'You should provide an array of parameters for route configuration in action "'.$action.'"'
                );
            }
            $accessor = PropertyAccess::createPropertyAccessor();
            $normalizedParameters = [];
            
            foreach ($options['parameters'] as $parameter => $parameterOptions) {
                $normalizedParameters[$parameter] = $accessor->getValue($this->entity, $parameter);
            }
            $options['parameters'] = $normalizedParameters;
        }
    }
    
    protected function normalizeText(array &$options, $action)
    {
        if (!array_key_exists('text', $options)) {
            $options['text'] = ucfirst($action);
        }
    }
}


1			<?php
2
3			namespace LAG\AdminBundle\Field\Field;
4
5			use LAG\AdminBundle\Field\AbstractField;
6			use LAG\AdminBundle\Field\EntityAwareInterface;
7			use LAG\AdminBundle\Field\TwigAwareInterface;
8			use LogicException;
9			use Symfony\Component\OptionsResolver\Options;
10			use Symfony\Component\OptionsResolver\OptionsResolver;
11			use Symfony\Component\PropertyAccess\PropertyAccess;
12			use Twig_Environment;
13
14			class ActionCollection extends AbstractField implements TwigAwareInterface, EntityAwareInterface
15			{
16			/**
17			* @var Twig_Environment
18			*/
19			protected $twig;
20
21			/**
22			* @var mixed
23			*/
24			protected $entity;
25
26			/**
27			* Render value of the field.
28			*
29			* @param mixed $value Value to render
30			*
31			* @return mixed
32			*/
33			public function render($value)
34			{
35			$actions = $this
36			->options
37			->get('actions')
38			;
39			$normalizedActions = [];
40
41			foreach ($actions as $action => $options) {
42			$this->normalizeRoute($options, $action);
43			$normalizedActions[$action] = $options;
44			}
45
46
47			return $this
48			->twig
49			->render('@LAGAdmin/Field/actionCollection.html.twig', [
50			'actions' => $normalizedActions,
51			])
52			;
53			}
54
55			public function configureOptions(OptionsResolver $resolver)
56			{
57			$resolver
58			->setRequired('actions')
59			->setAllowedTypes('actions', 'array')
60			->setNormalizer('actions', function (Options $options, $actions) {
61
62			$normalizedActions = [];
63
64			foreach ($actions as $action => $options) {
65			$this->normalizeIcon($options, $action);
66			$this->normalizeClass($options, $action);
67			$this->normalizeText($options, $action);
68
69			$normalizedActions[$action] = $options;
70			}
71
72			return $normalizedActions;
73			})
74			;
75			}
76
77			/**
78			* Return field type.
79			*
80			* @return string
81			*/
82			public function getType()
83			{
84			return AbstractField::TYPE_ACTION_COLLECTION;
85			}
86
87			/**
88			* Defines entity for field.
89			*
90			* @param $entity
91			*
92			* @return void
93			*/
94			public function setEntity($entity)
95			{
96			$this->entity = $entity;
97			}
98
99			/**
100			* Define twig environment.
101			*
102			* @param Twig_Environment $twig
103			*
104			* @return void
105			*/
106			public function setTwig(Twig_Environment $twig)
107			{
108			$this->twig = $twig;
109			}
110
111			protected function normalizeIcon(array &$options, $action)
112			{
113			$iconMapping = [
114			'delete' => 'fa fa-times',
115			'edit' => 'fa fa-pencil',
116			];
117
118			if (!array_key_exists('icon', $options)) {
119			$options['icon'] = '';
120
121			if (array_key_exists($action, $iconMapping)) {
122			$options['icon'] = $iconMapping[$action];
123			}
124			}
125			}
126
127			protected function normalizeClass(array &$options, $action)
128			{
129			$classMapping = [
130			'delete' => 'btn btn-danger',
131			'edit' => 'btn btn-default',
132			];
133
134			if (!array_key_exists('class', $options)) {
135			$options['class'] = '';
136
137			if (array_key_exists($action, $classMapping)) {
138			$options['class'] = $classMapping[$action];
139			}
140			}
141			$normalizedActions[$action] = $options;
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-05-07 23:01 UTC by Report Bug Copy Issue Report `$normalizedActions` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$normalizedActions = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
142			}
143
144			protected function normalizeRoute(array &$options, $action)
145			{
146			if (!array_key_exists('route', $options)) {
147			throw new LogicException(
148			'You should provide a route for the Action "'.$action.'" in ActionCollection Field'
149			);
150			}
151
152			if (array_key_exists('parameters', $options)) {
153
154			if (!is_array($options['parameters'])) {
155			throw new LogicException(
156			'You should provide an array of parameters for route configuration in action "'.$action.'"'
157			);
158			}
159			$accessor = PropertyAccess::createPropertyAccessor();
160			$normalizedParameters = [];
161
162			foreach ($options['parameters'] as $parameter => $parameterOptions) {
163			$normalizedParameters[$parameter] = $accessor->getValue($this->entity, $parameter);
164			}
165			$options['parameters'] = $normalizedParameters;
166			}
167			}
168
169			protected function normalizeText(array &$options, $action)
170			{
171			if (!array_key_exists('text', $options)) {
172			$options['text'] = ucfirst($action);
173			}
174			}
175			}
176

larriereguichet / AdminBundle

Pull Request — master (#90)

ActionCollection::render() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like