MakeFormCommand::addFormMethodToController() - Code Metrics - Inspection of "So this now more or less works in the browser.. (a..." - axyr/silverstripe-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4409a5...8614c9 )

by Martijn van

created 2016-04-18 14:54 UTC

MakeFormCommand::addFormMethodToController() A

↳ Parent: MakeFormCommand

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php


use Symfony\Component\Console\Input\InputOption;

class MakeFormCommand extends MakeCommand
namespace YourVendor;

class YourClass { }
{
    /**
     * @var string
     */
    protected $name = 'make:form';

    /**
     * @var string
     */
    protected $description = 'Create a new Form class and optional template';

    protected function writeFile($target, $class)
    {
        parent::writeFile($target, $class);

        if ($controller = $this->option('controller')) {
            $filePath = $this->findControllerFilePath($controller);
            if($filePath !== false) {
                $this->addFormMethodToController($controller, $class);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $content = file_get_contents($filePath);

                $content = $this->addFormMethodToController($content, $class);
                $this->info($class . ' method added to ' , $controller);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $content = $this->addAllowedActionsToController($content, $class);
                $this->warn('Adding allowed_actions not supported yet');

                file_put_contents($filePath, $content);
            }
        }
    }

    /**
     * @param string $content
     * @param string $formClass
     * @return string
     */
    protected function addFormMethodToController($content, $formClass)
    {
        if(!Str::contains($content, "function $formClass(")) {
            $methodStub  = $this->getFormMethodStub($formClass);
            $replacement = $methodStub . "\n}";
            if($methodStub) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $content = Str::replaceLast('}', $replacement, $content);
            }
        }
        return $content;
    }

    /**
     * @param string $content
     * @param string $formClass
     * @return string
     */
    protected function addAllowedActionsToController($content, $formClass)

    {
        $allowedActions = 'private static $allowed_actions';

        if(!Str::contains($content, $allowedActions)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

        }

        return $content;
    }

    /**
     * @param $controller
     * @return bool|string
     */
    protected function findControllerFilePath($controller)
    {
        $controller = strtolower($controller);
        $classes    = SS_ClassLoader::instance()->getManifest()->getClasses();
        $filePath   = isset($classes[$controller]) ? $classes[$controller] : '';

        if(!is_file($filePath)) {
            $this->error("$filePath does not exist");
            return false;
        }

        return $filePath;
    }

    protected function getFormMethodStub($formClass)
    {
        $file = $this->getStubFilePath('ControllerFormMethods');

        if(is_file($file)) {
            return str_replace('DummyClass', $formClass, file_get_contents($file));
        }
    }

    /**
     * @return array
     */
    protected function getOptions()
    {
        $options = parent::getOptions();
        $options[] = ['template', 't', InputOption::VALUE_NONE, 'Create a custom template for this Form'];
        $options[] = ['controller', 'C', InputOption::VALUE_REQUIRED, 'Add FormMethod and allowed actions to the given Controller'];
        return $options;
    }
}


1			<?php
2
3
4			use Symfony\Component\Console\Input\InputOption;
5
6			class MakeFormCommand extends MakeCommand
			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...
7			{
8			/**
9			* @var string
10			*/
11			protected $name = 'make:form';
12
13			/**
14			* @var string
15			*/
16			protected $description = 'Create a new Form class and optional template';
17
18			protected function writeFile($target, $class)
19			{
20			parent::writeFile($target, $class);
21
22			if ($controller = $this->option('controller')) {
23			$filePath = $this->findControllerFilePath($controller);
24			if($filePath !== false) {
25			$this->addFormMethodToController($controller, $class);
			0 ignored issues – show Bug introduced 2016-04-18 14:57 UTC by Report Bug Copy Issue Report It seems like `$controller` defined by `$this->option('controller')` on line `22` can also be of type `array`; however, `MakeFormCommand::addFormMethodToController()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
26			$content = file_get_contents($filePath);
27
28			$content = $this->addFormMethodToController($content, $class);
29			$this->info($class . ' method added to ' , $controller);
			0 ignored issues – show Bug introduced 2016-04-18 14:57 UTC by Report Bug Copy Issue Report It seems like `$controller` defined by `$this->option('controller')` on line `22` can also be of type `array`; however, `SilverstripeCommand::info()` does only seem to accept `null\|integer\|string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
30			$content = $this->addAllowedActionsToController($content, $class);
31			$this->warn('Adding allowed_actions not supported yet');
32
33			file_put_contents($filePath, $content);
34			}
35			}
36			}
37
38			/**
39			* @param string $content
40			* @param string $formClass
41			* @return string
42			*/
43			protected function addFormMethodToController($content, $formClass)
44			{
45			if(!Str::contains($content, "function $formClass(")) {
46			$methodStub = $this->getFormMethodStub($formClass);
47			$replacement = $methodStub . "\n}";
48			if($methodStub) {
			0 ignored issues – show Bug Best Practice introduced 2016-04-18 14:57 UTC by Report Bug Copy Issue Report The expression `$methodStub` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
49			$content = Str::replaceLast('}', $replacement, $content);
50			}
51			}
52			return $content;
53			}
54
55			/**
56			* @param string $content
57			* @param string $formClass
58			* @return string
59			*/
60			protected function addAllowedActionsToController($content, $formClass)
			0 ignored issues – show Unused Code introduced 2016-04-18 14:57 UTC by Report Bug Copy Issue Report The parameter `$formClass` 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...
61			{
62			$allowedActions = 'private static $allowed_actions';
63
64			if(!Str::contains($content, $allowedActions)) {
			0 ignored issues – show Unused Code introduced 2016-04-18 14:57 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
65
66			}
67
68			return $content;
69			}
70
71			/**
72			* @param $controller
73			* @return bool\|string
74			*/
75			protected function findControllerFilePath($controller)
76			{
77			$controller = strtolower($controller);
78			$classes = SS_ClassLoader::instance()->getManifest()->getClasses();
79			$filePath = isset($classes[$controller]) ? $classes[$controller] : '';
80
81			if(!is_file($filePath)) {
82			$this->error("$filePath does not exist");
83			return false;
84			}
85
86			return $filePath;
87			}
88
89			protected function getFormMethodStub($formClass)
90			{
91			$file = $this->getStubFilePath('ControllerFormMethods');
92
93			if(is_file($file)) {
94			return str_replace('DummyClass', $formClass, file_get_contents($file));
95			}
96			}
97
98			/**
99			* @return array
100			*/
101			protected function getOptions()
102			{
103			$options = parent::getOptions();
104			$options[] = ['template', 't', InputOption::VALUE_NONE, 'Create a custom template for this Form'];
105			$options[] = ['controller', 'C', InputOption::VALUE_REQUIRED, 'Add FormMethod and allowed actions to the given Controller'];
106			return $options;
107			}
108			}
109

axyr / silverstripe-console

Push — master ( 4409a5...8614c9 )

MakeFormCommand::addFormMethodToController() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like