ConsoleController::callFromConsole() - Code Metrics - Inspection of "remove generated test command" - axyr/silverstripe-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8c3306...57acb7 )

by Martijn van

created 2016-04-18 13:05 UTC

ConsoleController::callFromConsole() A

↳ Parent: ConsoleController

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	7
rs	9.4285
cc	1
eloc	3
nc	1
nop	0

<?php

use SensioLabs\AnsiConverter\AnsiToHtmlConverter;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class ConsoleController
 * The Central Command Access Point and Bootstrapper.
 */
class ConsoleController extends Controller
namespace YourVendor;

class YourClass { }
{
    /**
     * @var array
     */
    private static $allowed_actions = [

        'publish',
    ];

    /**
     * @var SilverstripeApplication
     */
    protected $application;

    public function init()
    {
        parent::init();

        $this->application = new SilverstripeApplication();
    }

    public function index(SS_HTTPRequest $request)
    {
        /**
         * Lets be clear when calling commands
         */
        ini_set('display_errors', 1);

        if(!Director::is_cli()) {
            if(!Permission::check("ADMIN")) {
                return Security::permissionFailure();
            }
            return $this->callFromBrowser($request);
        }

        return $this->callFromConsole();
    }

    protected function callFromConsole()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // remove the framework/cli-script.php argument
        array_shift($_SERVER['argv']);

        $this->application->run(new ArgvInput($_SERVER['argv']), new ConsoleOutput());
    }

    protected function callFromBrowser(SS_HTTPRequest $request)
    {
        $input = new ArrayInput(array(
            'command' => $request->param('ID')
        ));

        $output = new BufferedOutput(
            OutputInterface::VERBOSITY_NORMAL,
            true // true for decorated
        );
        $this->application->run($input, $output);

        // return the output
        $converter = new AnsiToHtmlConverter();
        $content = $output->fetch();
        
        return ['ConsoleOutput' => $converter->convert($content)];
    }
}


1			<?php
2
3			use SensioLabs\AnsiConverter\AnsiToHtmlConverter;
4			use Symfony\Component\Console\Application;
5			use Symfony\Component\Console\Input\ArgvInput;
6			use Symfony\Component\Console\Input\ArrayInput;
7			use Symfony\Component\Console\Output\BufferedOutput;
8			use Symfony\Component\Console\Output\ConsoleOutput;
9			use Symfony\Component\Console\Output\OutputInterface;
10
11			/**
12			* Class ConsoleController
13			* The Central Command Access Point and Bootstrapper.
14			*/
15			class ConsoleController extends Controller
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-17 01:01 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
16			{
17			/**
18			* @var array
19			*/
20			private static $allowed_actions = [
			0 ignored issues – show Comprehensibility introduced 2016-04-17 01:01 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-04-17 01:01 UTC by Report Bug Copy Issue Report The property `$allowed_actions` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
21			'publish',
22			];
23
24			/**
25			* @var SilverstripeApplication
26			*/
27			protected $application;
28
29			public function init()
30			{
31			parent::init();
32
33			$this->application = new SilverstripeApplication();
34			}
35
36			public function index(SS_HTTPRequest $request)
37			{
38			/**
39			* Lets be clear when calling commands
40			*/
41			ini_set('display_errors', 1);
42
43			if(!Director::is_cli()) {
44			if(!Permission::check("ADMIN")) {
45			return Security::permissionFailure();
46			}
47			return $this->callFromBrowser($request);
48			}
49
50			return $this->callFromConsole();
51			}
52
53			protected function callFromConsole()
			0 ignored issues – show Coding Style introduced 2016-04-18 13:08 UTC by Report Bug Copy Issue Report `callFromConsole` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
54			{
55			// remove the framework/cli-script.php argument
56			array_shift($_SERVER['argv']);
57
58			$this->application->run(new ArgvInput($_SERVER['argv']), new ConsoleOutput());
59			}
60
61			protected function callFromBrowser(SS_HTTPRequest $request)
62			{
63			$input = new ArrayInput(array(
64			'command' => $request->param('ID')
65			));
66
67			$output = new BufferedOutput(
68			OutputInterface::VERBOSITY_NORMAL,
69			true // true for decorated
70			);
71			$this->application->run($input, $output);
72
73			// return the output
74			$converter = new AnsiToHtmlConverter();
75			$content = $output->fetch();
76
77			return ['ConsoleOutput' => $converter->convert($content)];
78			}
79			}
80

axyr / silverstripe-console

Push — master ( 8c3306...57acb7 )

ConsoleController::callFromConsole() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like