Examples::getTwocolumn() - Code Metrics - Inspection of "add the theme trait back in; use the theme engine..." - Erdiko/erdiko - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — erdiko2 ( bc4546...cc200f )

by John

created 2017-08-08 19:14 UTC

Examples::getTwocolumn() A

↳ Parent: Examples

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	9
Ratio	100 %

Importance

Changes

Metric	Value
dl	9
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	3

<?php
namespace app\controllers;

class Examples extends \erdiko\controllers\Web
{
    use \erdiko\theme\traits\Controller; // Add theme engine suport (for convenience)

    public function get($request, $response, $args)

    {
        // $this->container->logger->debug("examples");

        $view = 'examples/list.html';

        // Get erdiko config, this gets application.json and loads the theme specified
        // $themeData = \erdiko\theme\Config::get();

        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        // $themeData['args'] = $args; // optional


        $themeData['page'] = [
            'title' => "Erdiko Web Example",
            'hello' => "world"
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getOnecolumn($request, $response, $args)

    {
        $this->container->logger->debug("route: /config");
        $view = 'layouts/1column.html';
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['page']['title'] = "1 Column Layout";

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getTwocolumn($request, $response, $args)

    {
        $this->container->logger->debug("route: /config");
        $view = 'layouts/2column.html';
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['page']['title'] = "2 Column Layout";

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getThreecolumn($request, $response, $args)

    {
        $this->container->logger->debug("route: /config");
        $view = 'layouts/3column.html';
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['page']['title'] = "3 Column Layout";

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getJohn($request, $response, $args)

    {
        $view = 'pages/example.html';

        // Get erdiko config, this gets application.json and loads the theme specified
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['args'] = $args; // optional
        $themeData['page'] = [
            'title' => "Erdiko Web Example"
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getMarkup($request, $response, $args)

    {
        $view = 'examples/markup.html';

        // Get erdiko config, this gets application.json and loads the theme specified
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['args'] = $args; // optional
        $themeData['page'] = [
            'title' => "Markup Example"
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getCarousel($request, $response, $args)

    {
        $view = 'examples/carousel.html';

        // Get erdiko config, this gets application.json and loads the theme specified
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['page'] = [
            'title' => "Fullpage Example",
            'description' => "This is the description of the page."
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }

    /**
     * Leverage the theme trait to easily add content to an action
     */
    public function getTheme($request, $response, $args)
    {
        $this->getThemeEngine();
        $this->theme->title = "Theme Engine Example";
        $this->theme->description = "This page is rendered using the erdiko theme engine.
            \\erdiko\\theme\\Engine";

        return $this->render($response, null, $theme);

    }

    /**
     * Alternative way to use the theme Engine (explicit)
     * In this approach it does not rely on the theme trait
     */
    public function getTheme2($request, $response, $args)
    {
        $theme = new \erdiko\theme\Engine( $this->container->get('settings')['theme'] );

        $theme->title = "Theme Engine Example";
        $theme->description = "This page is rendered with the erdiko theme engine.
            It does not leverage the erdiko theme trait.
            \\erdiko\\theme\\Engine";

        return $this->container->theme->render($response, $theme->getDefaultView(), $theme->toArray());
        // return $this->render($response, null, $theme);

    }

    public function getFlash($request, $response, $args)
    {
        $view = 'page.html';

        // Add some flash messages
        $this->container->flash->addMessage('success', 'This is a success message');
        $this->container->flash->addMessage('info', 'This is an info message');
        $this->container->flash->addMessage('warning', 'This is a warning message');
        $this->container->flash->addMessage('danger', 'This is a danger (error) message');

        // Get erdiko config, this gets application.json and loads the theme specified
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['args'] = $args;
        $themeData['page'] = [
            'title' => "Flash Message Example"
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getGrid($request, $response, $args)
    {
        $this->container->logger->debug("/controller");
        $view = 'examples/grid.html';

        // Get erdiko config, this gets application.json and loads the theme specified
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        // $this->container->logger->debug("config: ".print_r($config, true));


        // Generate data for grid
        $item = [
            'url' => "#",
            'image' => "/images/grid-item.png",
            'name' => "Item"
        ];
        $items = array();
        $max = (int)$args['param'];
        $this->container->logger->debug("param: ".$max);

        for($i = 0; $i < $max; $i++) {

            $item['name'] = "Item $i";
            $items[] = $item;
        }

        $themeData['page'] = [
            'title' => "Grid Example",
            'items' => $items
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getFullpage($request, $response, $args)

    {
        $view = 'fullpage.html';

        // Get erdiko config, this gets application.json and loads the theme specified
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $themeData['page'] = [
            'title' => "Fullpage Example",
            'description' => "This is the description of the page."
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }

    public function getException($request, $response, $args)

    {
        $view = 'page.html';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        throw new \Exception("This is an exception");

        // Get erdiko config, this gets application.json and loads the theme specified
        $themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        $themeData['page'] = [
            'title' => "Fullpage Example",
            'description' => "This is the description of the page."
            ];

        return $this->container->theme->render($response, $view, $themeData);
    }
}


1		<?php
2		namespace app\controllers;
3
4		class Examples extends \erdiko\controllers\Web
5		{
6		use \erdiko\theme\traits\Controller; // Add theme engine suport (for convenience)
7
8	View Code Duplication	public function get($request, $response, $args)
		0 ignored issues – show Duplication introduced 2017-08-08 19:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
9		{
10		// $this->container->logger->debug("examples");
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-08 19:18 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
11		$view = 'examples/list.html';
12
13		// Get erdiko config, this gets application.json and loads the theme specified
14		// $themeData = \erdiko\theme\Config::get();
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-08 19:18 UTC by Report Bug Copy Issue Report `46%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
15		$themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-08-08 19:18 UTC by Report Bug Copy Issue Report `$themeData` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$themeData = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
16		// $themeData['args'] = $args; // optional
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-03-31 01:52 UTC by Report Bug Copy Issue Report `55%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
17
18		$themeData['page'] = [
19		'title' => "Erdiko Web Example",
20		'hello' => "world"
21		];
22
23		return $this->container->theme->render($response, $view, $themeData);
24		}
25
26	View Code Duplication	public function getOnecolumn($request, $response, $args)
		0 ignored issues – show Duplication introduced 2017-08-08 19:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
27		{
28		$this->container->logger->debug("route: /config");
29		$view = 'layouts/1column.html';
30		$themeData['theme'] = \erdiko\theme\Config::get($this->container->get('settings')['theme']);
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-08-08 19:18 UTC by Report Bug Copy Issue Report `$themeData` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$themeData = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
31		$themeData['page']['title'] = "1 Column Layout";
32
33		return $this->container->theme->render($response, $view, $themeData);

Erdiko / erdiko

Push — erdiko2 ( bc4546...cc200f )

Examples::getTwocolumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like