QuoteController::getToolShortname() - Code Metrics - Inspection of "Move checkEnabled into a new event subscriber, and..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9fe0d2...0e0f1f )

by Sam

created 2017-06-23 05:44 UTC

QuoteController::getToolShortname() A

↳ Parent: QuoteController

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * This file contains only the QuoteController class.
 */

namespace AppBundle\Controller;

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

/**
 * 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.
 */
class QuoteController extends Controller
{

    /**
     * Get the tool's shortname.
     * @return string
     */
    public function getToolShortname()
    {
        return 'bash';
    }

    /**
     * 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")
     *
     * @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 \Symfony\Component\HttpFoundation\RedirectResponse
     */
    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"]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            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 \Symfony\Component\HttpFoundation\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"]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            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 \Symfony\Component\HttpFoundation\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"]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            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"]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            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,
            ]
        );
    }
}


1			<?php
2			/**
3			* This file contains only the QuoteController class.
4			*/
5
6			namespace AppBundle\Controller;
7
8			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
9			use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
10			use Symfony\Component\Routing\Exception\InvalidParameterException;
11			use Symfony\Component\HttpFoundation\Request;
12
13			/**
14			* A quick note: This tool is referred to as "bash" in much of the legacy code base. As such,
15			* the terms "quote" and "bash" are used interchangeably here, so as to not break many conventions.
16			*/
17			class QuoteController extends Controller
18			{
19
20			/**
21			* Get the tool's shortname.
22			* @return string
23			*/
24			public function getToolShortname()
25			{
26			return 'bash';
27			}
28
29			/**
30			* Method for rendering the Bash Main Form.
31			* This method redirects if valid parameters are found, making it a
32			* valid form endpoint as well.
33			*
34			* @param \Symfony\Component\HttpFoundation\Request $request Given by Symfony
35			*
36			* @Route("/bash", name="bash")
37			* @Route("/quote", name="quote")
38			*
39			* @return \Symfony\Component\HttpFoundation\Response
40			*/
41			public function indexAction(Request $request)
42			{
43			// Check to see if the quote is a param. If so,
44			// redirect to the proper route.
45			if ($request->query->get('id') != '') {
46			return $this->redirectToRoute(
47			"quoteID",
48			["id"=>$request->query->get('id')]
49			);
50			}
51
52			// Oterwise render the form.
53			return $this->render(
54			'quote/index.html.twig',
55			[
56			'base_dir' => realpath($this->getParameter('kernel.root_dir').'/..'),
57			'xtPage' => 'bash',
58			'xtPageTitle' => 'tool-bash',
59			'xtSubtitle' => 'tool-bash-desc',
60			]
61			);
62			}
63
64			/**
65			* Method for rendering a random quote.
66			* This should redirect to the /quote/{id} path below
67			*
68			* @Route("/quote/random", name="quoteRandom")
69			* @Route("/bash/random", name="bashRandom")
70			*
71			* @return \Symfony\Component\HttpFoundation\RedirectResponse
72			*/
73			public function randomQuoteAction()
74			{
75			// Choose a random quote by ID.
76			// if we can't find the quotes, return back to the main form with
77			// a flash notice.
78			try {
79			$id = rand(1, sizeof($this->getParameter("quotes")));
80			} catch (InvalidParameterException $e) {
81			$this->addFlash("notice", ["noquotes"]);
			0 ignored issues – show Documentation introduced 2017-04-20 16:49 UTC by Report Bug Copy Issue Report `array('noquotes')` is of type `array<integer,string,{"0":"string"}>`, 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...
82			return $this->redirectToRoute("quote");
83			}
84
85			return $this->redirectToRoute("quoteID", ["id"=>$id]);
86			}
87
88			/**
89			* Method to show all quotes.
90			*
91			* @Route("/quote/all", name="quoteAll")
92			* @Route("/bash/all", name="bashAll")
93			*
94			* @return \Symfony\Component\HttpFoundation\Response
95			*/
96			public function quoteAllAction()
97			{
98			// Load up an array of all the quotes.
99			// if we can't find the quotes, return back to the main form with
100			// a flash notice.
101			try {
102			$quotes = $this->getParameter("quotes");
103			} catch (InvalidParameterException $e) {
104			$this->addFlash("notice", ["noquotes"]);
			0 ignored issues – show Documentation introduced 2017-04-20 16:49 UTC by Report Bug Copy Issue Report `array('noquotes')` is of type `array<integer,string,{"0":"string"}>`, 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...
105			return $this->redirectToRoute("quote");
106			}
107
108			// Render the page.
109			return $this->render(
110			'quote/all.html.twig',
111			[
112			'base_dir' => realpath(
113			$this->getParameter('kernel.root_dir') . '/..'
114			),
115			'xtPage' => 'bash',
116			'quotes' => $quotes,
117			]
118			);
119			}
120
121			/**
122			* Method to render a single quote.
123			*
124			* @param int $id ID of the quote
125			*
126			* @Route("/quote/{id}", name="quoteID")
127			* @Route("/bash/{id}", name="bashID")
128			*
129			* @return \Symfony\Component\HttpFoundation\Response
130			*/
131			public function quoteAction($id)
132			{
133			// Get the singular quote.
134			// if we can't find the quotes, return back to the main form with
135			// a flash notice.
136			try {
137			if (isset($this->getParameter("quotes")[$id])) {
138			$text = $this->getParameter("quotes")[$id];
139			} else {
140			throw new InvalidParameterException("Quote doesn't exist");
141			}
142			} catch (InvalidParameterException $e) {
143			$this->addFlash("notice", ["noquotes"]);
			0 ignored issues – show Documentation introduced 2017-04-19 19:19 UTC by Report Bug Copy Issue Report `array('noquotes')` is of type `array<integer,string,{"0":"string"}>`, 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...
144			return $this->redirectToRoute("quote");
145			}
146
147			// If the text is undefined, that quote doesn't exist.
148			// Redirect back to the main form.
149			if (!isset($text)) {
150			$this->addFlash("notice", ["noquotes"]);
			0 ignored issues – show Documentation introduced 2017-04-19 19:19 UTC by Report Bug Copy Issue Report `array('noquotes')` is of type `array<integer,string,{"0":"string"}>`, 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...
151			return $this->redirectToRoute("quote");
152			}
153
154			// Show the quote.
155			return $this->render(
156			'quote/view.html.twig',
157			[
158			'base_dir' => realpath(
159			$this->getParameter('kernel.root_dir') . '/..'
160			),
161			"xtPage" => "bash",
162			"text" => $text,
163			"id" => $id,
164			]
165			);
166			}
167			}
168

x-tools / xtools

Push — master ( 9fe0d2...0e0f1f )

QuoteController::getToolShortname() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like