AbstractController::getDataTablesUrl() - Code Metrics - Inspection of "Update CHANGELOG" - webeweb/jquery-datatables-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 780432...ce7389 )

by WEBEWEB

created 2020-01-06 18:06 UTC

AbstractController::getDataTablesUrl() A

↳ Parent: AbstractController

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.584
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

/*
 * This file is part of the jquery-datatables-bundle package.
 *
 * (c) 2018 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\JQuery\DataTablesBundle\Controller;

use Doctrine\ORM\EntityNotFoundException;
use Exception;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;
use WBW\Bundle\BootstrapBundle\Controller\AbstractController as BaseController;
use WBW\Bundle\CoreBundle\Model\ActionResponse;
use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesColumnInterface;
use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesWrapperInterface;
use WBW\Bundle\JQuery\DataTablesBundle\Event\DataTablesEvent;
use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesColumnException;
use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesCSVExporterException;
use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesEditorException;
use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesRepositoryException;
use WBW\Bundle\JQuery\DataTablesBundle\Exception\UnregisteredDataTablesProviderException;
use WBW\Bundle\JQuery\DataTablesBundle\Factory\DataTablesFactory;
use WBW\Bundle\JQuery\DataTablesBundle\Helper\DataTablesExportHelper;
use WBW\Bundle\JQuery\DataTablesBundle\Manager\DataTablesManager;
use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesCSVExporterInterface;
use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesEditorInterface;
use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesProviderInterface;
use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesRouterInterface;
use WBW\Bundle\JQuery\DataTablesBundle\Repository\DataTablesRepositoryInterface;
use WBW\Bundle\JQuery\DataTablesBundle\WBWJQueryDataTablesEvents;
use WBW\Library\Core\Database\Helper\PaginateHelper;

/**
 * Abstract controller.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\JQuery\DataTablesBundle\Controller
 * @abstract
 */
abstract class AbstractController extends BaseController {

    /**
     * Build a response.
     *
     * @param Request $request The request.
     * @param string $name The provider name.
     * @param ActionResponse $output The output.
     * @return Response Returns the response.
     */
    protected function buildDataTablesResponse(Request $request, $name, ActionResponse $output) {

        if (true === $request->isXmlHttpRequest()) {
            return new JsonResponse($output);
        }

        switch ($output->getStatus()) {

            case 200:
                $this->notifySuccess($output->getNotify());
                break;

            case 404:
                $this->notifyDanger($output->getNotify());
                break;

            case 500:
                $this->notifyWarning($output->getNotify());
                break;
        }

        return $this->redirectToRoute("wbw_jquery_datatables_index", ["name" => $name]);
    }

    /**
     * Dispatch an event.
     *
     * @param string $eventName The event name.
     * @param array $entities The entities.
     * @return DataTablesEvent|null Returns the event in case of success, null otherwise.
     */
    protected function dispatchDataTablesEvent($eventName, array $entities) {
        return $this->dispatchEvent($eventName, new DataTablesEvent($eventName, $entities));
    }

    /**
     * Export callback.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @param DataTablesRepositoryInterface $repository The repository.
     * @param DataTablesCSVExporterInterface $dtExporter The exporter.
     * @param bool $windows Windows ?
     * @return void
     */
    protected function exportDataTablesCallback(DataTablesProviderInterface $dtProvider, DataTablesRepositoryInterface $repository, DataTablesCSVExporterInterface $dtExporter, $windows) {

        $stream = fopen("php://output", "w+");
        fputcsv($stream, DataTablesExportHelper::convert($dtExporter->exportColumns(), $windows), ";");

        // Paginates.
        $total = $repository->dataTablesCountExported($dtProvider);
        $pages = PaginateHelper::getPagesCount($total, DataTablesRepositoryInterface::REPOSITORY_LIMIT);

        $em = $this->getDoctrine()->getManager();

        for ($i = 0; $i < $pages; ++$i) {

            // Get the offset and limit.
            list($offset, $limit) = PaginateHelper::getPageOffsetAndLimit($i, DataTablesRepositoryInterface::REPOSITORY_LIMIT, $total);

            // Get the export query with offset and limit.
            $result = $repository->dataTablesExportAll($dtProvider)
                ->setFirstResult($offset)
                ->setMaxResults($limit)
                ->getQuery()
                ->iterate();

            while (false !== ($row = $result->next())) {

                $this->dispatchDataTablesEvent(WBWJQueryDataTablesEvents::DATATABLES_PRE_EXPORT, [$row[0]]);

                fputcsv($stream, DataTablesExportHelper::convert($dtExporter->exportRow($row[0]), $windows), ";");

                $em->detach($row[0]); // Detach the entity to avoid memory consumption.

                $this->dispatchDataTablesEvent(WBWJQueryDataTablesEvents::DATATABLES_POST_EXPORT, [$row[0]]);
            }
        }

        fclose($stream);
    }

    /**
     * Get a CSV exporter.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @return DataTablesCSVExporterInterface Returns the CSV exporter.
     * @throws BadDataTablesCSVExporterException Throws a bad CSV exporter exception.
     */
    protected function getDataTablesCSVExporter(DataTablesProviderInterface $dtProvider) {

        $context = [
            "_controller" => get_class($this),
            "_provider"   => get_class($dtProvider),
        ];

        $this->logInfo(sprintf("DataTables controller search for a CSV exporter with name \"%s\"", $dtProvider->getName()), $context);

        $dtExporter = $dtProvider->getCSVExporter();
        if (false === ($dtExporter instanceOf DataTablesCSVExporterInterface)) {
            throw new BadDataTablesCSVExporterException($dtExporter);
        }

        $context["_exporter"] = get_class($dtExporter);

        $this->logInfo(sprintf("DataTables controller found a CSV exporter with name \"%s\"", $dtProvider->getName()), $context);

        return $dtExporter;
    }

    /**
     * Get a column.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @param string $data The data.
     * @return DataTablesColumnInterface Returns the column.
     * @throws BadDataTablesColumnException Throws a bad column exception.
     */
    protected function getDataTablesColumn(DataTablesProviderInterface $dtProvider, $data) {

        $dtWrapper = $this->getDataTablesWrapper($dtProvider);

        $context = [
            "_controller" => get_class($this),
            "_provider"   => get_class($dtProvider),
            "_wrapper"    => get_class($dtWrapper),
        ];

        $this->logInfo(sprintf("DataTables controller search for a column with name \"%s\"", $data), $context);

        $dtColumn = $dtWrapper->getColumn($data);
        if (null === $dtColumn) {
            throw new BadDataTablesColumnException($data);
        }

        $context["_column"] = get_class($dtColumn);

        $this->logInfo(sprintf("DataTables controller found a column with name \"%s\"", $data), $context);

        return $dtColumn;
    }

    /**
     * Get an editor.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @return DataTablesEditorInterface Returns the editor.
     * @throws BadDataTablesEditorException Throws a bad editor exception.
     */
    protected function getDataTablesEditor(DataTablesProviderInterface $dtProvider) {

        $context = [
            "_controller" => get_class($this),
            "_provider"   => get_class($dtProvider),
        ];

        $this->logInfo(sprintf("DataTables controller search for an editor with name \"%s\"", $dtProvider->getName()), $context);

        $dtEditor = $dtProvider->getEditor();
        if (false === ($dtEditor instanceOf DataTablesEditorInterface)) {
            throw new BadDataTablesEditorException($dtEditor);
        }

        $context["_editor"] = get_class($dtEditor);

        $this->logInfo(sprintf("DataTables controller found an editor with name \"%s\"", $dtProvider->getName()), $context);

        return $dtEditor;
    }

    /**
     * Get an entity by id.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @param int $id The entity id.
     * @return object Returns the entity.
     * @throws BadDataTablesRepositoryException Throws a bad repository exception.
     * @throws EntityNotFoundException Throws an Entity not found exception.
     */
    protected function getDataTablesEntityById(DataTablesProviderInterface $dtProvider, $id) {

        $repository = $this->getDataTablesRepository($dtProvider);

        $context = [
            "_controller" => get_class($this),
            "_provider"   => get_class($dtProvider),
            "_repository" => get_class($repository),
        ];

        $this->logInfo(sprintf("DataTables controller search for an entity with id [%s]", $id), $context);

        $entity = $repository->find($id);
        if (null === $entity) {
            throw EntityNotFoundException::fromClassNameAndIdentifier($dtProvider->getEntity(), [$id]);
        }

        $context["_entity"] = get_class($entity);

        $this->logInfo(sprintf("DataTables controller found an entity with id [%s]", get_class($repository), $id));

        return $entity;
    }

    /**
     * Get the manager.
     *
     * @return DataTablesManager Returns the manager.
     */
    protected function getDataTablesManager() {
        return $this->get(DataTablesManager::SERVICE_NAME);
    }

    /**
     * Get the provider.
     *
     * @param string $name The provider name.
     * @return DataTablesProviderInterface Returns the provider.
     * @throws UnregisteredDataTablesProviderException Throws an unregistered provider exception.
     */
    protected function getDataTablesProvider($name) {

        $dtManager = $this->getDataTablesManager();

        $context = [
            "_controller" => get_class($this),
            "_manager"    => get_class($dtManager),
        ];

        $this->logInfo(sprintf("DataTables controller search for a provider with name \"%s\"", $name), $context);

        $dtProvider = $dtManager->getProvider($name);

        $context["_provider"] = get_class($dtProvider);

        $this->logInfo(sprintf("DataTables controller found a provider with name \"%s\"", $name), $context);

        return $dtProvider;
    }

    /**
     * Get a repository.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @return DataTablesRepositoryInterface Returns the repository.
     * @throws BadDataTablesRepositoryException Throws a bad repository exception.
     */
    protected function getDataTablesRepository(DataTablesProviderInterface $dtProvider) {

        $em = $this->getDoctrine()->getManager();

        $context = [
            "_controller" => get_class($this),
            "_provider"   => get_class($dtProvider),
            "_entity"     => $dtProvider->getEntity(),
        ];

        $this->logInfo(sprintf("DataTables controller search for a repository with name \"%s\"", $dtProvider->getName()), $context);

        $repository = $em->getRepository($dtProvider->getEntity());
        if (false === ($repository instanceOf DataTablesRepositoryInterface)) {
            throw new BadDataTablesRepositoryException($repository);
        }

        $context["_repository"] = get_class($repository);

        $this->logInfo(sprintf("DataTables controller found a repository with name \"%s\"", $dtProvider->getName()), $context);

        /** @var DataTablesRepositoryInterface $repository */
        return $repository;
    }

    /**
     * Get a serializer.
     *
     * @return Serializer Returns the serializer.
     */
    protected function getDataTablesSerializer() {
        return new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);
    }

    /**
     * Get an URL.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @return string Returns the URL.
     */
    protected function getDataTablesUrl(DataTablesProviderInterface $dtProvider) {

        $context = [
            "_controller" => get_class($this),
            "_provider"   => get_class($dtProvider),
        ];

        $this->logInfo(sprintf("DataTables controller search for an URL with name \"%s\"", $dtProvider->getName()), $context);

        if (false === ($dtProvider instanceof DataTablesRouterInterface)) {
            return $this->getRouter()->generate("wbw_jquery_datatables_index", ["name" => $dtProvider->getName()]);
        }

        $url = $dtProvider->getUrl();

        $context["_url"] = $url;

        $this->logInfo(sprintf("DataTables controller found for an URL with name \"%s\"", $dtProvider->getName()), $context);

        return $url;
    }

    /**
     * Get a wrapper.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @return DataTablesWrapperInterface Returns the wrapper.
     */
    protected function getDataTablesWrapper(DataTablesProviderInterface $dtProvider) {

        $dtWrapper = DataTablesFactory::newWrapper($this->getDataTablesUrl($dtProvider), $dtProvider, $this->getKernelEventListener()->getUser());

        $context = [
            "_controller" => get_class($this),
            "_provider"   => get_class($dtProvider),
            "_wrapper"    => get_class($dtWrapper),
        ];

        foreach ($dtProvider->getColumns() as $dtColumn) {

            $this->logInfo(sprintf("DataTables controller add a column \"%s\" with the provider \"%s\"", $dtColumn->getData(), $dtProvider->getName()), $context);

            $dtWrapper->addColumn($dtColumn);
        }

        if (null !== $dtProvider->getOptions()) {
            $dtWrapper->setOptions($dtProvider->getOptions());
        }

        return $dtWrapper;
    }

    /**
     * Handle an exception.
     *
     * @param Exception $ex The exception.
     * @param string $notificationBaseId The notification base id.
     * @return ActionResponse Returns the action response.
     */
    protected function handleDataTablesException(Exception $ex, $notificationBaseId) {

        $this->logInfo($ex->getMessage());

        if (true === ($ex instanceof EntityNotFoundException)) {
            return $this->prepareActionResponse(404, $notificationBaseId . ".danger");
        }

        return $this->prepareActionResponse(500, $notificationBaseId . ".warning");
    }

    /**
     * Log an info.
     *
     * @param string $message The message.
     * @param array $context The context.
     * @return AbstractController Returns this controller.
     */
    protected function logInfo($message, array $context = []) {
        $this->getLogger()->info($message, $context);
        return $this;
    }

    /**
     * Prepare an action response.
     *
     * @param int $status The status.
     * @param string $notificationId The notification id.
     * @return ActionResponse Returns the action response.
     */
    protected function prepareActionResponse($status, $notificationId) {

        $notify = $this->getTranslator()->trans($notificationId, [], "WBWJQueryDataTablesBundle");

        $response = new ActionResponse();
        $response->setStatus($status);
        $response->setNotify($notify);

        return $response;
    }
}


1			<?php
2
3			/*
4			* This file is part of the jquery-datatables-bundle package.
5			*
6			* (c) 2018 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Bundle\JQuery\DataTablesBundle\Controller;
13
14			use Doctrine\ORM\EntityNotFoundException;
15			use Exception;
16			use Symfony\Component\HttpFoundation\JsonResponse;
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Component\HttpFoundation\Response;
19			use Symfony\Component\Serializer\Encoder\JsonEncoder;
20			use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
21			use Symfony\Component\Serializer\Serializer;
22			use WBW\Bundle\BootstrapBundle\Controller\AbstractController as BaseController;
23			use WBW\Bundle\CoreBundle\Model\ActionResponse;
24			use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesColumnInterface;
25			use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesWrapperInterface;
26			use WBW\Bundle\JQuery\DataTablesBundle\Event\DataTablesEvent;
27			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesColumnException;
28			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesCSVExporterException;
29			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesEditorException;
30			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesRepositoryException;
31			use WBW\Bundle\JQuery\DataTablesBundle\Exception\UnregisteredDataTablesProviderException;
32			use WBW\Bundle\JQuery\DataTablesBundle\Factory\DataTablesFactory;
33			use WBW\Bundle\JQuery\DataTablesBundle\Helper\DataTablesExportHelper;
34			use WBW\Bundle\JQuery\DataTablesBundle\Manager\DataTablesManager;
35			use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesCSVExporterInterface;
36			use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesEditorInterface;
37			use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesProviderInterface;
38			use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesRouterInterface;
39			use WBW\Bundle\JQuery\DataTablesBundle\Repository\DataTablesRepositoryInterface;
40			use WBW\Bundle\JQuery\DataTablesBundle\WBWJQueryDataTablesEvents;
41			use WBW\Library\Core\Database\Helper\PaginateHelper;
42
43			/**
44			* Abstract controller.
45			*
46			* @author webeweb <https://github.com/webeweb/>
47			* @package WBW\Bundle\JQuery\DataTablesBundle\Controller
48			* @abstract
49			*/
50			abstract class AbstractController extends BaseController {
51
52			/**
53			* Build a response.
54			*
55			* @param Request $request The request.
56			* @param string $name The provider name.
57			* @param ActionResponse $output The output.
58			* @return Response Returns the response.
59			*/
60			protected function buildDataTablesResponse(Request $request, $name, ActionResponse $output) {
61
62			if (true === $request->isXmlHttpRequest()) {
63			return new JsonResponse($output);
64			}
65
66			switch ($output->getStatus()) {
67
68			case 200:
69			$this->notifySuccess($output->getNotify());
70			break;
71
72			case 404:
73			$this->notifyDanger($output->getNotify());
74			break;
75
76			case 500:
77			$this->notifyWarning($output->getNotify());
78			break;
79			}
80
81			return $this->redirectToRoute("wbw_jquery_datatables_index", ["name" => $name]);
82			}
83
84			/**
85			* Dispatch an event.
86			*
87			* @param string $eventName The event name.
88			* @param array $entities The entities.
89			* @return DataTablesEvent\|null Returns the event in case of success, null otherwise.
90			*/
91			protected function dispatchDataTablesEvent($eventName, array $entities) {
92			return $this->dispatchEvent($eventName, new DataTablesEvent($eventName, $entities));
93			}
94
95			/**
96			* Export callback.
97			*
98			* @param DataTablesProviderInterface $dtProvider The provider.
99			* @param DataTablesRepositoryInterface $repository The repository.
100			* @param DataTablesCSVExporterInterface $dtExporter The exporter.
101			* @param bool $windows Windows ?
102			* @return void
103			*/
104			protected function exportDataTablesCallback(DataTablesProviderInterface $dtProvider, DataTablesRepositoryInterface $repository, DataTablesCSVExporterInterface $dtExporter, $windows) {
105
106			$stream = fopen("php://output", "w+");
107			fputcsv($stream, DataTablesExportHelper::convert($dtExporter->exportColumns(), $windows), ";");
108
109			// Paginates.
110			$total = $repository->dataTablesCountExported($dtProvider);
111			$pages = PaginateHelper::getPagesCount($total, DataTablesRepositoryInterface::REPOSITORY_LIMIT);
112
113			$em = $this->getDoctrine()->getManager();
114
115			for ($i = 0; $i < $pages; ++$i) {
116
117			// Get the offset and limit.
118			list($offset, $limit) = PaginateHelper::getPageOffsetAndLimit($i, DataTablesRepositoryInterface::REPOSITORY_LIMIT, $total);
119
120			// Get the export query with offset and limit.
121			$result = $repository->dataTablesExportAll($dtProvider)
122			->setFirstResult($offset)
123			->setMaxResults($limit)
124			->getQuery()
125			->iterate();
126
127			while (false !== ($row = $result->next())) {
128
129			$this->dispatchDataTablesEvent(WBWJQueryDataTablesEvents::DATATABLES_PRE_EXPORT, [$row[0]]);
130
131			fputcsv($stream, DataTablesExportHelper::convert($dtExporter->exportRow($row[0]), $windows), ";");
132
133			$em->detach($row[0]); // Detach the entity to avoid memory consumption.
134
135			$this->dispatchDataTablesEvent(WBWJQueryDataTablesEvents::DATATABLES_POST_EXPORT, [$row[0]]);
136			}
137			}
138
139			fclose($stream);
140			}
141
142			/**
143			* Get a CSV exporter.
144			*
145			* @param DataTablesProviderInterface $dtProvider The provider.
146			* @return DataTablesCSVExporterInterface Returns the CSV exporter.
147			* @throws BadDataTablesCSVExporterException Throws a bad CSV exporter exception.
148			*/
149			protected function getDataTablesCSVExporter(DataTablesProviderInterface $dtProvider) {
150
151			$context = [
152			"_controller" => get_class($this),
153			"_provider" => get_class($dtProvider),
154			];
155
156			$this->logInfo(sprintf("DataTables controller search for a CSV exporter with name \"%s\"", $dtProvider->getName()), $context);
157
158			$dtExporter = $dtProvider->getCSVExporter();
159			if (false === ($dtExporter instanceOf DataTablesCSVExporterInterface)) {
160			throw new BadDataTablesCSVExporterException($dtExporter);
161			}
162
163			$context["_exporter"] = get_class($dtExporter);
164
165			$this->logInfo(sprintf("DataTables controller found a CSV exporter with name \"%s\"", $dtProvider->getName()), $context);
166
167			return $dtExporter;
168			}
169
170			/**
171			* Get a column.
172			*
173			* @param DataTablesProviderInterface $dtProvider The provider.
174			* @param string $data The data.
175			* @return DataTablesColumnInterface Returns the column.
176			* @throws BadDataTablesColumnException Throws a bad column exception.
177			*/
178			protected function getDataTablesColumn(DataTablesProviderInterface $dtProvider, $data) {
179
180			$dtWrapper = $this->getDataTablesWrapper($dtProvider);
181
182			$context = [
183			"_controller" => get_class($this),
184			"_provider" => get_class($dtProvider),
185			"_wrapper" => get_class($dtWrapper),
186			];
187
188			$this->logInfo(sprintf("DataTables controller search for a column with name \"%s\"", $data), $context);
189
190			$dtColumn = $dtWrapper->getColumn($data);
191			if (null === $dtColumn) {
192			throw new BadDataTablesColumnException($data);
193			}
194
195			$context["_column"] = get_class($dtColumn);
196
197			$this->logInfo(sprintf("DataTables controller found a column with name \"%s\"", $data), $context);
198
199			return $dtColumn;
200			}
201
202			/**
203			* Get an editor.
204			*
205			* @param DataTablesProviderInterface $dtProvider The provider.
206			* @return DataTablesEditorInterface Returns the editor.
207			* @throws BadDataTablesEditorException Throws a bad editor exception.
208			*/
209			protected function getDataTablesEditor(DataTablesProviderInterface $dtProvider) {
210
211			$context = [
212			"_controller" => get_class($this),
213			"_provider" => get_class($dtProvider),
214			];
215
216			$this->logInfo(sprintf("DataTables controller search for an editor with name \"%s\"", $dtProvider->getName()), $context);
217
218			$dtEditor = $dtProvider->getEditor();
219			if (false === ($dtEditor instanceOf DataTablesEditorInterface)) {
220			throw new BadDataTablesEditorException($dtEditor);
221			}
222
223			$context["_editor"] = get_class($dtEditor);
224
225			$this->logInfo(sprintf("DataTables controller found an editor with name \"%s\"", $dtProvider->getName()), $context);
226
227			return $dtEditor;
228			}
229
230			/**
231			* Get an entity by id.
232			*
233			* @param DataTablesProviderInterface $dtProvider The provider.
234			* @param int $id The entity id.
235			* @return object Returns the entity.
236			* @throws BadDataTablesRepositoryException Throws a bad repository exception.
237			* @throws EntityNotFoundException Throws an Entity not found exception.
238			*/
239			protected function getDataTablesEntityById(DataTablesProviderInterface $dtProvider, $id) {
240
241			$repository = $this->getDataTablesRepository($dtProvider);
242
243			$context = [
244			"_controller" => get_class($this),
245			"_provider" => get_class($dtProvider),
246			"_repository" => get_class($repository),
247			];
248
249			$this->logInfo(sprintf("DataTables controller search for an entity with id [%s]", $id), $context);
250
251			$entity = $repository->find($id);
252			if (null === $entity) {
253			throw EntityNotFoundException::fromClassNameAndIdentifier($dtProvider->getEntity(), [$id]);
254			}
255
256			$context["_entity"] = get_class($entity);
257
258			$this->logInfo(sprintf("DataTables controller found an entity with id [%s]", get_class($repository), $id));
259
260			return $entity;
261			}
262
263			/**
264			* Get the manager.
265			*
266			* @return DataTablesManager Returns the manager.
267			*/
268			protected function getDataTablesManager() {
269			return $this->get(DataTablesManager::SERVICE_NAME);
270			}
271
272			/**
273			* Get the provider.
274			*
275			* @param string $name The provider name.
276			* @return DataTablesProviderInterface Returns the provider.
277			* @throws UnregisteredDataTablesProviderException Throws an unregistered provider exception.
278			*/
279			protected function getDataTablesProvider($name) {
280
281			$dtManager = $this->getDataTablesManager();
282
283			$context = [
284			"_controller" => get_class($this),
285			"_manager" => get_class($dtManager),
286			];
287
288			$this->logInfo(sprintf("DataTables controller search for a provider with name \"%s\"", $name), $context);
289
290			$dtProvider = $dtManager->getProvider($name);
291
292			$context["_provider"] = get_class($dtProvider);
293
294			$this->logInfo(sprintf("DataTables controller found a provider with name \"%s\"", $name), $context);
295
296			return $dtProvider;
297			}
298
299			/**
300			* Get a repository.
301			*
302			* @param DataTablesProviderInterface $dtProvider The provider.
303			* @return DataTablesRepositoryInterface Returns the repository.
304			* @throws BadDataTablesRepositoryException Throws a bad repository exception.
305			*/
306			protected function getDataTablesRepository(DataTablesProviderInterface $dtProvider) {
307
308			$em = $this->getDoctrine()->getManager();
309
310			$context = [
311			"_controller" => get_class($this),
312			"_provider" => get_class($dtProvider),
313			"_entity" => $dtProvider->getEntity(),
314			];
315
316			$this->logInfo(sprintf("DataTables controller search for a repository with name \"%s\"", $dtProvider->getName()), $context);
317
318			$repository = $em->getRepository($dtProvider->getEntity());
319			if (false === ($repository instanceOf DataTablesRepositoryInterface)) {
320			throw new BadDataTablesRepositoryException($repository);
321			}
322
323			$context["_repository"] = get_class($repository);
324
325			$this->logInfo(sprintf("DataTables controller found a repository with name \"%s\"", $dtProvider->getName()), $context);
326
327			/** @var DataTablesRepositoryInterface $repository */
328			return $repository;
329			}
330
331			/**
332			* Get a serializer.
333			*
334			* @return Serializer Returns the serializer.
335			*/
336			protected function getDataTablesSerializer() {
337			return new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);
338			}
339
340			/**
341			* Get an URL.
342			*
343			* @param DataTablesProviderInterface $dtProvider The provider.
344			* @return string Returns the URL.
345			*/
346			protected function getDataTablesUrl(DataTablesProviderInterface $dtProvider) {
347
348			$context = [
349			"_controller" => get_class($this),
350			"_provider" => get_class($dtProvider),
351			];
352
353			$this->logInfo(sprintf("DataTables controller search for an URL with name \"%s\"", $dtProvider->getName()), $context);
354
355			if (false === ($dtProvider instanceof DataTablesRouterInterface)) {
356			return $this->getRouter()->generate("wbw_jquery_datatables_index", ["name" => $dtProvider->getName()]);
357			}
358
359			$url = $dtProvider->getUrl();
360
361			$context["_url"] = $url;
362
363			$this->logInfo(sprintf("DataTables controller found for an URL with name \"%s\"", $dtProvider->getName()), $context);
364
365			return $url;
366			}
367
368			/**
369			* Get a wrapper.
370			*
371			* @param DataTablesProviderInterface $dtProvider The provider.
372			* @return DataTablesWrapperInterface Returns the wrapper.
373			*/
374			protected function getDataTablesWrapper(DataTablesProviderInterface $dtProvider) {
375
376			$dtWrapper = DataTablesFactory::newWrapper($this->getDataTablesUrl($dtProvider), $dtProvider, $this->getKernelEventListener()->getUser());
377
378			$context = [
379			"_controller" => get_class($this),
380			"_provider" => get_class($dtProvider),
381			"_wrapper" => get_class($dtWrapper),
382			];
383
384			foreach ($dtProvider->getColumns() as $dtColumn) {
385
386			$this->logInfo(sprintf("DataTables controller add a column \"%s\" with the provider \"%s\"", $dtColumn->getData(), $dtProvider->getName()), $context);
387
388			$dtWrapper->addColumn($dtColumn);
389			}
390
391			if (null !== $dtProvider->getOptions()) {
392			$dtWrapper->setOptions($dtProvider->getOptions());
393			}
394
395			return $dtWrapper;
396			}
397
398			/**
399			* Handle an exception.
400			*
401			* @param Exception $ex The exception.
402			* @param string $notificationBaseId The notification base id.
403			* @return ActionResponse Returns the action response.
404			*/
405			protected function handleDataTablesException(Exception $ex, $notificationBaseId) {
406
407			$this->logInfo($ex->getMessage());
408
409			if (true === ($ex instanceof EntityNotFoundException)) {
410			return $this->prepareActionResponse(404, $notificationBaseId . ".danger");
411			}
412
413			return $this->prepareActionResponse(500, $notificationBaseId . ".warning");
414			}
415
416			/**
417			* Log an info.
418			*
419			* @param string $message The message.
420			* @param array $context The context.
421			* @return AbstractController Returns this controller.
422			*/
423			protected function logInfo($message, array $context = []) {
424			$this->getLogger()->info($message, $context);
425			return $this;
426			}
427
428			/**
429			* Prepare an action response.
430			*
431			* @param int $status The status.
432			* @param string $notificationId The notification id.
433			* @return ActionResponse Returns the action response.
434			*/
435			protected function prepareActionResponse($status, $notificationId) {
436
437			$notify = $this->getTranslator()->trans($notificationId, [], "WBWJQueryDataTablesBundle");
438
439			$response = new ActionResponse();
440			$response->setStatus($status);
441			$response->setNotify($notify);
442
443			return $response;
444			}
445			}
446

webeweb / jquery-datatables-bundle

Push — master ( 780432...ce7389 )

AbstractController::getDataTablesUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like