ExtraConfigurationSubscriber::__construct() - Code Metrics - Inspection of "Fix CI configuration" - larriereguichet/AdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — dev (a083dd)

by Arnaud

created 2016-02-18 18:12 UTC

ExtraConfigurationSubscriber::__construct() A

↳ Parent: ExtraConfigurationSubscriber

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	3
Bugs	1	Features	1

Metric	Value
c	3
b	1
f	1
dl	0
loc	10
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	7
nc	1
nop	3
crap	1

<?php

namespace LAG\AdminBundle\Event\Subscriber;

use Doctrine\Common\Persistence\Mapping\MappingException;
use Doctrine\ORM\EntityManager;
use LAG\AdminBundle\Admin\Configuration\ApplicationConfiguration;
use LAG\AdminBundle\Event\AdminEvent;
use LAG\AdminBundle\Utils\FieldTypeGuesser;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Add extra default configuration for actions and fields. Bind to ADMIN_CREATE and ACTION_CREATE events
 */
class ExtraConfigurationSubscriber implements EventSubscriberInterface
{
    /**
     * @var bool
     */
    protected $enableExtraConfiguration;

    /**
     * @var EntityManager
     */
    protected $entityManager;

    /**
     * @var ApplicationConfiguration
     */
    protected $applicationConfiguration;

    /**
     * @return array
     */
    public static function getSubscribedEvents()
    {
        return [
            AdminEvent::ADMIN_CREATE => 'adminCreate',
            AdminEvent::ACTION_CREATE => 'actionCreate',
        ];
    }

    /**
     * ExtraConfigurationSubscriber constructor
     *
     * @param bool $enableExtraConfiguration
     * @param EntityManager $entityManager
     * @param ApplicationConfiguration $applicationConfiguration
     */
    public function __construct(
        $enableExtraConfiguration = true,
        EntityManager $entityManager,
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
        ApplicationConfiguration $applicationConfiguration
    )
    {
        $this->enableExtraConfiguration = $enableExtraConfiguration;
        $this->entityManager = $entityManager;
        $this->applicationConfiguration = $applicationConfiguration;
    }

    /**
     * Adding default CRUD if none is defined
     *
     * @param AdminEvent $event
     */
    public function adminCreate(AdminEvent $event)
    {
        if (!$this->enableExtraConfiguration) {
            return;
        }
        $configuration = $event->getConfiguration();

        // if no actions are defined, we set default CRUD action
        if (!array_key_exists('actions', $configuration) || !count($configuration['actions'])) {
            $configuration['actions'] = [
                'create' => [],
                'list' => [],
                'edit' => [],
                'delete' => [],
                'batch' => []
            ];
        } else {
            $actions = $configuration['actions'];

            foreach ($actions as $name => $action) {
                if (!array_key_exists('batch', $action) || $action['batch'] !== false) {
                    if ($name == 'list') {
                        $configuration['actions']['batch'] = [];
                    }
                }
            }
        }
        $event->setConfiguration($configuration);
    }

    /**
     * Add default linked actions and default menu actions
     *
     * @param AdminEvent $event
     * @throws MappingException
     */
    public function actionCreate(AdminEvent $event)
    {
        // add configuration only if extra configuration is enabled
        if (!$this->enableExtraConfiguration) {
            return;
        }
        // action configuration array
        $configuration = $event->getConfiguration();
        // current action admin
        $admin = $event->getAdmin();
        // allowed actions according to the admin
        $keys = $admin
            ->getConfiguration()
            ->getActions();
        $allowedActions = array_keys($keys);

        // if no field was provided in configuration, we try to take fields from doctrine metadata
        if (empty($configuration['fields']) || !count($configuration['fields'])) {
            $fields = [];
            $guesser = new FieldTypeGuesser();
            $metadata = $this
                ->entityManager
                ->getMetadataFactory()
                ->getMetadataFor($admin->getConfiguration()->getEntityName());
            $fieldsName = $metadata->getFieldNames();

            foreach ($fieldsName as $name) {
                $type = $metadata->getTypeOfField($name);
                // get field type from doctrine type
                $fieldConfiguration = $guesser->getTypeAndOptions($type);

                // if a field configuration was found, we take it
                if (count($fieldConfiguration)) {
                    $fields[$name] = $fieldConfiguration;
                }
            }
            if (count($fields)) {
                // adding new fields to action configuration
                $configuration['fields'] = $fields;
            }
        }
        // configured linked actions
        if (array_key_exists('_actions', $configuration['fields'])
            && !array_key_exists('type', $configuration['fields']['_actions'])
        ) {
            // in list view, we add by default and an edit and a delete button
            if ($event->getActionName() == 'list') {
                if (in_array('edit', $allowedActions)) {
                    $configuration['fields']['_actions']['type'] = 'collection';
                    $configuration['fields']['_actions']['options']['_edit'] = [
                        'type' => 'action',
                        'options' => [
                            'title' => $this->applicationConfiguration->getTranslationKey('edit', $event->getAdmin()->getName()),
                            'route' => $admin->generateRouteName('edit'),
                            'parameters' => [
                                'id' => false
                            ],
                            'icon' => 'pencil'
                        ]
                    ];
                }
                if (in_array('delete', $allowedActions)) {
                    $configuration['fields']['_actions']['type'] = 'collection';
                    $configuration['fields']['_actions']['options']['_delete'] = [
                        'type' => 'action',
                        'options' => [
                            'title' => $this->applicationConfiguration->getTranslationKey('delete', $event->getAdmin()->getName()),
                            'route' => $admin->generateRouteName('delete'),
                            'parameters' => [
                                'id' => false
                            ],
                            'icon' => 'remove'
                        ]
                    ];
                }
            }
        }
        // add default menu actions if none was provided
        if (empty($configuration['actions'])) {
            // by default, in list action we add a create linked action
            if ($event->getActionName() == 'list') {
                if (in_array('create', $allowedActions)) {
                    $configuration['actions']['create'] = [
                        'title' => $this->applicationConfiguration->getTranslationKey('create', $event->getAdmin()->getName()),
                        'route' => $admin->generateRouteName('create'),
                        'icon' => 'pencil'
                    ];
                }
            }
        }
        // for list action, add the delete batch action by defaut
        if (empty($configuration['batch'])) {
            if ($event->getActionName() == 'list') {
                $configuration['batch'] = [
                    'delete' => null
                ];
            }
        }
        // reset action configuration
        $event->setConfiguration($configuration);
    }
}


1			<?php
2
3			namespace LAG\AdminBundle\Event\Subscriber;
4
5			use Doctrine\Common\Persistence\Mapping\MappingException;
6			use Doctrine\ORM\EntityManager;
7			use LAG\AdminBundle\Admin\Configuration\ApplicationConfiguration;
8			use LAG\AdminBundle\Event\AdminEvent;
9			use LAG\AdminBundle\Utils\FieldTypeGuesser;
10			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
11
12			/**
13			* Add extra default configuration for actions and fields. Bind to ADMIN_CREATE and ACTION_CREATE events
14			*/
15			class ExtraConfigurationSubscriber implements EventSubscriberInterface
16			{
17			/**
18			* @var bool
19			*/
20			protected $enableExtraConfiguration;
21
22			/**
23			* @var EntityManager
24			*/
25			protected $entityManager;
26
27			/**
28			* @var ApplicationConfiguration
29			*/
30			protected $applicationConfiguration;
31
32			/**
33			* @return array
34			*/
35	1		public static function getSubscribedEvents()
36			{
37			return [
38	1		AdminEvent::ADMIN_CREATE => 'adminCreate',
39			AdminEvent::ACTION_CREATE => 'actionCreate',
40			];
41			}
42
43			/**
44			* ExtraConfigurationSubscriber constructor
45			*
46			* @param bool $enableExtraConfiguration
47			* @param EntityManager $entityManager
48			* @param ApplicationConfiguration $applicationConfiguration
49			*/
50	1		public function __construct(
51			$enableExtraConfiguration = true,
52			EntityManager $entityManager,
			0 ignored issues – show Bug introduced 2016-01-30 13:16 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$entityManager`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
53			ApplicationConfiguration $applicationConfiguration
54			)
55			{
56	1		$this->enableExtraConfiguration = $enableExtraConfiguration;
57	1		$this->entityManager = $entityManager;
58	1		$this->applicationConfiguration = $applicationConfiguration;
59	1		}
60
61			/**
62			* Adding default CRUD if none is defined
63			*
64			* @param AdminEvent $event
65			*/
66	1		public function adminCreate(AdminEvent $event)
67			{
68	1		if (!$this->enableExtraConfiguration) {
69	1		return;
70			}
71	1		$configuration = $event->getConfiguration();
72
73			// if no actions are defined, we set default CRUD action
74	1		if (!array_key_exists('actions', $configuration) \|\| !count($configuration['actions'])) {
75	1		$configuration['actions'] = [
76	1		'create' => [],
77			'list' => [],
78			'edit' => [],
79			'delete' => [],
80			'batch' => []
81			];
82			} else {
83	1		$actions = $configuration['actions'];
84
85	1		foreach ($actions as $name => $action) {
86	1		if (!array_key_exists('batch', $action) \|\| $action['batch'] !== false) {
87	1		if ($name == 'list') {
88	1		$configuration['actions']['batch'] = [];
89			}
90			}
91			}
92			}
93	1		$event->setConfiguration($configuration);
94	1		}
95
96			/**
97			* Add default linked actions and default menu actions
98			*
99			* @param AdminEvent $event
100			* @throws MappingException
101			*/
102			public function actionCreate(AdminEvent $event)
103			{
104			// add configuration only if extra configuration is enabled
105			if (!$this->enableExtraConfiguration) {
106			return;
107			}
108			// action configuration array
109			$configuration = $event->getConfiguration();
110			// current action admin
111			$admin = $event->getAdmin();
112			// allowed actions according to the admin
113			$keys = $admin
114			->getConfiguration()
115			->getActions();
116			$allowedActions = array_keys($keys);
117
118			// if no field was provided in configuration, we try to take fields from doctrine metadata
119			if (empty($configuration['fields']) \|\| !count($configuration['fields'])) {
120			$fields = [];
121			$guesser = new FieldTypeGuesser();
122			$metadata = $this
123			->entityManager
124			->getMetadataFactory()
125			->getMetadataFor($admin->getConfiguration()->getEntityName());
126			$fieldsName = $metadata->getFieldNames();
127
128			foreach ($fieldsName as $name) {
129			$type = $metadata->getTypeOfField($name);
130			// get field type from doctrine type
131			$fieldConfiguration = $guesser->getTypeAndOptions($type);
132
133			// if a field configuration was found, we take it
134			if (count($fieldConfiguration)) {
135			$fields[$name] = $fieldConfiguration;
136			}
137			}
138			if (count($fields)) {
139			// adding new fields to action configuration
140			$configuration['fields'] = $fields;
141			}
142			}
143			// configured linked actions
144			if (array_key_exists('_actions', $configuration['fields'])
145			&& !array_key_exists('type', $configuration['fields']['_actions'])
146			) {
147			// in list view, we add by default and an edit and a delete button
148			if ($event->getActionName() == 'list') {
149		View Code Duplication	if (in_array('edit', $allowedActions)) {
150			$configuration['fields']['_actions']['type'] = 'collection';
151			$configuration['fields']['_actions']['options']['_edit'] = [
152			'type' => 'action',
153			'options' => [
154			'title' => $this->applicationConfiguration->getTranslationKey('edit', $event->getAdmin()->getName()),
155			'route' => $admin->generateRouteName('edit'),
156			'parameters' => [
157			'id' => false
158			],
159			'icon' => 'pencil'
160			]
161			];
162			}
163		View Code Duplication	if (in_array('delete', $allowedActions)) {
164			$configuration['fields']['_actions']['type'] = 'collection';
165			$configuration['fields']['_actions']['options']['_delete'] = [
166			'type' => 'action',
167			'options' => [
168			'title' => $this->applicationConfiguration->getTranslationKey('delete', $event->getAdmin()->getName()),
169			'route' => $admin->generateRouteName('delete'),
170			'parameters' => [
171			'id' => false
172			],
173			'icon' => 'remove'
174			]
175			];
176			}
177			}
178			}
179			// add default menu actions if none was provided
180			if (empty($configuration['actions'])) {
181			// by default, in list action we add a create linked action
182			if ($event->getActionName() == 'list') {
183			if (in_array('create', $allowedActions)) {
184			$configuration['actions']['create'] = [
185			'title' => $this->applicationConfiguration->getTranslationKey('create', $event->getAdmin()->getName()),
186			'route' => $admin->generateRouteName('create'),
187			'icon' => 'pencil'
188			];
189			}
190			}
191			}
192			// for list action, add the delete batch action by defaut
193			if (empty($configuration['batch'])) {
194			if ($event->getActionName() == 'list') {
195			$configuration['batch'] = [
196			'delete' => null
197			];
198			}
199			}
200			// reset action configuration
201			$event->setConfiguration($configuration);
202			}
203			}
204

larriereguichet / AdminBundle

Branch — dev (a083dd)

ExtraConfigurationSubscriber::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like