Admin::addAction() - Code Metrics - Inspection of "Merge pull request #61 from larriereguichet/featur..." - larriereguichet/AdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev ( df0c76...243dfc )

by Arnaud

created 2016-10-23 11:25 UTC

Admin::addAction() A

↳ Parent: Admin

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace LAG\AdminBundle\Admin;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\EntityManagerInterface;
use LAG\AdminBundle\Action\ActionInterface;
use LAG\AdminBundle\Admin\Behaviors\AdminTrait;
use LAG\AdminBundle\Admin\Configuration\AdminConfiguration;
use Doctrine\Common\Collections\ArrayCollection;
use Exception;
use LAG\AdminBundle\DataProvider\DataProviderInterface;
use LAG\AdminBundle\Exception\AdminException;
use LAG\AdminBundle\Filter\RequestFilterInterface;
use LAG\AdminBundle\Message\MessageHandlerInterface;
use LAG\AdminBundle\Pager\PagerFantaAdminAdapter;
use Pagerfanta\Pagerfanta;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\User\UserInterface;

class Admin implements AdminInterface
{
    use AdminTrait;

    /**
     * Entities collection.
     *
     * @var ArrayCollection
     */
    protected $entities;

    /**
     * @var MessageHandlerInterface
     */
    protected $messageHandler;

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

    /**
     * @var DataProviderInterface
     */
    protected $dataProvider;

    /**
     * Admin configuration object
     *
     * @var AdminConfiguration
     */
    protected $configuration;

    /**
     * Admin configured actions
     *
     * @var ActionInterface[]
     */
    protected $actions = [];

    /**
     * Admin current action. It will be set after calling the handleRequest()
     *
     * @var ActionInterface
     */
    protected $currentAction;

    /**
     * Admin name
     *
     * @var string
     */
    protected $name;

    /**
     * @var EventDispatcherInterface
     */
    protected $eventDispatcher;

    /**
     * @var RequestFilterInterface
     */
    protected $requestFilter;

    /**
     * Admin constructor.
     *
     * @param string $name
     * @param DataProviderInterface $dataProvider
     * @param AdminConfiguration $configuration
     * @param MessageHandlerInterface $messageHandler
     * @param EventDispatcherInterface $eventDispatcher
     * @param RequestFilterInterface $requestFilter
     */
    public function __construct(
        $name,
        DataProviderInterface $dataProvider,
        AdminConfiguration $configuration,
        MessageHandlerInterface $messageHandler,
        EventDispatcherInterface $eventDispatcher,
        RequestFilterInterface $requestFilter
    ) {
        $this->name = $name;
        $this->dataProvider = $dataProvider;
        $this->configuration = $configuration;
        $this->messageHandler = $messageHandler;
        $this->eventDispatcher = $eventDispatcher;
        $this->entities = new ArrayCollection();
        $this->requestFilter = $requestFilter;
    }

    /**
     * Load entities and set current action according to request.
     *
     * @param Request $request
     * @param null $user
     * @return void
     * @throws AdminException
     */
    public function handleRequest(Request $request, $user = null)
    {
        // set current action
        $this->currentAction = $this->getAction($request->get('_route_params')['_action']);

        // check if user is logged have required permissions to get current action
        $this->checkPermissions($user);

        $actionConfiguration = $this
            ->currentAction
            ->getConfiguration();

        // configure the request filter with the action and admin configured parameters
        $this
            ->requestFilter
            ->configure(
                $actionConfiguration->getParameter('criteria'),
                $actionConfiguration->getParameter('order'),
                $this->configuration->getParameter('max_per_page')
            );

        // filter the request with the configured criteria, order and max_per_page parameter
        $this
            ->requestFilter
            ->filter($request);

        // load entities according to action and request
        $this->load(
            $this->requestFilter->getCriteria(),
            $this->requestFilter->getOrder(),
            $this->requestFilter->getMaxPerPage(),
            $this->requestFilter->getCurrentPage()
        );
    }

    /**
     * Check if user is allowed to be here
     *
     * @param UserInterface|string $user
     * @throws Exception
     */
    public function checkPermissions($user)
    {
        if (!($user instanceof UserInterface)) {
            return;
        }
        if ($this->currentAction === null) {
            throw new Exception('Current action should be set before checking the permissions');
        }
        $roles = $user->getRoles();
        $actionName = $this
            ->getCurrentAction()
            ->getName();

        if (!$this->isActionGranted($actionName, $roles)) {
            $rolesStringArray = [];

            foreach ($roles as $role) {

                if ($role instanceof Role) {
                    $rolesStringArray[] = $role->getRole();
                } else {
                    $rolesStringArray[] = $role;
                }
            }

            $message = sprintf('User with roles %s not allowed for action "%s"',
                implode(', ', $rolesStringArray),
                $actionName
            );
            throw new NotFoundHttpException($message);
        }
    }

    /**
     * Create and return a new entity.
     *
     * @return object
     */
    public function create()
    {
        // create an entity from the data provider
        $entity = $this
            ->dataProvider
            ->create();

        // add it to the collection
        $this
            ->entities
            ->add($entity);

        return $entity;
    }

    /**
     * Save entity via admin manager. Error are catch, logged and a flash message is added to session
     *
     * @return bool true if the entity was saved without errors
     */
    public function save()
    {
        try {
            foreach ($this->entities as $entity) {
                $this
                    ->dataProvider
                    ->save($entity);
            }
            // inform the user that the entity is saved
            $this
                ->messageHandler
                ->handleSuccess($this->generateMessageTranslationKey('saved'));
            $success = true;
        } catch (Exception $e) {
            $this
                ->messageHandler
                ->handleError(
                    $this->generateMessageTranslationKey('lag.admin.saved_errors'),
                    "An error has occurred while saving an entity : {$e->getMessage()}, stackTrace: {$e->getTraceAsString()}"
                );
            $success = false;
        }
        return $success;
    }

    /**
     * Remove an entity with data provider
     *
     * @return bool true if the entity was saved without errors
     */
    public function remove()
    {
        try {
            foreach ($this->entities as $entity) {
                $this
                    ->dataProvider
                    ->remove($entity);
            }
            // inform the user that the entity is removed
            $this
                ->messageHandler
                ->handleSuccess($this->generateMessageTranslationKey('deleted'));
            $success = true;
        } catch (Exception $e) {
            $this
                ->messageHandler
                ->handleError(
                    $this->generateMessageTranslationKey('lag.admin.deleted_errors'),
                    "An error has occurred while deleting an entity : {$e->getMessage()}, stackTrace: {$e->getTraceAsString()} "
                );
            $success = false;
        }
        return $success;
    }

    /**
     * Generate a route for admin and action name (like lag.admin.my_admin)
     *
     * @param $actionName
     *
     * @return string
     *
     * @throws Exception
     */
    public function generateRouteName($actionName)
    {
        if (!array_key_exists($actionName, $this->getConfiguration()->getParameter('actions'))) {
            throw new Exception(
                sprintf('Invalid action name %s for admin %s (available action are: %s)',
                    $actionName,
                    $this->getName(),
                    implode(', ', $this->getActionNames()))
            );
        }
        // get routing name pattern
        $routingPattern = $this->getConfiguration()->getParameter('routing_name_pattern');
        // replace admin and action name in pattern
        $routeName = str_replace('{admin}', Container::underscore($this->getName()), $routingPattern);
        $routeName = str_replace('{action}', $actionName, $routeName);

        return $routeName;
    }

    /**
     * Load entities manually according to criteria.
     *
     * @param array $criteria
     * @param array $orderBy
     * @param int $limit
     * @param int $offset
     * @throws Exception
     */
    public function load(array $criteria, $orderBy = [], $limit = 25, $offset = 1)
    {
        $actionConfiguration = $this
            ->getCurrentAction()
            ->getConfiguration();
        $pager = $actionConfiguration->getParameter('pager');
        $requirePagination = $this
            ->getCurrentAction()
            ->isPaginationRequired();

        if ($pager == 'pagerfanta' && $requirePagination) {
            // adapter to pagerfanta
            $adapter = new PagerFantaAdminAdapter($this->dataProvider, $criteria, $orderBy);
            // create pager
            $this->pager = new Pagerfanta($adapter);
            $this->pager->setMaxPerPage($limit);
            $this->pager->setCurrentPage($offset);

            $entities = $this
                ->pager
                ->getCurrentPageResults();
        } else {
            // if the current action should retrieve only one entity, the offset should be zero
            if ($actionConfiguration->getParameter('load_strategy') !== AdminInterface::LOAD_STRATEGY_MULTIPLE) {
                $offset = 0;
            }
            $entities = $this
                ->dataProvider
                ->findBy($criteria, $orderBy, $limit, $offset);
        }
        if (!is_array($entities) && !($entities instanceof Collection)) {
            throw new Exception('The data provider should return either a collection or an array. Got '.gettype($entities).' instead');
        }

        if (is_array($entities)) {
            $entities = new ArrayCollection($entities);
        }
        $this->entities = $entities;
    }

    /**
     * Return loaded entities
     *
     * @return Collection
     */
    public function getEntities()
    {
        return $this->entities;
    }

    /**
     * Return entity for current admin. If entity does not exist, it throws an exception.
     *
     * @return mixed
     *
     * @throws Exception
     */
    public function getUniqueEntity()
    {
        if ($this->entities->count() == 0) {
            throw new Exception("Entity not found in admin \"{$this->getName()}\".");
        }
        if ($this->entities->count() > 1) {
            throw new Exception("Too much entities found in admin \"{$this->getName()}\".");
        }
        return $this->entities->first();
    }

    /**
     * Return admin name
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Return true if current action is granted for user.
     *
     * @param string $actionName Le plus grand de tous les héros
     * @param array $roles
     *
     * @return bool
     */
    public function isActionGranted($actionName, array $roles)
    {
        $isGranted = array_key_exists($actionName, $this->actions);

        // if action exists
        if ($isGranted) {
            $isGranted = false;
            /** @var ActionInterface $action */
            $action = $this->actions[$actionName];
            // checking roles permissions
            foreach ($roles as $role) {

                if ($role instanceof Role) {
                    $role = $role->getRole();
                }
                if (in_array($role, $action->getPermissions())) {
                    $isGranted = true;
                }
            }
        }

        return $isGranted;
    }

    /**
     * @return ActionInterface[]
     */
    public function getActions()
    {
        return $this->actions;
    }

    /**
     * @return integer[]
     */
    public function getActionNames()
    {
        return array_keys($this->actions);
    }

    /**
     * @param $name
     * @return ActionInterface
     * @throws Exception
     */
    public function getAction($name)
    {
        if (!array_key_exists($name, $this->getActions())) {
            throw new Exception(
                "Invalid action name \"{$name}\" for admin '{$this->getName()}'. Check your configuration"
            );
        }

        return $this->actions[$name];
    }

    /**
     * Return if an action with specified name exists form this admin.
     *
     * @param $name
     * @return bool
     */
    public function hasAction($name)
    {
        return array_key_exists($name, $this->actions);
    }

    /**
     * @param ActionInterface $action
     * @return void
     */
    public function addAction(ActionInterface $action)
    {
        $this->actions[$action->getName()] = $action;
    }

    /**
     * Return the current action or an exception if it is not set.
     *
     * @return ActionInterface
     * @throws Exception
     */
    public function getCurrentAction()
    {
        if ($this->currentAction === null) {
            // current action should be defined
            throw new Exception(
                'Current action is null. You should initialize it (with handleRequest method for example)'
            );
        }

        return $this->currentAction;
    }

    /**
     * Return if the current action has been initialized and set.
     *
     * @return boolean
     */
    public function isCurrentActionDefined()
    {
        return ($this->currentAction instanceof ActionInterface);
    }

    /**
     * Return admin configuration object.
     *
     * @return AdminConfiguration
     */
    public function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * Return a translation key for a message according to the Admin's translation pattern.
     *
     * @param string $message
     * @return string
     */
    protected function generateMessageTranslationKey($message)
    {
        return $this->getTranslationKey(
            $this->configuration->getParameter('translation_pattern'),
            $message,
            $this->name
        );
    }
}


1			<?php
2
3			namespace LAG\AdminBundle\Admin;
4
5			use Doctrine\Common\Collections\Collection;
6			use Doctrine\ORM\EntityManagerInterface;
7			use LAG\AdminBundle\Action\ActionInterface;
8			use LAG\AdminBundle\Admin\Behaviors\AdminTrait;
9			use LAG\AdminBundle\Admin\Configuration\AdminConfiguration;
10			use Doctrine\Common\Collections\ArrayCollection;
11			use Exception;
12			use LAG\AdminBundle\DataProvider\DataProviderInterface;
13			use LAG\AdminBundle\Exception\AdminException;
14			use LAG\AdminBundle\Filter\RequestFilterInterface;
15			use LAG\AdminBundle\Message\MessageHandlerInterface;
16			use LAG\AdminBundle\Pager\PagerFantaAdminAdapter;
17			use Pagerfanta\Pagerfanta;
18			use Symfony\Component\DependencyInjection\Container;
19			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
20			use Symfony\Component\HttpFoundation\Request;
21			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
22			use Symfony\Component\Security\Core\Role\Role;
23			use Symfony\Component\Security\Core\User\UserInterface;
24
25			class Admin implements AdminInterface
26			{
27			use AdminTrait;
28
29			/**
30			* Entities collection.
31			*
32			* @var ArrayCollection
33			*/
34			protected $entities;
35
36			/**
37			* @var MessageHandlerInterface
38			*/
39			protected $messageHandler;
40
41			/**
42			* @var EntityManagerInterface
43			*/
44			protected $entityManager;
45
46			/**
47			* @var DataProviderInterface
48			*/
49			protected $dataProvider;
50
51			/**
52			* Admin configuration object
53			*
54			* @var AdminConfiguration
55			*/
56			protected $configuration;
57
58			/**
59			* Admin configured actions
60			*
61			* @var ActionInterface[]
62			*/
63			protected $actions = [];
64
65			/**
66			* Admin current action. It will be set after calling the handleRequest()
67			*
68			* @var ActionInterface
69			*/
70			protected $currentAction;
71
72			/**
73			* Admin name
74			*
75			* @var string
76			*/
77			protected $name;
78
79			/**
80			* @var EventDispatcherInterface
81			*/
82			protected $eventDispatcher;
83
84			/**
85			* @var RequestFilterInterface
86			*/
87			protected $requestFilter;
88
89			/**
90			* Admin constructor.
91			*
92			* @param string $name
93			* @param DataProviderInterface $dataProvider
94			* @param AdminConfiguration $configuration
95	26		* @param MessageHandlerInterface $messageHandler
96			* @param EventDispatcherInterface $eventDispatcher
97			* @param RequestFilterInterface $requestFilter
98			*/
99			public function __construct(
100			$name,
101			DataProviderInterface $dataProvider,
102	26		AdminConfiguration $configuration,
103	26		MessageHandlerInterface $messageHandler,
104	26		EventDispatcherInterface $eventDispatcher,
105	26		RequestFilterInterface $requestFilter
106	26		) {
107	26		$this->name = $name;
108	26		$this->dataProvider = $dataProvider;
109			$this->configuration = $configuration;
110			$this->messageHandler = $messageHandler;
111			$this->eventDispatcher = $eventDispatcher;
112			$this->entities = new ArrayCollection();
113			$this->requestFilter = $requestFilter;
114			}
115
116			/**
117			* Load entities and set current action according to request.
118	9		*
119			* @param Request $request
120			* @param null $user
121	9		* @return void
122			* @throws AdminException
123	9		*/
124			public function handleRequest(Request $request, $user = null)
125			{
126	9		// set current action
127	9		$this->currentAction = $this->getAction($request->get('_route_params')['_action']);
128
129			// check if user is logged have required permissions to get current action
130	9		$this->checkPermissions($user);
131	8
132	8		$actionConfiguration = $this
133	8		->currentAction
134			->getConfiguration();
135	1
136			// configure the request filter with the action and admin configured parameters
137			$this
138			->requestFilter
139	9		->configure(
140	1		$actionConfiguration->getParameter('criteria'),
141			$actionConfiguration->getParameter('order'),
142			$this->configuration->getParameter('max_per_page')
143			);
144	9
145	9		// filter the request with the configured criteria, order and max_per_page parameter
146	9		$this
147	9		->requestFilter
148	9		->filter($request);
149	9
150	8		// load entities according to action and request
151			$this->load(
152			$this->requestFilter->getCriteria(),
153			$this->requestFilter->getOrder(),
154			$this->requestFilter->getMaxPerPage(),
155			$this->requestFilter->getCurrentPage()
156			);
157			}
158	9
159			/**
160	9		* Check if user is allowed to be here
161	9		*
162			* @param UserInterface\|string $user
163	1		* @throws Exception
164	1		*/
165			public function checkPermissions($user)
166	1		{
167	1		if (!($user instanceof UserInterface)) {
168	1		return;
169	1		}
170			if ($this->currentAction === null) {
171	1		throw new Exception('Current action should be set before checking the permissions');
172	1		}
173			$roles = $user->getRoles();
174	1		$actionName = $this
175			->getCurrentAction()
176	1		->getName();
177	1
178	1		if (!$this->isActionGranted($actionName, $roles)) {
179	1		$rolesStringArray = [];
180
181	1		foreach ($roles as $role) {
182
183	1		if ($role instanceof Role) {
184	1		$rolesStringArray[] = $role->getRole();
185			} else {
186	1		$rolesStringArray[] = $role;
187	1		}
188			}
189	1
190			$message = sprintf('User with roles %s not allowed for action "%s"',
191			implode(', ', $rolesStringArray),
192			$actionName
193			);
194			throw new NotFoundHttpException($message);
195			}
196	5		}
197
198			/**
199	5		* Create and return a new entity.
200			*
201	5		* @return object
202			*/
203			public function create()
204	5		{
205			// create an entity from the data provider
206	5		$entity = $this
207			->dataProvider
208			->create();
209	5
210			// add it to the collection
211	5		$this
212			->entities
213	5		->add($entity);
214
215			return $entity;
216			}
217
218			/**
219			* Save entity via admin manager. Error are catch, logged and a flash message is added to session
220			*
221	2		* @return bool true if the entity was saved without errors
222			*/
223		View Code Duplication	public function save()
224	2		{
225	2		try {
226			foreach ($this->entities as $entity) {
227	2		$this
228	1		->dataProvider
229			->save($entity);
230	1		}
231			// inform the user that the entity is saved
232	1		$this
233	1		->messageHandler
234	2		->handleSuccess($this->generateMessageTranslationKey('saved'));
235	1		$success = true;
236			} catch (Exception $e) {
237	1		$this
238	1		->messageHandler
239	1		->handleError(
240	1		$this->generateMessageTranslationKey('lag.admin.saved_errors'),
241	1		"An error has occurred while saving an entity : {$e->getMessage()}, stackTrace: {$e->getTraceAsString()}"
242			);
243	2		$success = false;
244			}
245			return $success;
246			}
247
248			/**
249			* Remove an entity with data provider
250			*
251	2		* @return bool true if the entity was saved without errors
252			*/
253		View Code Duplication	public function remove()
254	2		{
255	2		try {
256			foreach ($this->entities as $entity) {
257	2		$this
258	1		->dataProvider
259			->remove($entity);
260	1		}
261			// inform the user that the entity is removed
262	1		$this
263	1		->messageHandler
264	2		->handleSuccess($this->generateMessageTranslationKey('deleted'));
265	1		$success = true;
266			} catch (Exception $e) {
267	1		$this
268	1		->messageHandler
269	1		->handleError(
270	1		$this->generateMessageTranslationKey('lag.admin.deleted_errors'),
271	1		"An error has occurred while deleting an entity : {$e->getMessage()}, stackTrace: {$e->getTraceAsString()} "
272			);
273	2		$success = false;
274			}
275			return $success;
276			}
277
278			/**
279			* Generate a route for admin and action name (like lag.admin.my_admin)
280			*
281			* @param $actionName
282			*
283			* @return string
284			*
285	15		* @throws Exception
286			*/
287	15		public function generateRouteName($actionName)
288	2		{
289	2		if (!array_key_exists($actionName, $this->getConfiguration()->getParameter('actions'))) {
290	2		throw new Exception(
291	2		sprintf('Invalid action name %s for admin %s (available action are: %s)',
292	2		$actionName,
293	2		$this->getName(),
294			implode(', ', $this->getActionNames()))
295			);
296	14		}
297			// get routing name pattern
298	14		$routingPattern = $this->getConfiguration()->getParameter('routing_name_pattern');
299	14		// replace admin and action name in pattern
300			$routeName = str_replace('{admin}', Container::underscore($this->getName()), $routingPattern);
301	14		$routeName = str_replace('{action}', $actionName, $routeName);
302
303			return $routeName;
304			}
305
306			/**
307			* Load entities manually according to criteria.
308			*
309			* @param array $criteria
310			* @param array $orderBy
311			* @param int $limit
312			* @param int $offset
313	9		* @throws Exception
314			*/
315	9		public function load(array $criteria, $orderBy = [], $limit = 25, $offset = 1)
316	9		{
317	9		$actionConfiguration = $this
318	9		->getCurrentAction()
319	9		->getConfiguration();
320	9		$pager = $actionConfiguration->getParameter('pager');
321	9		$requirePagination = $this
322			->getCurrentAction()
323	9		->isPaginationRequired();
324
325	1		if ($pager == 'pagerfanta' && $requirePagination) {
326			// adapter to pagerfanta
327	1		$adapter = new PagerFantaAdminAdapter($this->dataProvider, $criteria, $orderBy);
328	1		// create pager
329	1		$this->pager = new Pagerfanta($adapter);
330			$this->pager->setMaxPerPage($limit);
331	1		$this->pager->setCurrentPage($offset);
332
333	1		$entities = $this
334	1		->pager
335			->getCurrentPageResults();
336	8		} else {
337	7		// if the current action should retrieve only one entity, the offset should be zero
338	7		if ($actionConfiguration->getParameter('load_strategy') !== AdminInterface::LOAD_STRATEGY_MULTIPLE) {
339	8		$offset = 0;
340			}
341	8		$entities = $this
342			->dataProvider
343	9		->findBy($criteria, $orderBy, $limit, $offset);
344	1		}
345			if (!is_array($entities) && !($entities instanceof Collection)) {
346			throw new Exception('The data provider should return either a collection or an array. Got '.gettype($entities).' instead');
347	8		}
348	8
349	8		if (is_array($entities)) {
350	8		$entities = new ArrayCollection($entities);
351	8		}
352			$this->entities = $entities;
353			}
354
355			/**
356			* Return loaded entities
357			*
358	2		* @return Collection
359			*/
360	2		public function getEntities()
361			{
362			return $this->entities;
363			}
364
365			/**
366			* Return entity for current admin. If entity does not exist, it throws an exception.
367			*
368			* @return mixed
369			*
370	1		* @throws Exception
371			*/
372	1		public function getUniqueEntity()
373	1		{
374			if ($this->entities->count() == 0) {
375	1		throw new Exception("Entity not found in admin \"{$this->getName()}\".");
376	1		}
377			if ($this->entities->count() > 1) {
378	1		throw new Exception("Too much entities found in admin \"{$this->getName()}\".");
379			}
380			return $this->entities->first();
381			}
382
383			/**
384			* Return admin name
385			*
386	19		* @return string
387			*/
388	19		public function getName()
389			{
390			return $this->name;
391			}
392
393			/**
394			* Return true if current action is granted for user.
395			*
396			* @param string $actionName Le plus grand de tous les héros
397			* @param array $roles
398			*
399	2		* @return bool
400			*/
401	2		public function isActionGranted($actionName, array $roles)
402			{
403			$isGranted = array_key_exists($actionName, $this->actions);
404	2
405	2		// if action exists
406			if ($isGranted) {
407	2		$isGranted = false;
408			/** @var ActionInterface $action */
409	2		$action = $this->actions[$actionName];
410			// checking roles permissions
411	2		foreach ($roles as $role) {
412	2
413	2		if ($role instanceof Role) {
414	2		$role = $role->getRole();
415	2		}
416	2		if (in_array($role, $action->getPermissions())) {
417	2		$isGranted = true;
418	2		}
419			}
420	2		}
421
422			return $isGranted;
423			}
424
425			/**
426	10		* @return ActionInterface[]
427			*/
428	10		public function getActions()
429			{
430			return $this->actions;
431			}
432
433			/**
434	2		* @return integer[]
435			*/
436	2		public function getActionNames()
437			{
438			return array_keys($this->actions);
439			}
440
441			/**
442			* @param $name
443			* @return ActionInterface
444	9		* @throws Exception
445			*/
446	9		public function getAction($name)
447	1		{
448	1		if (!array_key_exists($name, $this->getActions())) {
449	1		throw new Exception(
450			"Invalid action name \"{$name}\" for admin '{$this->getName()}'. Check your configuration"
451			);
452	9		}
453
454			return $this->actions[$name];
455			}
456
457			/**
458			* Return if an action with specified name exists form this admin.
459			*
460			* @param $name
461	1		* @return bool
462			*/
463	1		public function hasAction($name)
464			{
465			return array_key_exists($name, $this->actions);
466			}
467
468			/**
469			* @param ActionInterface $action
470	15		* @return void
471			*/
472	15		public function addAction(ActionInterface $action)
473	15		{
474			$this->actions[$action->getName()] = $action;
475			}
476
477			/**
478			* Return the current action or an exception if it is not set.
479			*
480			* @return ActionInterface
481	10		* @throws Exception
482			*/
483	10		public function getCurrentAction()
484			{
485	1		if ($this->currentAction === null) {
486			// current action should be defined
487	1		throw new Exception(
488			'Current action is null. You should initialize it (with handleRequest method for example)'
489			);
490	9		}
491
492			return $this->currentAction;
493			}
494
495			/**
496			* Return if the current action has been initialized and set.
497			*
498	1		* @return boolean
499			*/
500	1		public function isCurrentActionDefined()
501			{
502			return ($this->currentAction instanceof ActionInterface);
503			}
504
505			/**
506			* Return admin configuration object.
507			*
508	19		* @return AdminConfiguration
509			*/
510	19		public function getConfiguration()
511			{
512			return $this->configuration;
513			}
514
515			/**
516			* Return a translation key for a message according to the Admin's translation pattern.
517			*
518			* @param string $message
519	5		* @return string
520			*/
521	5		protected function generateMessageTranslationKey($message)
522	5		{
523	5		return $this->getTranslationKey(
524	5		$this->configuration->getParameter('translation_pattern'),
525	5		$message,
526			$this->name
527			);
528			}
529			}
530

larriereguichet / AdminBundle

Push — dev ( df0c76...243dfc )

Admin::addAction() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like