AbstractDataTablesController::getDataTablesSerializer() - Code Metrics - Inspection of "Add editAction() to update a column" - webeweb/jquery-datatables-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e5e4cb...c0714e )

by WEBEWEB

created 2018-09-10 19:46 UTC

getDataTablesSerializer() A

↳ Parent: AbstractDataTablesController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?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 Doctrine\ORM\EntityRepository;
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\AbstractBootstrapController;
use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesColumn;
use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesWrapper;
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\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\Repository\DataTablesRepositoryInterface;
use WBW\Library\Core\Database\PaginateHelper;
use WBW\Library\Core\Model\Response\ActionResponse;

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

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

        // Determines if the request is an XML HTTP request.
        if (true === $request->isXmlHttpRequest()) {

            // Return the response.
            return new JsonResponse($output);
        }

        // Notify the user.
        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 the response.
        return $this->redirectToRoute("jquery_datatables_index", ["name" => $name]);
    }

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

        // Get the entities manager.
        $em = $this->getDoctrine()->getManager();

        // Open the file.
        $stream = fopen("php://output", "w+");

        // Export the columns.
        fputcsv($stream, $dtExporter->exportColumns(), ";");

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

        // Handle each page.
        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();

            // Handle each entity.
            while (false !== ($row = $result->next())) {

                // Export the entity.
                fputcsv($stream, $dtExporter->exportRow($row[0]), ";");

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

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

        // Get the column.
        $dtColumn = $this->getDataTablesWrapper($dtProvider)->getColumn($data);

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller search for a column with name \"%s\"", $data));

        // Check the column.
        if (null === $dtColumn) {
            throw new BadDataTablesColumnException($data);
        }

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller found a column with name \"%s\"", $data));

        // Return the column.
        return $dtColumn;
    }

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

        // Get the provider.
        $dtExporter = $dtProvider->getCSVExporter();

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller search for a CSV exporter with name \"%s\"", $dtProvider->getName()));

        // Check the CSV exporter.
        if (false === ($dtExporter instanceOf DataTablesCSVExporterInterface)) {
            throw new BadDataTablesCSVExporterException(null !== $dtExporter ? $dtExporter : "null");
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller found a CSV exporter with name \"%s\"", $dtProvider->getName()));

        // Return the exporter.
        return $dtExporter;
    }

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

        // Get the editor.
        $dtEditor = $dtProvider->getEditor();

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller search for an editor with name \"%s\"", $dtProvider->getName()));

        // Check the CSV exporter.
        if (false === ($dtEditor instanceOf DataTablesEditorInterface)) {
            throw new BadDataTablesEditorException(null !== $dtEditor ? $dtEditor : "null");
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller found an editor with name \"%s\"", $dtProvider->getName()));

        // Return the exporter.
        return $dtEditor;
    }

    /**
     * Get an entity by id.
     *
     * @param DataTablesProviderInterface $dtProvider The provider.
     * @param integer $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) {

        // Get the repository.
        $repository = $this->getDataTablesRepository($dtProvider);

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller search for an entity [%s]", $id));

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

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller found an entity [%s]", $id));

        // Return the entity.
        return $entity;
    }

    /**
     * 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) {

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller search for a provider with name \"%s\"", $name));

        // Get the provider.
        $dtProvider = $this->get(DataTablesManager::SERVICE_NAME)->getProvider($name);

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller found a provider with name \"%s\"", $name));

        // Return the provider.
        return $dtProvider;
    }

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

        // Log a debug trace.
        $this->getLogger()->debug(sprintf("DataTables controller search for a repository with name \"%s\"", $dtProvider->getName()));

        // Get the entities manager.
        $em = $this->getDoctrine()->getManager();

        // Get and check the entities repository.
        $repository = $em->getRepository($dtProvider->getEntity());
        if (false === ($repository instanceOf DataTablesRepositoryInterface)) {
            throw new BadDataTablesRepositoryException($repository);
        }

        // Return the repository.
        return $repository;
    }

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

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

        // Initialize the URL.
        $url = $this->getRouter()->generate("jquery_datatables_index", ["name" => $dtProvider->getName()]);

        // Initialize the wrapper.
        $dtWrapper = new DataTablesWrapper($dtProvider->getMethod(), $url, $dtProvider->getName());
        $dtWrapper->getMapping()->setPrefix($dtProvider->getPrefix());

        // Handle each column.
        foreach ($dtProvider->getColumns() as $dtColumn) {

            // Log a debug trace.
            $this->getLogger()->debug(sprintf("DataTables provider add a column \"%s\"", $dtColumn->getData()));

            // Add.
            $dtWrapper->addColumn($dtColumn);
        }

        // Set the options.
        if (null !== $dtProvider->getOptions()) {
            $dtWrapper->setOptions($dtProvider->getOptions());
        }

        // Return the wrapper.
        return $dtWrapper;
    }

    /**
     * Get the notification.
     *
     * @param string $id The notification id.
     * @return string Returns the notification.
     */
    protected function getNotification($id) {
        return $this->getTranslator()->trans($id, [], "JQueryDataTablesBundle");
    }

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

        // Initialize the action response.
        $response = new ActionResponse();
        $response->setStatus($status);
        $response->setNotify($this->getNotification($notify));

        // Return the action response.
        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 Doctrine\ORM\EntityRepository;
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\AbstractBootstrapController;
23			use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesColumn;
24			use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesWrapper;
25			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesColumnException;
26			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesCSVExporterException;
27			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesEditorException;
28			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesRepositoryException;
29			use WBW\Bundle\JQuery\DataTablesBundle\Exception\UnregisteredDataTablesProviderException;
30			use WBW\Bundle\JQuery\DataTablesBundle\Manager\DataTablesManager;
31			use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesCSVExporterInterface;
32			use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesEditorInterface;
33			use WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesProviderInterface;
34			use WBW\Bundle\JQuery\DataTablesBundle\Repository\DataTablesRepositoryInterface;
35			use WBW\Library\Core\Database\PaginateHelper;
36			use WBW\Library\Core\Model\Response\ActionResponse;
37
38			/**
39			* Abstract jQuery DataTables controller.
40			*
41			* @author webeweb <https://github.com/webeweb/>
42			* @package WBW\Bundle\JQuery\DataTablesBundle\Controller
43			* @abstract
44			*/
45			abstract class AbstractDataTablesController extends AbstractBootstrapController {
46
47			/**
48			* Build a response.
49			*
50			* @param Request $request The request.
51			* @param string $name The provider name.
52			* @param array $output The output.
53			* @return Response Returns the response.
54			*/
55			protected function buildDataTablesResponse(Request $request, $name, ActionResponse $output) {
56
57			// Determines if the request is an XML HTTP request.
58			if (true === $request->isXmlHttpRequest()) {
59
60			// Return the response.
61			return new JsonResponse($output);
62			}
63
64			// Notify the user.
65			switch ($output->getStatus()) {
66
67			case 200:
68			$this->notifySuccess($output->getNotify());
69			break;
70
71			case 404:
72			$this->notifyDanger($output->getNotify());
73			break;
74
75			case 500:
76			$this->notifyWarning($output->getNotify());
77			break;
78			}
79
80			// Return the response.
81			return $this->redirectToRoute("jquery_datatables_index", ["name" => $name]);
82			}
83
84			/**
85			* Export callback.
86			*
87			* @param DataTablesProviderInterface $dtProvider The provider.
88			* @param DataTablesRepositoryInterface $repository The repository.
89			* @param DataTablesCSVExporterInterface $dtExporter The exporter.
90			* @return void
91			*/
92			protected function exportCallback(DataTablesProviderInterface $dtProvider, DataTablesRepositoryInterface $repository, DataTablesCSVExporterInterface $dtExporter) {
93
94			// Get the entities manager.
95			$em = $this->getDoctrine()->getManager();
96
97			// Open the file.
98			$stream = fopen("php://output", "w+");
99
100			// Export the columns.
101			fputcsv($stream, $dtExporter->exportColumns(), ";");
102
103			// Paginates.
104			$total = $repository->dataTablesCountExported($dtProvider);
105			$pages = PaginateHelper::getPagesCount($total, DataTablesRepositoryInterface::REPOSITORY_LIMIT);
106
107			// Handle each page.
108			for ($i = 0; $i < $pages; ++$i) {
109
110			// Get the offset and limit.
111			list($offset, $limit) = PaginateHelper::getPageOffsetAndLimit($i, DataTablesRepositoryInterface::REPOSITORY_LIMIT, $total);
112
113			// Get the export query with offset and limit.
114			$result = $repository->dataTablesExportAll($dtProvider)
115			->setFirstResult($offset)
116			->setMaxResults($limit)
117			->getQuery()
118			->iterate();
119
120			// Handle each entity.
121			while (false !== ($row = $result->next())) {
122
123			// Export the entity.
124			fputcsv($stream, $dtExporter->exportRow($row[0]), ";");
125
126			// Detach the entity to avoid memory consumption.
127			$em->detach($row[0]);
128			}
129			}
130			// Close the file.
131			fclose($stream);
132			}
133
134			/**
135			* Get a column.
136			*
137			* @param DataTableProviderInterface $dtProvider The provider.
138			* @param string $data The data.
139			* @return DataTablesColumn Returns the column.
140			* @throws BadDataTablesColumnException Throws a bad column exception.
141			*/
142			protected function getDataTablesColumn(DataTablesProviderInterface $dtProvider, $data) {
143
144			// Get the column.
145			$dtColumn = $this->getDataTablesWrapper($dtProvider)->getColumn($data);
146
147			// Log a debug trace.
148			$this->getLogger()->debug(sprintf("DataTables controller search for a column with name \"%s\"", $data));
149
150			// Check the column.
151			if (null === $dtColumn) {
152			throw new BadDataTablesColumnException($data);
153			}
154
155			// Log a debug trace.
156			$this->getLogger()->debug(sprintf("DataTables controller found a column with name \"%s\"", $data));
157
158			// Return the column.
159			return $dtColumn;
160			}
161
162			/**
163			* Get a CSV exporter.
164			*
165			* @param DataTablesProviderInterface $dtProvider The provider.
166			* @return DataTablesCSVExporterInterface Returns the CSV exporter.
167			* @throws UnregisteredDataTablesProviderException Throws an unregistered provider exception.
168			* @throws BadDataTablesCSVExporterException Throws a bad CSV exporter exception.
169			*/
170			protected function getDataTablesCSVExporter(DataTablesProviderInterface $dtProvider) {
171
172			// Get the provider.
173			$dtExporter = $dtProvider->getCSVExporter();
174
175			// Log a debug trace.
176			$this->getLogger()->debug(sprintf("DataTables controller search for a CSV exporter with name \"%s\"", $dtProvider->getName()));
177
178			// Check the CSV exporter.
179			if (false === ($dtExporter instanceOf DataTablesCSVExporterInterface)) {
180			throw new BadDataTablesCSVExporterException(null !== $dtExporter ? $dtExporter : "null");
			0 ignored issues – show Documentation introduced 2018-09-10 19:48 UTC by Report Bug Copy Issue Report `null !== $dtExporter ? $dtExporter : 'null'` is of type `string`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
181			}
182
183			// Log a debug trace.
184			$this->getLogger()->debug(sprintf("DataTables controller found a CSV exporter with name \"%s\"", $dtProvider->getName()));
185
186			// Return the exporter.
187			return $dtExporter;
188			}
189
190			/**
191			* Get an editor.
192			*
193			* @param DataTablesProviderInterface $dtProvider The provider.
194			* @return DataTablesEditorInterface Returns the editor.
195			* @throws UnregisteredDataTablesProviderException Throws an unregistered provider exception.
196			* @throws BadDataTablesEditorException Throws a bad editor exception.
197			*/
198			protected function getDataTablesEditor(DataTablesProviderInterface $dtProvider) {
199
200			// Get the editor.
201			$dtEditor = $dtProvider->getEditor();
202
203			// Log a debug trace.
204			$this->getLogger()->debug(sprintf("DataTables controller search for an editor with name \"%s\"", $dtProvider->getName()));
205
206			// Check the CSV exporter.
207			if (false === ($dtEditor instanceOf DataTablesEditorInterface)) {
208			throw new BadDataTablesEditorException(null !== $dtEditor ? $dtEditor : "null");
			0 ignored issues – show Documentation introduced 2018-09-10 19:48 UTC by Report Bug Copy Issue Report `null !== $dtEditor ? $dtEditor : 'null'` is of type `string`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
209			}
210
211			// Log a debug trace.
212			$this->getLogger()->debug(sprintf("DataTables controller found an editor with name \"%s\"", $dtProvider->getName()));
213
214			// Return the exporter.
215			return $dtEditor;
216			}
217
218			/**
219			* Get an entity by id.
220			*
221			* @param DataTablesProviderInterface $dtProvider The provider.
222			* @param integer $id The entity id.
223			* @return object Returns the entity.
224			* @throws BadDataTablesRepositoryException Throws a bad repository exception.
225			* @throws EntityNotFoundException Throws an Entity not found exception.
226			*/
227			protected function getDataTablesEntityById(DataTablesProviderInterface $dtProvider, $id) {
228
229			// Get the repository.
230			$repository = $this->getDataTablesRepository($dtProvider);
231
232			// Log a debug trace.
233			$this->getLogger()->debug(sprintf("DataTables controller search for an entity [%s]", $id));
234
235			// Find and check the entity.
236			$entity = $repository->find($id);
237			if (null === $entity) {
238			throw EntityNotFoundException::fromClassNameAndIdentifier($dtProvider->getEntity(), [$id]);
239			}
240
241			// Log a debug trace.
242			$this->getLogger()->debug(sprintf("DataTables controller found an entity [%s]", $id));
243
244			// Return the entity.
245			return $entity;
246			}
247
248			/**
249			* Get the provider.
250			*
251			* @param string $name The provider name.
252			* @return DataTablesProviderInterface Returns the provider.
253			* @throws UnregisteredDataTablesProviderException Throws an unregistered provider exception.
254			*/
255			protected function getDataTablesProvider($name) {
256
257			// Log a debug trace.
258			$this->getLogger()->debug(sprintf("DataTables controller search for a provider with name \"%s\"", $name));
259
260			// Get the provider.
261			$dtProvider = $this->get(DataTablesManager::SERVICE_NAME)->getProvider($name);
262
263			// Log a debug trace.
264			$this->getLogger()->debug(sprintf("DataTables controller found a provider with name \"%s\"", $name));
265
266			// Return the provider.
267			return $dtProvider;
268			}
269
270			/**
271			* Get a repository.
272			*
273			* @param DataTablesProviderInterface $dtProvider The provider.
274			* @return EntityRepository Returns the repository.
275			* @throws BadDataTablesRepositoryException Throws a bad repository exception.
276			*/
277			protected function getDataTablesRepository(DataTablesProviderInterface $dtProvider) {
278
279			// Log a debug trace.
280			$this->getLogger()->debug(sprintf("DataTables controller search for a repository with name \"%s\"", $dtProvider->getName()));
281
282			// Get the entities manager.
283			$em = $this->getDoctrine()->getManager();
284
285			// Get and check the entities repository.
286			$repository = $em->getRepository($dtProvider->getEntity());
287			if (false === ($repository instanceOf DataTablesRepositoryInterface)) {
288			throw new BadDataTablesRepositoryException($repository);
289			}
290
291			// Return the repository.
292			return $repository;
293			}
294
295			/**
296			* Get a serializer.
297			*
298			* @return Serializer Returns the serializer.
299			*/
300			protected function getDataTablesSerializer() {
301			return new Serializer([new ObjectNormalizer()], [new JsonEncoder()]);
302			}
303
304			/**
305			* Get a wrapper.
306			*
307			* @param DataTablesProviderInterface $dtProvider The provider.
308			* @return DataTablesWrapper Returns the wrapper.
309			*/
310			protected function getDataTablesWrapper(DataTablesProviderInterface $dtProvider) {
311
312			// Initialize the URL.
313			$url = $this->getRouter()->generate("jquery_datatables_index", ["name" => $dtProvider->getName()]);
314
315			// Initialize the wrapper.
316			$dtWrapper = new DataTablesWrapper($dtProvider->getMethod(), $url, $dtProvider->getName());
317			$dtWrapper->getMapping()->setPrefix($dtProvider->getPrefix());
318
319			// Handle each column.
320			foreach ($dtProvider->getColumns() as $dtColumn) {
321
322			// Log a debug trace.
323			$this->getLogger()->debug(sprintf("DataTables provider add a column \"%s\"", $dtColumn->getData()));
324
325			// Add.
326			$dtWrapper->addColumn($dtColumn);
327			}
328
329			// Set the options.
330			if (null !== $dtProvider->getOptions()) {
331			$dtWrapper->setOptions($dtProvider->getOptions());
332			}
333
334			// Return the wrapper.
335			return $dtWrapper;
336			}
337
338			/**
339			* Get the notification.
340			*
341			* @param string $id The notification id.
342			* @return string Returns the notification.
343			*/
344			protected function getNotification($id) {
345			return $this->getTranslator()->trans($id, [], "JQueryDataTablesBundle");
346			}
347
348			/**
349			* Prepare an action response.
350			*
351			* @param int $status The status.
352			* @param string $notify The notify.
353			* @return ActionResponse Returns the action response.
354			*/
355			protected function prepareActionResponse($status, $notify) {
356
357			// Initialize the action response.
358			$response = new ActionResponse();
359			$response->setStatus($status);
360			$response->setNotify($this->getNotification($notify));
361
362			// Return the action response.
363			return $response;
364			}
365
366			}
367

webeweb / jquery-datatables-bundle

Push — master ( e5e4cb...c0714e )

getDataTablesSerializer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like