QuoteController::quoteAllAction() - Code Metrics - Inspection of "Make internal route names and i18n messages consis..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 35c320...7deb12 )

by MusikAnimal
created 2018-04-21 13:27 UTC
QuoteController::quoteAllAction() A

↳ Parent: QuoteController
Complexity

Conditions	2
Paths	2
Size

Total Lines	21
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	11
nc	2
nop	0
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0
<?php
/**
 * This file contains only the QuoteController class.
 */

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Exception\InvalidParameterException;

/**
 * A quick note: This tool is referred to as "bash" in much of the legacy code base.  As such,
 * the terms "quote" and "bash" are used interchangeably here, so as to not break many conventions.
 *
 * This tool is intentionally disabled in the WMF installation.
 * @codeCoverageIgnore
 */
class QuoteController extends XtoolsController
{

    /**
     * Get the name of the tool's index route.
     * @return string
     * @codeCoverageIgnore
     */
    public function getIndexRoute()
    {
        return 'Quote';
    }

    /**
     * Method for rendering the Bash Main Form.
     * This method redirects if valid parameters are found, making it a
     * valid form endpoint as well.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request Given by Symfony
     *
     * @Route("/bash",  name="Bash")
     * @Route("/quote", name="Quote")
     * @Route("/bash/base.php", name="BashBase")
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function indexAction(Request $request)
    {
        // Check to see if the quote is a param.  If so,
        // redirect to the proper route.
        if ($request->query->get('id') != '') {
            return $this->redirectToRoute(
                "quoteID",
                ["id"=>$request->query->get('id')]
            );
        }

        // Oterwise render the form.
        return $this->render(
            'quote/index.html.twig',
            [
                'base_dir' => realpath($this->getParameter('kernel.root_dir').'/..'),
                'xtPage' => 'bash',
                'xtPageTitle' => 'tool-bash',
                'xtSubtitle' => 'tool-bash-desc',
            ]
        );
    }

    /**
     * Method for rendering a random quote.
     * This should redirect to the /quote/{id} path below
     *
     * @Route("/quote/random", name="QuoteRandom")
     * @Route("/bash/random",  name="BashRandom")
     *
     * @return RedirectResponse
filter:
    dependency_paths: ["lib/*"]
     */
    public function randomQuoteAction()
    {
        // Choose a random quote by ID.
        // if we can't find the quotes, return back to  the main form with
        // a flash notice.
        try {
            $id = rand(1, sizeof($this->getParameter("quotes")));
        } catch (InvalidParameterException $e) {
            $this->addFlash("notice", ["noquotes"]);
            $this->addFlash("notice", /** @scrutinizer ignore-type */ ["noquotes"]);
            return $this->redirectToRoute("quote");
        }

        return $this->redirectToRoute("quoteID", ["id"=>$id]);
    }

    /**
     * Method to show all quotes.
     *
     * @Route("/quote/all", name="QuoteAll")
     * @Route("/bash/all",  name="BashAll")
     *
     * @return Response
     */
    public function quoteAllAction()
    {
        // Load up an array of all the quotes.
        // if we can't find the quotes, return back to  the main form with
        // a flash notice.
        try {
            $quotes = $this->getParameter("quotes");
        } catch (InvalidParameterException $e) {
            $this->addFlash("notice", ["noquotes"]);
            $this->addFlash("notice", /** @scrutinizer ignore-type */ ["noquotes"]);
            return $this->redirectToRoute("quote");
        }

        // Render the page.
        return $this->render(
            'quote/all.html.twig',
            [
                'base_dir' => realpath(
                    $this->getParameter('kernel.root_dir') . '/..'
                ),
                'xtPage' => 'bash',
                'quotes' => $quotes,
            ]
        );
    }

    /**
     * Method to render a single quote.
     *
     * @param int $id ID of the quote
     *
     * @Route("/quote/{id}", name="QuoteID")
     * @Route("/bash/{id}",  name="BashID")
     *
     * @return Response
     */
    public function quoteAction($id)
    {
        // Get the singular quote.
        // if we can't find the quotes, return back to  the main form with
        // a flash notice.
        try {
            if (isset($this->getParameter("quotes")[$id])) {
                $text = $this->getParameter("quotes")[$id];
            } else {
                throw new InvalidParameterException("Quote doesn't exist");
            }
        } catch (InvalidParameterException $e) {
            $this->addFlash("notice", ["noquotes"]);
            $this->addFlash("notice", /** @scrutinizer ignore-type */ ["noquotes"]);
            return $this->redirectToRoute("quote");
        }

        // If the text is undefined, that quote doesn't exist.
        // Redirect back to the main form.
        if (!isset($text)) {
            $this->addFlash("notice", ["noquotes"]);
            return $this->redirectToRoute("quote");
        }

        // Show the quote.
        return $this->render(
            'quote/view.html.twig',
            [
                'base_dir' => realpath(
                    $this->getParameter('kernel.root_dir') . '/..'
                ),
                "xtPage" => "bash",
                "text" => $text,
                "id" => $id,
            ]
        );
    }

    /************************ API endpoints ************************/

    /**
     * Get random quote.
     * @Route("/api/quote/random", name="QuoteApiRandom")
     * @return Response
     * @codeCoverageIgnore
     */
    public function randomQuoteApiAction()
    {
        $this->recordApiUsage('quote/random');

        // Don't show if bash is turned off, but always show for Labs
        // (so quote is in footer but not in nav).
        $isLabs = $this->container->getParameter('app.is_labs');
        if (!$isLabs && !$this->container->getParameter('enable.bash')) {
            return '';
        }
        $quotes = $this->container->getParameter('quotes');
        $id = array_rand($quotes);

        return new JsonResponse(
            [$id => $quotes[$id]],
            Response::HTTP_OK
        );
    }

    /**
     * Get all quotes.
     * @Route("/api/quote/all", name="QuoteApiAll")
     * @return Response
     * @codeCoverageIgnore
     */
    public function allQuotesApiAction()
    {
        $this->recordApiUsage('quote/all');

        // Don't show if bash is turned off, but always show for Labs
        // (so quote is in footer but not in nav).
        $isLabs = $this->container->getParameter('app.is_labs');
        if (!$isLabs && !$this->container->getParameter('enable.bash')) {
            return '';
        }
        $quotes = $this->container->getParameter('quotes');
        $numberedQuotes = [];

        // Number the quotes, since they somehow have significance.
        foreach ($quotes as $index => $quote) {
            $numberedQuotes[(string)$index + 1] = $quote;
        }

        return new JsonResponse($numberedQuotes, Response::HTTP_OK);
    }

    /**
     * Get the quote with the given ID.
     * @Route("/api/quote/{id}", name="QuoteApiQuote", requirements={"id"="\d+"})
     * @param int $id
     * @return Response
     * @codeCoverageIgnore
     */
    public function singleQuotesApiAction($id)
    {
        $this->recordApiUsage('quote/id');

        // Don't show if bash is turned off, but always show for Labs
        // (so quote is in footer but not in nav).
        $isLabs = $this->container->getParameter('app.is_labs');
        if (!$isLabs && !$this->container->getParameter('enable.bash')) {
            return '';
        }
        $quotes = $this->container->getParameter('quotes');

        if (!isset($quotes[$id])) {
            return new JsonResponse(
                [
                    'error' => [
                        'code' => Response::HTTP_NOT_FOUND,
                        'message' => 'No quote found with ID '.$id,
                    ]
                ],
                Response::HTTP_NOT_FOUND
            );
        }

        return new JsonResponse([
            $id => $quotes[$id]
        ], Response::HTTP_OK);
    }
}

x-tools / xtools

Push — master ( 35c320...7deb12 )

QuoteController::quoteAllAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
