GenericGenerator::code() - Code Metrics - Inspection of "Added comments block" - SamsonPHP/generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2a5486...81459b )

by Vitaly

created 2016-09-03 10:05 UTC

GenericGenerator::code() A

↳ Parent: GenericGenerator

Complexity

Conditions	3
Paths	4

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php declare(strict_types = 1);
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 03.09.16 at 11:37
 */
namespace samsonphp\generator;

/**
 * Class GenericGenerator
 *
 * @author Vitaly Egorov <[email protected]>
 */
class GenericGenerator extends AbstractGenerator
{
    /** @var ClassGenerator[] Collection of classes */
    protected $classes = [];

    /** @var FunctionGenerator[] Collection of functions */
    protected $functions = [];

    /**
     * Set function.
     *
     * @param string $name Function
     * @param bool   $isStatic Flag that function is static
     *
     * @return FunctionGenerator New function generator instance
     */
    public function defFunction(string $name, bool $isStatic = false) : FunctionGenerator
    {
        return $this->functions[] = new FunctionGenerator($this, $name, $isStatic);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Set static function.
     *
     * @param string $name Function
     *
     * @return FunctionGenerator New function generator instance
     */
    public function defStaticFunction(string $name) : FunctionGenerator
    {
        return $this->defFunction($name, false);
    }

    /**
     * Set class.
     *
     * @param string $name Class name
     *
     * @return ClassGenerator
     */
    public function defClass(string $name) : ClassGenerator
    {
        return $this->classes[] = new ClassGenerator($this, $name);
    }

    /**
     * Generate code.
     *
     * @param int $indentation Code level
     *
     * @return string Generated code
     */
    public function code($indentation = 0)
    {
        foreach ($this->classes as $classGenerator) {
            $this->code[] = $classGenerator->code($indentation);
        }

        foreach ($this->functions as $functionGenerator) {
            $this->code[] = $functionGenerator->code($indentation);
        }

        return implode("\n".$this->indentation($indentation), $this->code);
    }
}


1			<?php declare(strict_types = 1);
2			/**
3			* Created by Vitaly Iegorov <[email protected]>.
4			* on 03.09.16 at 11:37
5			*/
6			namespace samsonphp\generator;
7
8			/**
9			* Class GenericGenerator
10			*
11			* @author Vitaly Egorov <[email protected]>
12			*/
13			class GenericGenerator extends AbstractGenerator
14			{
15			/** @var ClassGenerator[] Collection of classes */
16			protected $classes = [];
17
18			/** @var FunctionGenerator[] Collection of functions */
19			protected $functions = [];
20
21			/**
22			* Set function.
23			*
24			* @param string $name Function
25			* @param bool $isStatic Flag that function is static
26			*
27			* @return FunctionGenerator New function generator instance
28			*/
29			public function defFunction(string $name, bool $isStatic = false) : FunctionGenerator
30			{
31			return $this->functions[] = new FunctionGenerator($this, $name, $isStatic);
			0 ignored issues – show Documentation introduced 2016-09-03 10:08 UTC by Report Bug Copy Issue Report `$this` is of type `this<samsonphp\generator\GenericGenerator>`, 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... Documentation introduced 2016-09-03 10:08 UTC by Report Bug Copy Issue Report `$name` is of type `string`, but the function expects a `null\|object<samsonphp\generator\GenericGenerator>`. 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... Unused Code introduced 2016-09-03 10:08 UTC by Report Bug Copy Issue Report The call to `FunctionGenerator::__construct()` has too many arguments starting with `$isStatic`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
32			}
33
34			/**
35			* Set static function.
36			*
37			* @param string $name Function
38			*
39			* @return FunctionGenerator New function generator instance
40			*/
41			public function defStaticFunction(string $name) : FunctionGenerator
42			{
43			return $this->defFunction($name, false);
44			}
45
46			/**
47			* Set class.
48			*
49			* @param string $name Class name
50			*
51			* @return ClassGenerator
52			*/
53			public function defClass(string $name) : ClassGenerator
54			{
55			return $this->classes[] = new ClassGenerator($this, $name);
56			}
57
58			/**
59			* Generate code.
60			*
61			* @param int $indentation Code level
62			*
63			* @return string Generated code
64			*/
65			public function code($indentation = 0)
66			{
67			foreach ($this->classes as $classGenerator) {
68			$this->code[] = $classGenerator->code($indentation);
69			}
70
71			foreach ($this->functions as $functionGenerator) {
72			$this->code[] = $functionGenerator->code($indentation);
73			}
74
75			return implode("\n".$this->indentation($indentation), $this->code);
76			}
77			}
78

SamsonPHP / generator

Push — master ( 2a5486...81459b )

GenericGenerator::code() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like