ClassGenerator::defStaticProperty() - 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

ClassGenerator::defStaticProperty() A

↳ Parent: ClassGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

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

/**
 * Class generator class.
 *
 * @author Vitaly Egorov <[email protected]>
 */
class ClassGenerator extends GenericGenerator
{
    /** OOP public visibility */
    const VISIBILITY_PUBLIC = 'public';

    /** OOP protected visibility */
    const VISIBILITY_PROTECTED = 'protected';

    /** OOP private visibility */
    const VISIBILITY_PRIVATE = 'private';

    /** @var string Class name */
    protected $className;

    /** @var string Class namespace */
    protected $namespace;

    /** @var array Collection of class uses */
    protected $uses;

    /** @var array Multiline class comment */
    protected $classComment;

    /** @var array Multiline file description */
    protected $fileDescription;

    /** @var array Class constants */
    protected $constants;

    /** @var array Class static properties */
    protected $staticProperties;

    /** @var array Class static methods */
    protected $staticMethods;

    /** @var array Class properties */
    protected $properties;

    /** @var array Class methods */
    protected $methods;

    /** @var bool Flag that class is abstract */
    protected $isAbstract;

    /** @var bool Flag that class is final */
    protected $isFinal;

    /**
     * ClassGenerator constructor.
     *
     * @param GenericGenerator $parent Parent generator
     * @param string           $className Class name
     */
    public function __construct(GenericGenerator $parent, string $className)
    {
        $this->className = $className;

        parent::__construct($parent);
    }

    /**
     * Set class to be final.
     *
     * @return ClassGenerator
     */
    public function defFinal() : ClassGenerator
    {
        if ($this->isAbstract) {
            throw new \InvalidArgumentException('Class cannot be final as it is already abstract');
        }

        $this->isFinal = true;

        return $this;
    }

    /**
     * Set class to be abstract.
     *
     * @return ClassGenerator
     */
    public function defAbstract() : ClassGenerator
    {
        if ($this->isFinal) {
            throw new \InvalidArgumentException('Class cannot be abstract as it is already final');
        }

        $this->isAbstract = true;

        return $this;
    }

    /**
     * Set class file description.
     *
     * @param string $description
     *
     * @return ClassGenerator
     */
    public function defDescription(string $description) : ClassGenerator
    {
        $this->fileDescription = $description;


        return $this;
    }

    /**
     * Set class namespace.
     *
     * @param string $namespace
     *
     * @return ClassGenerator
     */
    public function defNamespace(string $namespace) : ClassGenerator
    {
        $this->namespace = $namespace;

        return $this;
    }

    /**
     * Set class use.
     *
     * @param string $use
     *
     * @return ClassGenerator
     */
    public function defUse(string $use) : ClassGenerator
    {
        $this->uses[] = $use;

        return $this;
    }

    /**
     * Set class property.
     *
     * @param string $name Property name
     * @param mixed $value Property value
     * @param array  $comment Property PHPDOC comment strings collection
     * @param string $visibility Property visibility
     * @param bool   $static Flag that property is static
     *
     * @return ClassGenerator
     */
    public function defProperty(
        string $name,
        $value,
        array $comment = [],
        string $visibility = self::VISIBILITY_PUBLIC,
        bool $static = false
    ) : ClassGenerator {
        if ($static) {
            $collection = &$this->staticProperties[$name];
        } else {
            $collection = &$this->properties[$name];
        }

        $collection[] = [$comment, $static, $visibility, $value];

        return $this;
    }

    /**
     * Set protected class property.
     *
     * @param string $name Property name
     * @param mixed $value Property value
     * @param array  $comment Property PHPDOC comment strings collection
     *
     * @return ClassGenerator
     */
    public function defProtectedProperty(string $name, $value, array $comment = [])
    {
        return $this->defProperty($name, $value, $comment, self::VISIBILITY_PROTECTED);
    }

    /**
     * Set static class property.
     *
     * @param string $name Property name
     * @param mixed $value Property value
     * @param array  $comment Property PHPDOC comment strings collection
     * @param string $visibility Property visibility
     *
     * @return ClassGenerator
     */
    public function defStaticProperty(
        string $name,
        $value,
        array $comment = [],
        string $visibility = self::VISIBILITY_PUBLIC
    ) : ClassGenerator {
        return $this->defProperty($name, $value, $comment, $visibility, true);
    }

    /**
     * Set protected static class property.
     *
     * @param string $name Property name
     * @param mixed $value Property value
     * @param array  $comment Property PHPDOC comment strings collection
     *
     * @return ClassGenerator
     */
    public function defProtectedStaticProperty(string $name, $value, array $comment = [])
    {
        return $this->defStaticProperty($name, $value, $comment, self::VISIBILITY_PROTECTED);
    }
}


1			<?php declare(strict_types = 1);
2			/**
3			* Created by Vitaly Iegorov <[email protected]>.
4			* on 03.09.16 at 09:58
5			*/
6			namespace samsonphp\generator;
7
8			/**
9			* Class generator class.
10			*
11			* @author Vitaly Egorov <[email protected]>
12			*/
13			class ClassGenerator extends GenericGenerator
14			{
15			/** OOP public visibility */
16			const VISIBILITY_PUBLIC = 'public';
17
18			/** OOP protected visibility */
19			const VISIBILITY_PROTECTED = 'protected';
20
21			/** OOP private visibility */
22			const VISIBILITY_PRIVATE = 'private';
23
24			/** @var string Class name */
25			protected $className;
26
27			/** @var string Class namespace */
28			protected $namespace;
29
30			/** @var array Collection of class uses */
31			protected $uses;
32
33			/** @var array Multiline class comment */
34			protected $classComment;
35
36			/** @var array Multiline file description */
37			protected $fileDescription;
38
39			/** @var array Class constants */
40			protected $constants;
41
42			/** @var array Class static properties */
43			protected $staticProperties;
44
45			/** @var array Class static methods */
46			protected $staticMethods;
47
48			/** @var array Class properties */
49			protected $properties;
50
51			/** @var array Class methods */
52			protected $methods;
53
54			/** @var bool Flag that class is abstract */
55			protected $isAbstract;
56
57			/** @var bool Flag that class is final */
58			protected $isFinal;
59
60			/**
61			* ClassGenerator constructor.
62			*
63			* @param GenericGenerator $parent Parent generator
64			* @param string $className Class name
65			*/
66			public function __construct(GenericGenerator $parent, string $className)
67			{
68			$this->className = $className;
69
70			parent::__construct($parent);
71			}
72
73			/**
74			* Set class to be final.
75			*
76			* @return ClassGenerator
77			*/
78			public function defFinal() : ClassGenerator
79			{
80			if ($this->isAbstract) {
81			throw new \InvalidArgumentException('Class cannot be final as it is already abstract');
82			}
83
84			$this->isFinal = true;
85
86			return $this;
87			}
88
89			/**
90			* Set class to be abstract.
91			*
92			* @return ClassGenerator
93			*/
94			public function defAbstract() : ClassGenerator
95			{
96			if ($this->isFinal) {
97			throw new \InvalidArgumentException('Class cannot be abstract as it is already final');
98			}
99
100			$this->isAbstract = true;
101
102			return $this;
103			}
104
105			/**
106			* Set class file description.
107			*
108			* @param string $description
109			*
110			* @return ClassGenerator
111			*/
112			public function defDescription(string $description) : ClassGenerator
113			{
114			$this->fileDescription = $description;
			0 ignored issues – show Documentation Bug introduced 2016-09-03 10:08 UTC by Report Bug Copy Issue Report It seems like `$description` of type `string` is incompatible with the declared type `array` of property `$fileDescription`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
115
116			return $this;
117			}
118
119			/**
120			* Set class namespace.
121			*
122			* @param string $namespace
123			*
124			* @return ClassGenerator
125			*/
126			public function defNamespace(string $namespace) : ClassGenerator
127			{
128			$this->namespace = $namespace;
129
130			return $this;
131			}
132
133			/**
134			* Set class use.
135			*
136			* @param string $use
137			*
138			* @return ClassGenerator
139			*/
140			public function defUse(string $use) : ClassGenerator
141			{
142			$this->uses[] = $use;
143
144			return $this;
145			}
146
147			/**
148			* Set class property.
149			*
150			* @param string $name Property name
151			* @param mixed $value Property value
152			* @param array $comment Property PHPDOC comment strings collection
153			* @param string $visibility Property visibility
154			* @param bool $static Flag that property is static
155			*
156			* @return ClassGenerator
157			*/
158			public function defProperty(
159			string $name,
160			$value,
161			array $comment = [],
162			string $visibility = self::VISIBILITY_PUBLIC,
163			bool $static = false
164			) : ClassGenerator {
165			if ($static) {
166			$collection = &$this->staticProperties[$name];
167			} else {
168			$collection = &$this->properties[$name];
169			}
170
171			$collection[] = [$comment, $static, $visibility, $value];
172
173			return $this;
174			}
175
176			/**
177			* Set protected class property.
178			*
179			* @param string $name Property name
180			* @param mixed $value Property value
181			* @param array $comment Property PHPDOC comment strings collection
182			*
183			* @return ClassGenerator
184			*/
185			public function defProtectedProperty(string $name, $value, array $comment = [])
186			{
187			return $this->defProperty($name, $value, $comment, self::VISIBILITY_PROTECTED);
188			}
189
190			/**
191			* Set static class property.
192			*
193			* @param string $name Property name
194			* @param mixed $value Property value
195			* @param array $comment Property PHPDOC comment strings collection
196			* @param string $visibility Property visibility
197			*
198			* @return ClassGenerator
199			*/
200			public function defStaticProperty(
201			string $name,
202			$value,
203			array $comment = [],
204			string $visibility = self::VISIBILITY_PUBLIC
205			) : ClassGenerator {
206			return $this->defProperty($name, $value, $comment, $visibility, true);
207			}
208
209			/**
210			* Set protected static class property.
211			*
212			* @param string $name Property name
213			* @param mixed $value Property value
214			* @param array $comment Property PHPDOC comment strings collection
215			*
216			* @return ClassGenerator
217			*/
218			public function defProtectedStaticProperty(string $name, $value, array $comment = [])
219			{
220			return $this->defStaticProperty($name, $value, $comment, self::VISIBILITY_PROTECTED);
221			}
222			}
223

SamsonPHP / generator

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

ClassGenerator::defStaticProperty() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like