WikiController::getWikiPages() - Code Metrics - Inspection of "Integrate SyntaxHighlighter bundle" - webeweb/bootstrap-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4e472a...341a7d )

by WEBEWEB

created 2018-06-23 12:58 UTC

WikiController::getWikiPages() A

↳ Parent: WikiController

Complexity

Conditions	1
Paths	1

Size

Total Lines	54
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	54
rs	9.6716
cc	1
eloc	31
nc	1
nop	0

How to fix Long Method

<?php

/**
 * This file is part of the bootstrap-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\BootstrapBundle\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use WBW\Bundle\BootstrapBundle\Model\WikiPage;
use WBW\Bundle\SyntaxHighlighterBundle\API\SyntaxHighlighterConfig;
use WBW\Bundle\SyntaxHighlighterBundle\API\SyntaxHighlighterDefaults;
use WBW\Bundle\SyntaxHighlighterBundle\Provider\SyntaxHighlighterStringsProvider;

/**
 * Wiki controller.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\BootstrapBundle\Controller
 */
class WikiController extends AbstractBootstrapController {

    /**
     * Get the Syntax Highlighter config.
     *
     * @return SyntaxHighlighterConfig Returns the SyntaxHighlighter config.
     */
    protected function getSyntaxHighlighterConfig() {

        // Get the SyntaxHighlighter strings provider.
        $provider = $this->get(SyntaxHighlighterStringsProvider::SERVICE_NAME);

        // Initialize the SyntaxHighlighter config.
        $config = new SyntaxHighlighterConfig();
        $config->setStrings($provider->getSyntaxHighlighterStrings());

        // Return the SyntaxHighlighter config.
        return $config;
    }

    /**
     * Get the Syntax Highlighter defaults.
     *
     * @return SyntaxHighlighterDefaults Returns the SyntaxHighlighter defaults.
     */
    protected function getSyntaxHighlighterDefaults() {

        // Initialize the SyntaxHighlighter defaults.
        $defaults = new SyntaxHighlighterDefaults();

        // Return the SyntaxHighlighter defaults.
        return $defaults;
    }

    /**
     * Get the wiki pages.
     *
     * @return WikiPage[] Returns the wiki pages.
     */
    public static function getWikiPages() {

        // Initialize the table of contents.
        $tableContents = [];

        // Twig extensions > Code
        $tableContents[] = new WikiPage("twig-extension", "code", "basic-block", "Basic block");
        $tableContents[] = new WikiPage("twig-extension", "code", "inline", "Inline");
        $tableContents[] = new WikiPage("twig-extension", "code", "sample-output", "Sample output");
        $tableContents[] = new WikiPage("twig-extension", "code", "user-input", "User input");
        $tableContents[] = new WikiPage("twig-extension", "code", "variable", "Variable");

        // Twig extensions > Component
        $tableContents[] = new WikiPage("twig-extension", "component", "alert", "Alert");
        $tableContents[] = new WikiPage("twig-extension", "component", "badge", "Badge");
        $tableContents[] = new WikiPage("twig-extension", "component", "button", "Button");
        $tableContents[] = new WikiPage("twig-extension", "component", "glyphicon", "Glyphicon");
        $tableContents[] = new WikiPage("twig-extension", "component", "label", "Label");
        $tableContents[] = new WikiPage("twig-extension", "component", "progress-bar", "Progress bar");

        // Twig extensions > Form
        $tableContents[] = new WikiPage("twig-extension", "form", "button", "Button");

        // Twig extensions > Grid
        $tableContents[] = new WikiPage("twig-extension", "grid", "grid", "Grid");

        // Twig extensions > Image
        $tableContents[] = new WikiPage("twig-extension", "image", "base64", "Base 64");

        // Twig extensions > Plugin
        $tableContents[] = new WikiPage("twig-extension", "plugin", "font-awesome", "Font Awesome");
        $tableContents[] = new WikiPage("twig-extension", "plugin", "jquery-inputmask", "jQuery InputMask");
        $tableContents[] = new WikiPage("twig-extension", "plugin", "material-design-iconic-font", "Material Design Iconic Font");

        // Twig extensions > Table
        $tableContents[] = new WikiPage("twig-extension", "table", "button", "Button");

        // Twig extensions > Typography
        $tableContents[] = new WikiPage("twig-extension", "typography", "bold", "Bold");
        $tableContents[] = new WikiPage("twig-extension", "typography", "deleted", "Deleted");
        $tableContents[] = new WikiPage("twig-extension", "typography", "heading", "Heading");
        $tableContents[] = new WikiPage("twig-extension", "typography", "inserted", "Inserted");
        $tableContents[] = new WikiPage("twig-extension", "typography", "italic", "Italic");
        $tableContents[] = new WikiPage("twig-extension", "typography", "marked", "Marked");
        $tableContents[] = new WikiPage("twig-extension", "typography", "small", "Small");
        $tableContents[] = new WikiPage("twig-extension", "typography", "strikethrough", "Strikethrough");
        $tableContents[] = new WikiPage("twig-extension", "typography", "underlined", "Underlined");

        // Twig extensions > Utility
        $tableContents[] = new WikiPage("twig-extension", "utility", "role-label", "Role label");

        // Return the table of contents.
        return $tableContents;
    }

    /**
     * Displays a wiki page.
     *
     * @param Request $request The request.
     * @param string $category The category.
     * @param string $package The parent.
     * @param string $page The page.
     * @return Response Returns the response.
     */
    public function indexAction(Request $request, $category, $package, $page) {


        // Initialize.
        $wikiPages = self::getWikiPages();
        $wikiPage  = null;

        // Find the wiki page.
        foreach ($wikiPages as $current) {
            if ($category === $current->getCategory() && $package === $current->getPackage() && $page === $current->getPage()) {
                $wikiPage = $current;
                break;
            }
        }

        // Check if the wiki page exists.
        if (null === $wikiPage) {

            // Set the default wiki page.
            $wikiPage = $wikiPages[0];

            // Notify the user.
            $this->notifyDanger("The requested page was not found");
            $this->notifyInfo("You have been redirected to homepage");
        }

        // Set the template.
        $template = [
            "@",
            $wikiPage->getBundle(),
            "/Wiki/",
            $wikiPage->getCategory(),
            "/",
            $wikiPage->getPackage(),
            "/",
            $wikiPage->getPage(),
            ".html.twig",
        ];

        // Returns the response.
        return $this->render(implode("", $template), [
                "syntaxHighlighterConfig"   => $this->getSyntaxHighlighterConfig(),
                "syntaxHighlighterDefaults" => $this->getSyntaxHighlighterDefaults(),
                "wikiPage"                  => $wikiPage,
                "wikiPages"                 => $wikiPages,
        ]);
    }

}


1			<?php
2
3			/**
4			* This file is part of the bootstrap-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\BootstrapBundle\Controller;
13
14			use Symfony\Component\HttpFoundation\Request;
15			use Symfony\Component\HttpFoundation\Response;
16			use WBW\Bundle\BootstrapBundle\Model\WikiPage;
17			use WBW\Bundle\SyntaxHighlighterBundle\API\SyntaxHighlighterConfig;
18			use WBW\Bundle\SyntaxHighlighterBundle\API\SyntaxHighlighterDefaults;
19			use WBW\Bundle\SyntaxHighlighterBundle\Provider\SyntaxHighlighterStringsProvider;
20
21			/**
22			* Wiki controller.
23			*
24			* @author webeweb <https://github.com/webeweb/>
25			* @package WBW\Bundle\BootstrapBundle\Controller
26			*/
27			class WikiController extends AbstractBootstrapController {
28
29			/**
30			* Get the Syntax Highlighter config.
31			*
32			* @return SyntaxHighlighterConfig Returns the SyntaxHighlighter config.
33			*/
34			protected function getSyntaxHighlighterConfig() {
35
36			// Get the SyntaxHighlighter strings provider.
37			$provider = $this->get(SyntaxHighlighterStringsProvider::SERVICE_NAME);
38
39			// Initialize the SyntaxHighlighter config.
40			$config = new SyntaxHighlighterConfig();
41			$config->setStrings($provider->getSyntaxHighlighterStrings());
42
43			// Return the SyntaxHighlighter config.
44			return $config;
45			}
46
47			/**
48			* Get the Syntax Highlighter defaults.
49			*
50			* @return SyntaxHighlighterDefaults Returns the SyntaxHighlighter defaults.
51			*/
52			protected function getSyntaxHighlighterDefaults() {
53
54			// Initialize the SyntaxHighlighter defaults.
55			$defaults = new SyntaxHighlighterDefaults();
56
57			// Return the SyntaxHighlighter defaults.
58			return $defaults;
59			}
60
61			/**
62			* Get the wiki pages.
63			*
64			* @return WikiPage[] Returns the wiki pages.
65			*/
66			public static function getWikiPages() {
67
68			// Initialize the table of contents.
69			$tableContents = [];
70
71			// Twig extensions > Code
72			$tableContents[] = new WikiPage("twig-extension", "code", "basic-block", "Basic block");
73			$tableContents[] = new WikiPage("twig-extension", "code", "inline", "Inline");
74			$tableContents[] = new WikiPage("twig-extension", "code", "sample-output", "Sample output");
75			$tableContents[] = new WikiPage("twig-extension", "code", "user-input", "User input");
76			$tableContents[] = new WikiPage("twig-extension", "code", "variable", "Variable");
77
78			// Twig extensions > Component
79			$tableContents[] = new WikiPage("twig-extension", "component", "alert", "Alert");
80			$tableContents[] = new WikiPage("twig-extension", "component", "badge", "Badge");
81			$tableContents[] = new WikiPage("twig-extension", "component", "button", "Button");
82			$tableContents[] = new WikiPage("twig-extension", "component", "glyphicon", "Glyphicon");
83			$tableContents[] = new WikiPage("twig-extension", "component", "label", "Label");
84			$tableContents[] = new WikiPage("twig-extension", "component", "progress-bar", "Progress bar");
85
86			// Twig extensions > Form
87			$tableContents[] = new WikiPage("twig-extension", "form", "button", "Button");
88
89			// Twig extensions > Grid
90			$tableContents[] = new WikiPage("twig-extension", "grid", "grid", "Grid");
91
92			// Twig extensions > Image
93			$tableContents[] = new WikiPage("twig-extension", "image", "base64", "Base 64");
94
95			// Twig extensions > Plugin
96			$tableContents[] = new WikiPage("twig-extension", "plugin", "font-awesome", "Font Awesome");
97			$tableContents[] = new WikiPage("twig-extension", "plugin", "jquery-inputmask", "jQuery InputMask");
98			$tableContents[] = new WikiPage("twig-extension", "plugin", "material-design-iconic-font", "Material Design Iconic Font");
99
100			// Twig extensions > Table
101			$tableContents[] = new WikiPage("twig-extension", "table", "button", "Button");
102
103			// Twig extensions > Typography
104			$tableContents[] = new WikiPage("twig-extension", "typography", "bold", "Bold");
105			$tableContents[] = new WikiPage("twig-extension", "typography", "deleted", "Deleted");
106			$tableContents[] = new WikiPage("twig-extension", "typography", "heading", "Heading");
107			$tableContents[] = new WikiPage("twig-extension", "typography", "inserted", "Inserted");
108			$tableContents[] = new WikiPage("twig-extension", "typography", "italic", "Italic");
109			$tableContents[] = new WikiPage("twig-extension", "typography", "marked", "Marked");
110			$tableContents[] = new WikiPage("twig-extension", "typography", "small", "Small");
111			$tableContents[] = new WikiPage("twig-extension", "typography", "strikethrough", "Strikethrough");
112			$tableContents[] = new WikiPage("twig-extension", "typography", "underlined", "Underlined");
113
114			// Twig extensions > Utility
115			$tableContents[] = new WikiPage("twig-extension", "utility", "role-label", "Role label");
116
117			// Return the table of contents.
118			return $tableContents;
119			}
120
121			/**
122			* Displays a wiki page.
123			*
124			* @param Request $request The request.
125			* @param string $category The category.
126			* @param string $package The parent.
127			* @param string $page The page.
128			* @return Response Returns the response.
129			*/
130			public function indexAction(Request $request, $category, $package, $page) {
			1 ignored issue – show Unused Code introduced 2018-06-12 20:34 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
131
132			// Initialize.
133			$wikiPages = self::getWikiPages();
134			$wikiPage = null;
135
136			// Find the wiki page.
137			foreach ($wikiPages as $current) {
138			if ($category === $current->getCategory() && $package === $current->getPackage() && $page === $current->getPage()) {
139			$wikiPage = $current;
140			break;
141			}
142			}
143
144			// Check if the wiki page exists.
145			if (null === $wikiPage) {
146
147			// Set the default wiki page.
148			$wikiPage = $wikiPages[0];
149
150			// Notify the user.
151			$this->notifyDanger("The requested page was not found");
152			$this->notifyInfo("You have been redirected to homepage");
153			}
154
155			// Set the template.
156			$template = [
157			"@",
158			$wikiPage->getBundle(),
159			"/Wiki/",
160			$wikiPage->getCategory(),
161			"/",
162			$wikiPage->getPackage(),
163			"/",
164			$wikiPage->getPage(),
165			".html.twig",
166			];
167
168			// Returns the response.
169			return $this->render(implode("", $template), [
170			"syntaxHighlighterConfig" => $this->getSyntaxHighlighterConfig(),
171			"syntaxHighlighterDefaults" => $this->getSyntaxHighlighterDefaults(),
172			"wikiPage" => $wikiPage,
173			"wikiPages" => $wikiPages,
174			]);
175			}
176
177			}
178

webeweb / bootstrap-bundle

Push — master ( 4e472a...341a7d )

WikiController::getWikiPages() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like