Field - Code Metrics - Inspection of "Major refactoring" - MarceauKa/laravel-crudable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 413ca6...9053fe )

by Marceau

created 2016-11-05 12:23 UTC

Field A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	342
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

Metric	Value
dl	0
loc	342
rs	9.8
c	0
b	0
f	0
wmc	31
lcom	2
cbo	3

22 Methods

Rating	Name	Size	Complexity
A	__construct()	9	2
A	handle()	4	1
B	withRules()	26	5
A	addRule()	6	1
A	setFields()	6	1
A	getIdentifier()	4	1
A	withLabel()	6	1
A	withPlaceholder()	6	1
A	withHelp()	6	1
A	form()	18	1
	getViewName()	1	?
A	hasError()	4	1
A	getError()	9	2
A	getPlaceholder()	9	2
A	getHelp()	9	2
A	hasOld()	4	1
A	getOld()	9	2
A	getLabel()	9	2
A	getValue()	4	1
A	getTableValue()	4	1
A	newValue()	6	1
A	getRules()	4	1

<?php

namespace Akibatech\Crud\Fields;

use Akibatech\Crud\Services\CrudFields;

/**
 * Class Field
 *
 * @package Akibatech\Crud\Fields
 */
abstract class Field
{
    /**
     * @var CrudFields
     */
    protected $fields;

    /**
     * @var string
     */
    protected $identifier;

    /**
     * @var string
     */
    protected $label;

    /**
     * @var string
     */
    protected $placeholder;

    /**
     * @var array
     */
    protected $rules;

    /**
     * Field constructor.
     *
     * @param   string       $identifier
     * @param   array|string $rules
     */
    public function __construct($identifier, $rules = null)
    {
        $this->identifier = $identifier;

        if (!is_null($rules))
        {
            $this->withRules($rules);
        }
    }

    /**
     * Constructs staticly.
     *
     * @param   string $idenfitier
     * @param   null|string|array $rules
     * @return  static
     */
    public static function handle($idenfitier, $rules = null)
    {
        return (new static($idenfitier, $rules));
    }


    /**
     * Add validation rules to the field.
     *
     * @param   string|array $rules
     * @return  mixed
     */
    public function withRules($rules)
    {
        if (is_array($rules))
        {
            foreach ($rules as $rule)
            {
                $this->addRule($rule);
            }
        }
        else
        {
            if (is_string($rules))
            {
                if (stripos($rules, '|') !== false)
                {
                    $rules = explode('|', $rules);

                    return $this->withRules($rules);
                }

                return $this->withRules([$rules]);
            }
        }

        return $this;
    }

    /**
     * Add a validation rule.
     *
     * @param   string $rule
     * @return  self
     */
    public function addRule($rule)
    {
        $this->rules[] = $rule;

        return $this;
    }

    /**
     * @param   CrudFields $fields
     * @return  self
     */
    public function setFields(CrudFields $fields)
    {
        $this->fields = $fields;

        return $this;
    }

    /**
     * Get the field identifier.
     *
     * @param   void
     * @return  string
     */
    public function getIdentifier()
    {
        return $this->identifier;
    }

    /**
     * Set a custom label for the field.
     *
     * @param   string $name
     * @return  self
     */
    public function withLabel($name)
    {
        $this->label = $name;

        return $this;
    }

    /**
     * Defines a placeholder for the field.
     *
     * @param   string $placeholder
     * @return  self
     */
    public function withPlaceholder($placeholder)
    {
        $this->placeholder = $placeholder;

        return $this;
    }

    /**
     * Appends an help message to the input.
     *
     * @param   string $help
     * @return  self
     */
    public function withHelp($help)
    {
        $this->help = $help;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    /**
     * Returns the field's form.
     *
     * @param   void
     * @return  string
     */
    public function form()
    {
        $view = view()->make($this->getViewName())->with([
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            'field'       => $this,
            'has_error'   => $this->hasError(),
            'error'       => $this->getError(),
            'placeholder' => $this->getPlaceholder(),
            'help'        => $this->getHelp(),
            'has_old'     => $this->hasOld(),
            'old'         => $this->getOld(),
            'label'       => $this->getLabel(),
            'name'        => $this->identifier,
            'id'          => 'field-' . $this->identifier,
            'value'       => $this->getValue()
        ]);

        return $view->render();
    }

    /**
     * Get the field view name.
     *
     * @param   void
     * @return  string
     */
    abstract public function getViewName();

    /**
     * Checks if the field has an error.
     *
     * @param   void
     * @return  bool
     */
    public function hasError()
    {
        return $this->fields->getErrors()->has($this->identifier);
    }

    /**
     * Returns the error.
     *
     * @param   void
     * @return  null|string
     */
    public function getError()
    {
        if ($this->hasError())
        {
            return $this->fields->getErrors()->first($this->identifier);
        }

        return null;
    }

    /**
     * Returns the field's placeholder.
     *
     * @param   void
     * @return  string
     */
    public function getPlaceholder()
    {
        if (empty($this->placeholder))
        {
            return null;
        }

        return $this->placeholder;
    }

    /**
     * Returns the field's help.
     *
     * @param   void
     * @return  string
     */
    public function getHelp()
    {
        if (empty($this->help))
        {
            return null;
        }

        return $this->help;
    }

    /**
     * Checks if the field has a previous value.
     *
     * @param   void
     * @return  bool
     */
    public function hasOld()
    {
        return $this->fields->getOldInput()->has($this->identifier);
    }

    /**
     * Returns the old value.
     *
     * @param   void
     * @return  string|null
     */
    public function getOld()
    {
        if ($this->hasOld())
        {
            return $this->fields->getOldInput()->first($this->identifier);
        }

        return null;
    }

    /**
     * Returns the field's label.
     *
     * @param   void
     * @return  string
     */
    public function getLabel()
    {
        if (empty($this->label))
        {
            return title_case($this->identifier);
        }

        return $this->label;
    }

    /**
     * Get the field value.
     *
     * @param   void
     * @return  mixed
     */
    public function getValue()
    {
        return $this->fields->getEntry()->getModel()->getAttributeValue($this->identifier);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * Get the value to be displayed on a table.
     *
     * @param   void
     * @return  mixed
     */
    public function getTableValue()
    {
        return $this->getValue();
    }

    /**
     * Set a new value to the model.
     *
     * @param   mixed $value
     * @return  self
     */
    public function newValue($value)
    {
        $this->fields->getEntry()->getModel()->setAttribute($this->identifier, $value);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        return $this;
    }

    /**
     * @param   void
     * @return  string
     */
    public function getRules()
    {
        return $this->rules;
    }
}


GitHub Access Token became invalid

Push — master ( 413ca6...9053fe )

Field A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

22 Methods

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace Akibatech\Crud\Fields;
4
5			use Akibatech\Crud\Services\CrudFields;
6
7			/**
8			* Class Field
9			*
10			* @package Akibatech\Crud\Fields
11			*/
12			abstract class Field
13			{
14			/**
15			* @var CrudFields
16			*/
17			protected $fields;
18
19			/**
20			* @var string
21			*/
22			protected $identifier;
23
24			/**
25			* @var string
26			*/
27			protected $label;
28
29			/**
30			* @var string
31			*/
32			protected $placeholder;
33
34			/**
35			* @var array
36			*/
37			protected $rules;
38
39			/**
40			* Field constructor.
41			*
42			* @param string $identifier
43			* @param array\|string $rules
44			*/
45			public function __construct($identifier, $rules = null)
46			{
47			$this->identifier = $identifier;
48
49			if (!is_null($rules))
50			{
51			$this->withRules($rules);
52			}
53			}
54
55			/**
56			* Constructs staticly.
57			*
58			* @param string $idenfitier
59			* @param null\|string\|array $rules
60			* @return static
61			*/
62			public static function handle($idenfitier, $rules = null)
63			{
64			return (new static($idenfitier, $rules));
65			}
66
67
68			/**
69			* Add validation rules to the field.
70			*
71			* @param string\|array $rules
72			* @return mixed
73			*/
74			public function withRules($rules)
75			{
76			if (is_array($rules))
77			{
78			foreach ($rules as $rule)
79			{
80			$this->addRule($rule);
81			}
82			}
83			else
84			{
85			if (is_string($rules))
86			{
87			if (stripos($rules, '\|') !== false)
88			{
89			$rules = explode('\|', $rules);
90
91			return $this->withRules($rules);
92			}
93
94			return $this->withRules([$rules]);
95			}
96			}
97
98			return $this;
99			}
100
101			/**
102			* Add a validation rule.
103			*
104			* @param string $rule
105			* @return self
106			*/
107			public function addRule($rule)
108			{
109			$this->rules[] = $rule;
110
111			return $this;
112			}
113
114			/**
115			* @param CrudFields $fields
116			* @return self
117			*/
118			public function setFields(CrudFields $fields)
119			{
120			$this->fields = $fields;
121
122			return $this;
123			}
124
125			/**
126			* Get the field identifier.
127			*
128			* @param void
129			* @return string
130			*/
131			public function getIdentifier()
132			{
133			return $this->identifier;
134			}
135
136			/**
137			* Set a custom label for the field.
138			*
139			* @param string $name
140			* @return self
141			*/
142			public function withLabel($name)
143			{
144			$this->label = $name;
145
146			return $this;
147			}
148
149			/**
150			* Defines a placeholder for the field.
151			*
152			* @param string $placeholder
153			* @return self
154			*/
155			public function withPlaceholder($placeholder)
156			{
157			$this->placeholder = $placeholder;
158
159			return $this;
160			}
161
162			/**
163			* Appends an help message to the input.
164			*
165			* @param string $help
166			* @return self
167			*/
168			public function withHelp($help)
169			{
170			$this->help = $help;
			0 ignored issues – show Bug introduced 2016-11-04 10:30 UTC by Report Bug Copy Issue Report The property `help` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
171
172			return $this;
173			}
174
175			/**
176			* Returns the field's form.
177			*
178			* @param void
179			* @return string
180			*/
181			public function form()
182			{
183			$view = view()->make($this->getViewName())->with([
			0 ignored issues – show Bug introduced 2016-11-04 02:19 UTC by Report Bug Copy Issue Report The method `make` does only exist in `Illuminate\Contracts\View\Factory`, but not in `Illuminate\View\View`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
184			'field' => $this,
185			'has_error' => $this->hasError(),
186			'error' => $this->getError(),
187			'placeholder' => $this->getPlaceholder(),
188			'help' => $this->getHelp(),
189			'has_old' => $this->hasOld(),
190			'old' => $this->getOld(),
191			'label' => $this->getLabel(),
192			'name' => $this->identifier,
193			'id' => 'field-' . $this->identifier,
194			'value' => $this->getValue()
195			]);
196
197			return $view->render();
198			}
199
200			/**
201			* Get the field view name.
202			*
203			* @param void
204			* @return string
205			*/
206			abstract public function getViewName();
207
208			/**
209			* Checks if the field has an error.
210			*
211			* @param void
212			* @return bool
213			*/
214			public function hasError()
215			{
216			return $this->fields->getErrors()->has($this->identifier);
217			}
218
219			/**
220			* Returns the error.
221			*
222			* @param void
223			* @return null\|string
224			*/
225			public function getError()
226			{
227			if ($this->hasError())
228			{
229			return $this->fields->getErrors()->first($this->identifier);
230			}
231
232			return null;
233			}
234
235			/**
236			* Returns the field's placeholder.
237			*
238			* @param void
239			* @return string
240			*/
241			public function getPlaceholder()
242			{
243			if (empty($this->placeholder))
244			{
245			return null;
246			}
247
248			return $this->placeholder;
249			}
250
251			/**
252			* Returns the field's help.
253			*
254			* @param void
255			* @return string
256			*/
257			public function getHelp()
258			{
259			if (empty($this->help))
260			{
261			return null;
262			}
263
264			return $this->help;
265			}
266
267			/**
268			* Checks if the field has a previous value.
269			*
270			* @param void
271			* @return bool
272			*/
273			public function hasOld()
274			{
275			return $this->fields->getOldInput()->has($this->identifier);
276			}
277
278			/**
279			* Returns the old value.
280			*
281			* @param void
282			* @return string\|null
283			*/
284			public function getOld()
285			{
286			if ($this->hasOld())
287			{
288			return $this->fields->getOldInput()->first($this->identifier);
289			}
290
291			return null;
292			}
293
294			/**
295			* Returns the field's label.
296			*
297			* @param void
298			* @return string
299			*/
300			public function getLabel()
301			{
302			if (empty($this->label))
303			{
304			return title_case($this->identifier);
305			}
306
307			return $this->label;
308			}
309
310			/**
311			* Get the field value.
312			*
313			* @param void
314			* @return mixed
315			*/
316			public function getValue()
317			{
318			return $this->fields->getEntry()->getModel()->getAttributeValue($this->identifier);
			0 ignored issues – show Bug introduced 2016-11-04 02:19 UTC by Report Bug Copy Issue Report The method `getAttributeValue` does only exist in `Illuminate\Database\Eloquent\Model`, but not in `Akibatech\Crud\Traits\Crudable`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
319			}
320
321			/**
322			* Get the value to be displayed on a table.
323			*
324			* @param void
325			* @return mixed
326			*/
327			public function getTableValue()
328			{
329			return $this->getValue();
330			}
331
332			/**
333			* Set a new value to the model.
334			*
335			* @param mixed $value
336			* @return self
337			*/
338			public function newValue($value)
339			{
340			$this->fields->getEntry()->getModel()->setAttribute($this->identifier, $value);
			0 ignored issues – show Bug introduced 2016-11-04 02:19 UTC by Report Bug Copy Issue Report The method `setAttribute` does only exist in `Illuminate\Database\Eloquent\Model`, but not in `Akibatech\Crud\Traits\Crudable`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
341
342			return $this;
343			}
344
345			/**
346			* @param void
347			* @return string
348			*/
349			public function getRules()
350			{
351			return $this->rules;
352			}
353			}
354

MarceauKa / laravel-crudable

GitHub Access Token became invalid

Push — master ( 413ca6...9053fe )

Field A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

22 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like