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

Completed

Push — dev ( 243dfc...851a92 )

by Arnaud

created 2016-12-08 08:56 UTC

Admin::loadPaginate() A

↳ Parent: Admin

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?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\Admin\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 according to the given criteria and the current action configuration.
     *
     * @param array $criteria
     * @param array $orderBy
     * @param int $limit
     * @param int $offset
     * @throws Exception
     */
    public function load(array $criteria, array $orderBy = [], $limit = 25, $offset = 1)
    {
        $currentAction = $this->getCurrentAction();
        $currentActionConfiguration = $currentAction->getConfiguration();

        // some action, such as create, does not require the entities to be loaded
        if (!$currentAction->isLoadingRequired()) {
            return;
        }
        $pager = $currentActionConfiguration->getParameter('pager');

        if ($currentAction->isPaginationRequired() && $pager) {
            $loadStrategy = $currentActionConfiguration->getParameter('load_strategy');

            // only pagerfanta adapter is yet supported
            if ('pagerfanta' !== $pager) {
                throw new AdminException(
                    'Only pagerfanta value is allowed for pager parameter, given '.$pager,
                    $currentAction->getName(),
                    $this
                );
            }
            // only load strategy multiple is allowed for pagination (ie, can not paginate if only one entity is loaded)
            if (AdminInterface::LOAD_STRATEGY_MULTIPLE !== $loadStrategy) {
                throw new AdminException(
                    'Only "strategy_multiple" value is allowed for pager parameter, given '.$loadStrategy,
                    $currentAction->getName(),
                    $this
                );
            }
            // load entities using a pager
            $entities = $this->loadPaginate($criteria, $orderBy, $limit, $offset);
        } else {
            // load using the data provider
            $entities = $this->loadWithoutPagination($criteria, $orderBy, $limit, $offset);
        }

        // the data provider should return an array or a collection of entities.
        if (!is_array($entities) && !$entities instanceof Collection) {
            throw new AdminException(
                'The data provider should return either a collection or an array. Got '
                .gettype($entities).' instead',
                $currentAction->getName(),
                $this
            );
        }

        // if an array is provided, transform it to a collection to be more convenient
        if (is_array($entities)) {
            $entities = new ArrayCollection($entities);
        }

        // load the entities into the Admin
        $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()}" ('.$this->entities->count().').'
            );
        }
        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
        );
    }

    /**
     * Load entities using PagerFanta.
     *
     * @param array $criteria
     * @param array $orderBy
     * @param int $limit
     * @param int $offset
     *
     * @return array|\Traversable
     */
    protected function loadPaginate(array $criteria, array $orderBy, $limit, $offset)
    {
        // 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);

        return $this
            ->pager
            ->getCurrentPageResults();
    }

    /**
     * Load entities using to configured data provider.
     *
     * @param array $criteria
     * @param array $orderBy
     * @param int $limit
     * @param int $offset
     *
     * @return array|Collection
     */
    protected function loadWithoutPagination(array $criteria, $orderBy, $limit, $offset)
    {
        $currentAction = $this->getCurrentAction();
        $currentActionConfiguration = $currentAction->getConfiguration();

        // if the current action should retrieve only one entity, the offset should be zero
        if ($currentActionConfiguration->getParameter('load_strategy') !== AdminInterface::LOAD_STRATEGY_MULTIPLE) {
            $offset = 0;
            $limit = 1;
        }

        return $this
            ->dataProvider
            ->findBy($criteria, $orderBy, $limit, $offset);
    }
}


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\Admin\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	27		* @param MessageHandlerInterface $messageHandler
96			* @param EventDispatcherInterface $eventDispatcher
97			* @param RequestFilterInterface $requestFilter
98			*/
99			public function __construct(
100			$name,
101			DataProviderInterface $dataProvider,
102	27		AdminConfiguration $configuration,
103	27		MessageHandlerInterface $messageHandler,
104	27		EventDispatcherInterface $eventDispatcher,
105	27		RequestFilterInterface $requestFilter
106	27		) {
107	27		$this->name = $name;
108	27		$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	5		->create();
209
210			// add it to the collection
211			$this
212			->entities
213			->add($entity);
214
215			return $entity;
216	2		}
217
218			/**
219	2		* Save entity via admin manager. Error are catch, logged and a flash message is added to session
220	2		*
221			* @return bool true if the entity was saved without errors
222	2		*/
223	1	View Code Duplication	public function save()
224			{
225	1		try {
226			foreach ($this->entities as $entity) {
227	1		$this
228	1		->dataProvider
229	2		->save($entity);
230	1		}
231			// inform the user that the entity is saved
232	1		$this
233	1		->messageHandler
234	1		->handleSuccess($this->generateMessageTranslationKey('saved'));
235	1		$success = true;
236	1		} catch (Exception $e) {
237			$this
238	2		->messageHandler
239			->handleError(
240			$this->generateMessageTranslationKey('lag.admin.saved_errors'),
241			"An error has occurred while saving an entity : {$e->getMessage()}, stackTrace: {$e->getTraceAsString()}"
242			);
243			$success = false;
244			}
245			return $success;
246	2		}
247
248			/**
249	2		* Remove an entity with data provider
250	2		*
251			* @return bool true if the entity was saved without errors
252	2		*/
253	1	View Code Duplication	public function remove()
254			{
255	1		try {
256			foreach ($this->entities as $entity) {
257	1		$this
258	1		->dataProvider
259	2		->remove($entity);
260	1		}
261			// inform the user that the entity is removed
262	1		$this
263	1		->messageHandler
264	1		->handleSuccess($this->generateMessageTranslationKey('deleted'));
265	1		$success = true;
266	1		} catch (Exception $e) {
267			$this
268	2		->messageHandler
269			->handleError(
270			$this->generateMessageTranslationKey('lag.admin.deleted_errors'),
271			"An error has occurred while deleting an entity : {$e->getMessage()}, stackTrace: {$e->getTraceAsString()} "
272			);
273			$success = false;
274			}
275			return $success;
276			}
277
278			/**
279			* Generate a route for admin and action name (like lag.admin.my_admin)
280	16		*
281			* @param $actionName
282	16		*
283	2		* @return string
284	2		*
285	2		* @throws Exception
286	2		*/
287	2		public function generateRouteName($actionName)
288	2		{
289			if (!array_key_exists($actionName, $this->getConfiguration()->getParameter('actions'))) {
290			throw new Exception(
291	15		sprintf('Invalid action name %s for admin %s (available action are: %s)',
292			$actionName,
293	15		$this->getName(),
294	15		implode(', ', $this->getActionNames()))
295			);
296	15		}
297			// get routing name pattern
298			$routingPattern = $this->getConfiguration()->getParameter('routing_name_pattern');
299			// replace admin and action name in pattern
300			$routeName = str_replace('{admin}', Container::underscore($this->getName()), $routingPattern);
301			$routeName = str_replace('{action}', $actionName, $routeName);
302
303			return $routeName;
304			}
305
306			/**
307			* Load entities according to the given criteria and the current action configuration.
308	9		*
309			* @param array $criteria
310	9		* @param array $orderBy
311	9		* @param int $limit
312	9		* @param int $offset
313	9		* @throws Exception
314	9		*/
315	9		public function load(array $criteria, array $orderBy = [], $limit = 25, $offset = 1)
316	9		{
317			$currentAction = $this->getCurrentAction();
318	9		$currentActionConfiguration = $currentAction->getConfiguration();
319
320	1		// some action, such as create, does not require the entities to be loaded
321			if (!$currentAction->isLoadingRequired()) {
322	1		return;
323	1		}
324	1		$pager = $currentActionConfiguration->getParameter('pager');
325
326	1		if ($currentAction->isPaginationRequired() && $pager) {
327			$loadStrategy = $currentActionConfiguration->getParameter('load_strategy');
328	1
329	1		// only pagerfanta adapter is yet supported
330			if ('pagerfanta' !== $pager) {
331	8		throw new AdminException(
332	7		'Only pagerfanta value is allowed for pager parameter, given '.$pager,
333	7		$currentAction->getName(),
334	8		$this
335			);
336	8		}
337			// only load strategy multiple is allowed for pagination (ie, can not paginate if only one entity is loaded)
338	9		if (AdminInterface::LOAD_STRATEGY_MULTIPLE !== $loadStrategy) {
339	1		throw new AdminException(
340			'Only "strategy_multiple" value is allowed for pager parameter, given '.$loadStrategy,
341			$currentAction->getName(),
342	8		$this
343	8		);
344	8		}
345	8		// load entities using a pager
346	8		$entities = $this->loadPaginate($criteria, $orderBy, $limit, $offset);
347			} else {
348			// load using the data provider
349			$entities = $this->loadWithoutPagination($criteria, $orderBy, $limit, $offset);
350			}
351
352			// the data provider should return an array or a collection of entities.
353	2		if (!is_array($entities) && !$entities instanceof Collection) {
354			throw new AdminException(
355	2		'The data provider should return either a collection or an array. Got '
356			.gettype($entities).' instead',
357			$currentAction->getName(),
358			$this
359			);
360			}
361
362			// if an array is provided, transform it to a collection to be more convenient
363			if (is_array($entities)) {
364			$entities = new ArrayCollection($entities);
365	1		}
366
367	1		// load the entities into the Admin
368	1		$this->entities = $entities;
369			}
370	1
371	1		/**
372			* Return loaded entities
373	1		*
374			* @return Collection
375			*/
376			public function getEntities()
377			{
378			return $this->entities;
379			}
380
381	20		/**
382			* Return entity for current admin. If entity does not exist, it throws an exception.
383	20		*
384			* @return mixed
385			*
386			* @throws Exception
387			*/
388			public function getUniqueEntity()
389			{
390			if ($this->entities->count() == 0) {
391			throw new Exception('Entity not found in admin "'.$this->getName().'""');
392			}
393			if ($this->entities->count() > 1) {
394	2		throw new Exception(
395			'Too much entities found in admin "{$this->getName()}" ('.$this->entities->count().').'
396	2		);
397			}
398			return $this->entities->first();
399	2		}
400	2
401			/**
402	2		* Return admin name
403			*
404	2		* @return string
405			*/
406	2		public function getName()
407	2		{
408	2		return $this->name;
409	2		}
410	2
411	2		/**
412	2		* Return true if current action is granted for user.
413	2		*
414			* @param string $actionName Le plus grand de tous les héros
415	2		* @param array $roles
416			*
417			* @return bool
418			*/
419			public function isActionGranted($actionName, array $roles)
420			{
421	10		$isGranted = array_key_exists($actionName, $this->actions);
422
423	10		// if action exists
424			if ($isGranted) {
425			$isGranted = false;
426			/** @var ActionInterface $action */
427			$action = $this->actions[$actionName];
428			// checking roles permissions
429	2		foreach ($roles as $role) {
430
431	2		if ($role instanceof Role) {
432			$role = $role->getRole();
433			}
434			if (in_array($role, $action->getPermissions())) {
435			$isGranted = true;
436			}
437			}
438			}
439	9
440			return $isGranted;
441	9		}
442	1
443	1		/**
444	1		* @return ActionInterface[]
445			*/
446			public function getActions()
447	9		{
448			return $this->actions;
449			}
450
451			/**
452			* @return integer[]
453			*/
454			public function getActionNames()
455			{
456	1		return array_keys($this->actions);
457			}
458	1
459			/**
460			* @param $name
461			* @return ActionInterface
462			* @throws Exception
463			*/
464			public function getAction($name)
465	15		{
466			if (!array_key_exists($name, $this->getActions())) {
467	15		throw new Exception(
468	15		"Invalid action name \"{$name}\" for admin '{$this->getName()}'. Check your configuration"
469			);
470			}
471
472			return $this->actions[$name];
473			}
474
475			/**
476	10		* Return if an action with specified name exists form this admin.
477			*
478	10		* @param $name
479			* @return bool
480	1		*/
481			public function hasAction($name)
482	1		{
483			return array_key_exists($name, $this->actions);
484			}
485	9
486			/**
487			* @param ActionInterface $action
488			* @return void
489			*/
490			public function addAction(ActionInterface $action)
491			{
492			$this->actions[$action->getName()] = $action;
493	1		}
494
495	1		/**
496			* Return the current action or an exception if it is not set.
497			*
498			* @return ActionInterface
499			* @throws Exception
500			*/
501			public function getCurrentAction()
502			{
503	20		if ($this->currentAction === null) {
504			// current action should be defined
505	20		throw new Exception(
506			'Current action is null. You should initialize it (with handleRequest method for example)'
507			);
508			}
509
510			return $this->currentAction;
511			}
512
513			/**
514	4		* Return if the current action has been initialized and set.
515			*
516	4		* @return boolean
517	4		*/
518	4		public function isCurrentActionDefined()
519	4		{
520	4		return ($this->currentAction instanceof ActionInterface);
521			}
522
523			/**
524			* Return admin configuration object.
525			*
526			* @return AdminConfiguration
527			*/
528			public function getConfiguration()
529			{
530			return $this->configuration;
531			}
532
533			/**
534			* Return a translation key for a message according to the Admin's translation pattern.
535			*
536			* @param string $message
537			* @return string
538			*/
539			protected function generateMessageTranslationKey($message)
540			{
541			return $this->getTranslationKey(
542			$this->configuration->getParameter('translation_pattern'),
543			$message,
544			$this->name
545			);
546			}
547
548			/**
549			* Load entities using PagerFanta.
550			*
551			* @param array $criteria
552			* @param array $orderBy
553			* @param int $limit
554			* @param int $offset
555			*
556			* @return array\|\Traversable
557			*/
558			protected function loadPaginate(array $criteria, array $orderBy, $limit, $offset)
559			{
560			// adapter to pagerfanta
561			$adapter = new PagerFantaAdminAdapter($this->dataProvider, $criteria, $orderBy);
562			// create pager
563			$this->pager = new Pagerfanta($adapter);
564			$this->pager->setMaxPerPage($limit);
565			$this->pager->setCurrentPage($offset);
566
567			return $this
568			->pager
569			->getCurrentPageResults();
570			}
571
572			/**
573			* Load entities using to configured data provider.
574			*
575			* @param array $criteria
576			* @param array $orderBy
577			* @param int $limit
578			* @param int $offset
579			*
580			* @return array\|Collection
581			*/
582			protected function loadWithoutPagination(array $criteria, $orderBy, $limit, $offset)
583			{
584			$currentAction = $this->getCurrentAction();
585			$currentActionConfiguration = $currentAction->getConfiguration();
586
587			// if the current action should retrieve only one entity, the offset should be zero
588			if ($currentActionConfiguration->getParameter('load_strategy') !== AdminInterface::LOAD_STRATEGY_MULTIPLE) {
589			$offset = 0;
590			$limit = 1;
591			}
592
593			return $this
594			->dataProvider
595			->findBy($criteria, $orderBy, $limit, $offset);
596			}
597			}
598

larriereguichet / AdminBundle

Push — dev ( 243dfc...851a92 )

Admin::loadPaginate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like