DataTablesController::buildResponse() - Code Metrics - Inspection of "Complete functional tests" - webeweb/jquery-datatables-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5e4a0b...f1c454 )

by WEBEWEB

created 2018-06-16 08:34 UTC

DataTablesController::buildResponse() B

↳ Parent: DataTablesController

Complexity

Conditions	5
Paths	5

Size

Total Lines	25
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	8.439
c	0
b	0
f	0
cc	5
eloc	14
nc	5
nop	3

<?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\DBAL\Exception\ForeignKeyConstraintViolationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesResponse;
use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesRepositoryException;
use WBW\Bundle\JQuery\DataTablesBundle\Exception\UnregisteredDataTablesProviderException;
use WBW\Bundle\JQuery\DataTablesBundle\Repository\DataTablesRepositoryInterface;

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

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

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

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

        // Notify the user.
        switch ($output["status"]) {
            case 200:
                $this->notifySuccess($output["notify"]);
                break;
            case 404:
                $this->notifyDanger($output["notify"]);
                break;
            case 500:
                $this->notifyWarning($output["notify"]);
                break;
        }

        // Return the response.
        return $this->redirectToRoute("jquery_datatables_index", ["name" => $name]);
    }

    /**
     * Delete an existing entity.
     *
     * @param Request $request The request.
     * @param string $name The provider name.
     * @param string $id The entity id.
     * @throws UnregisteredDataTablesProviderException Throws an unregistered DataTables provider exception.
     * @throws BadDataTablesRepositoryException Throws a bad DataTables repository exception.
     */
    public function deleteAction(Request $request, $name, $id) {

        // Get the provider.
        $dtProvider = $this->getDataTablesProvider($name);

        // 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);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        // Initialize the output.
        $output = [
            "status" => null,
            "notify" => null,
        ];

        // Get and check the entity.
        $entity = $repository->find($id);
        if (null === $entity) {

            // Set the output.
            $output["status"] = 404;
            $output["notify"] = $this->getNotification("DataTablesController.deleteAction.danger");

            // Return the response.
            return $this->buildResponse($request, $name, $output);
        }

        try {

            // Delete the entity.
            $em->remove($entity);
            $em->flush();

            // Set the output.
            $output["status"] = 200;
            $output["notify"] = $this->getNotification("DataTablesController.deleteAction.success");
        } catch (ForeignKeyConstraintViolationException $ex) {

            // Log a debug trace.
            $this->getLogger()->debug(sprintf("%s:%s %s", $ex->getErrorCode(), $ex->getSQLState(), $ex->getMessage()));

            // Set the output.
            $output["status"] = 500;
            $output["notify"] = $this->getNotification("DataTablesController.deleteAction.warning");
        }

        // Return the response.
        return $this->buildResponse($request, $name, $output);
    }

    /**
     * Lists all entities.
     *
     * @param Request $request The request.
     * @param string $name The provider name.
     * @return Response Returns the response.
     * @throws UnregisteredDataTablesProviderException Throws an unregistered DataTables provider exception.
     * @throws BadDataTablesRepositoryException Throws a bad DataTables repository exception.
     */
    public function indexAction(Request $request, $name) {

        // Get the provider.
        $dtProvider = $this->getDataTablesProvider($name);

        // Get the wrapper.
        $dtWrapper = $this->getDataTablesWrapper($dtProvider);

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

            // Initialize the default view.
            $dtView = "@JQueryDataTables/DataTables/index.html.twig";

            // Check the provider view.
            if (null !== $dtProvider->getView()) {
                $dtView = $dtProvider->getView();
            }

            // Return the response.
            return $this->render($dtView, [
                    "dtWrapper" => $dtWrapper,
            ]);
        }

        // 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);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        // Parse the request.
        $dtWrapper->parse($request);

        //
        $filtered = $repository->dataTablesCountFiltered($dtWrapper);
        $total    = $repository->dataTablesCountTotal($dtWrapper);
        $entities = $repository->dataTablesFindAll($dtWrapper);

        // Set the response.
        $dtWrapper->getResponse()->setRecordsFiltered($filtered);
        $dtWrapper->getResponse()->setRecordsTotal($total);

        // Handle each entity.
        foreach ($entities as $entity) {

            // Count the rows.
            $rows = $dtWrapper->getResponse()->countRows();

            // Create a row.
            $dtWrapper->getResponse()->addRow();

            // Render each optional parameters.
            foreach (DataTablesResponse::dtRow() as $dtRow) {
                $dtWrapper->getResponse()->setRow($dtRow, $dtProvider->renderRow($dtRow, $entity, $rows));
            }

            // Render each column.
            foreach ($dtWrapper->getColumns() as $dtColumn) {
                $dtWrapper->getResponse()->setRow($dtColumn->getData(), $dtProvider->renderColumn($dtColumn, $entity));
            }
        }

        // Return the response.
        return new Response(json_encode($dtWrapper->getResponse()));
    }

}


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\DBAL\Exception\ForeignKeyConstraintViolationException;
15			use Symfony\Component\HttpFoundation\Request;
16			use Symfony\Component\HttpFoundation\Response;
17			use WBW\Bundle\JQuery\DataTablesBundle\API\DataTablesResponse;
18			use WBW\Bundle\JQuery\DataTablesBundle\Exception\BadDataTablesRepositoryException;
19			use WBW\Bundle\JQuery\DataTablesBundle\Exception\UnregisteredDataTablesProviderException;
20			use WBW\Bundle\JQuery\DataTablesBundle\Repository\DataTablesRepositoryInterface;
21
22			/**
23			* DataTables controller.
24			*
25			* @author webeweb <https://github.com/webeweb/>
26			* @package WBW\Bundle\JQuery\DataTablesBundle\Controller
27			*/
28			class DataTablesController extends AbstractDataTablesController {
29
30			/**
31			* Build a response.
32			*
33			* @param Request $request The request.
34			* @param string $name The provider name.
35			* @param array $output The output.
36			* @return Response Return the response.
37			*/
38			protected function buildResponse(Request $request, $name, array $output) {
39
40			// Determines if the request is an XML HTTP request.
41			if (true === $request->isXmlHttpRequest()) {
42
43			// Return the response.
44			return new Response(json_encode($output));
45			}
46
47			// Notify the user.
48			switch ($output["status"]) {
49			case 200:
50			$this->notifySuccess($output["notify"]);
51			break;
52			case 404:
53			$this->notifyDanger($output["notify"]);
54			break;
55			case 500:
56			$this->notifyWarning($output["notify"]);
57			break;
58			}
59
60			// Return the response.
61			return $this->redirectToRoute("jquery_datatables_index", ["name" => $name]);
62			}
63
64			/**
65			* Delete an existing entity.
66			*
67			* @param Request $request The request.
68			* @param string $name The provider name.
69			* @param string $id The entity id.
70			* @throws UnregisteredDataTablesProviderException Throws an unregistered DataTables provider exception.
71			* @throws BadDataTablesRepositoryException Throws a bad DataTables repository exception.
72			*/
73			public function deleteAction(Request $request, $name, $id) {
74
75			// Get the provider.
76			$dtProvider = $this->getDataTablesProvider($name);
77
78			// Get the entities manager.
79			$em = $this->getDoctrine()->getManager();
80
81			// Get and check the entities repository.
82			$repository = $em->getRepository($dtProvider->getEntity());
83			if (false === ($repository instanceOf DataTablesRepositoryInterface)) {
84			throw new BadDataTablesRepositoryException($repository);
			0 ignored issues – show Documentation introduced 2018-06-16 08:35 UTC by Report Bug Copy Issue Report `$repository` is of type `object<Doctrine\Common\P...tence\ObjectRepository>`, but the function expects a `string`. 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...
85			}
86
87			// Initialize the output.
88			$output = [
89			"status" => null,
90			"notify" => null,
91			];
92
93			// Get and check the entity.
94			$entity = $repository->find($id);
95			if (null === $entity) {
96
97			// Set the output.
98			$output["status"] = 404;
99			$output["notify"] = $this->getNotification("DataTablesController.deleteAction.danger");
100
101			// Return the response.
102			return $this->buildResponse($request, $name, $output);
103			}
104
105			try {
106
107			// Delete the entity.
108			$em->remove($entity);
109			$em->flush();
110
111			// Set the output.
112			$output["status"] = 200;
113			$output["notify"] = $this->getNotification("DataTablesController.deleteAction.success");
114			} catch (ForeignKeyConstraintViolationException $ex) {
115
116			// Log a debug trace.
117			$this->getLogger()->debug(sprintf("%s:%s %s", $ex->getErrorCode(), $ex->getSQLState(), $ex->getMessage()));
118
119			// Set the output.
120			$output["status"] = 500;
121			$output["notify"] = $this->getNotification("DataTablesController.deleteAction.warning");
122			}
123
124			// Return the response.
125			return $this->buildResponse($request, $name, $output);
126			}
127
128			/**
129			* Lists all entities.
130			*
131			* @param Request $request The request.
132			* @param string $name The provider name.
133			* @return Response Returns the response.
134			* @throws UnregisteredDataTablesProviderException Throws an unregistered DataTables provider exception.
135			* @throws BadDataTablesRepositoryException Throws a bad DataTables repository exception.
136			*/
137			public function indexAction(Request $request, $name) {
138
139			// Get the provider.
140			$dtProvider = $this->getDataTablesProvider($name);
141
142			// Get the wrapper.
143			$dtWrapper = $this->getDataTablesWrapper($dtProvider);
144
145			// Check if the request is an XML HTTP request.
146			if (false === $request->isXmlHttpRequest()) {
147
148			// Initialize the default view.
149			$dtView = "@JQueryDataTables/DataTables/index.html.twig";
150
151			// Check the provider view.
152			if (null !== $dtProvider->getView()) {
153			$dtView = $dtProvider->getView();
154			}
155
156			// Return the response.
157			return $this->render($dtView, [
158			"dtWrapper" => $dtWrapper,
159			]);
160			}
161
162			// Get the entities manager.
163			$em = $this->getDoctrine()->getManager();
164
165			// Get and check the entities repository.
166			$repository = $em->getRepository($dtProvider->getEntity());
167			if (false === ($repository instanceOf DataTablesRepositoryInterface)) {
168			throw new BadDataTablesRepositoryException($repository);
			0 ignored issues – show Documentation introduced 2018-06-16 08:35 UTC by Report Bug Copy Issue Report `$repository` is of type `object<Doctrine\Common\P...tence\ObjectRepository>`, but the function expects a `string`. 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...
169			}
170
171			// Parse the request.
172			$dtWrapper->parse($request);
173
174			//
175			$filtered = $repository->dataTablesCountFiltered($dtWrapper);
176			$total = $repository->dataTablesCountTotal($dtWrapper);
177			$entities = $repository->dataTablesFindAll($dtWrapper);
178
179			// Set the response.
180			$dtWrapper->getResponse()->setRecordsFiltered($filtered);
181			$dtWrapper->getResponse()->setRecordsTotal($total);
182
183			// Handle each entity.
184			foreach ($entities as $entity) {
185
186			// Count the rows.
187			$rows = $dtWrapper->getResponse()->countRows();
188
189			// Create a row.
190			$dtWrapper->getResponse()->addRow();
191
192			// Render each optional parameters.
193			foreach (DataTablesResponse::dtRow() as $dtRow) {
194			$dtWrapper->getResponse()->setRow($dtRow, $dtProvider->renderRow($dtRow, $entity, $rows));
195			}
196
197			// Render each column.
198			foreach ($dtWrapper->getColumns() as $dtColumn) {
199			$dtWrapper->getResponse()->setRow($dtColumn->getData(), $dtProvider->renderColumn($dtColumn, $entity));
200			}
201			}
202
203			// Return the response.
204			return new Response(json_encode($dtWrapper->getResponse()));
205			}
206
207			}
208

webeweb / jquery-datatables-bundle

Push — master ( 5e4a0b...f1c454 )

DataTablesController::buildResponse() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like