FieldWrapper::isListedAs() - Code Metrics - Inspection of "+ added attribute helpers" - marcmascarell/laravel-artificer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev ( 3aade8...05a280 )

by Marc

created 2016-08-14 09:38 UTC

FieldWrapper::isListedAs() B

↳ Parent: FieldWrapper

Complexity

Conditions	5
Paths	6

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	14
rs	8.8571
cc	5
eloc	7
nc	6
nop	2

<?php namespace Mascame\Artificer\Fields;

use Mascame\Artificer\Artificer;
use Mascame\Formality\Field\FieldInterface;
use Mascame\Formality\Field\TypeInterface;

class FieldWrapper
{
    use Filterable;

    protected $widgets = [];

    /**
     * Sometimes ajax limits output, setting this to true will return all
     *
     * @var bool
     */
    public $showFullField = false;

    /**
     * @var bool
     */
    protected $withWidgets = false;

    /**
     * @var FieldInterface|TypeInterface
     */
    public $field;

    /**
     * Field constructor.
     * @param FieldInterface|TypeInterface $field
     * @param null $relation
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct(FieldInterface $field)
    {
        $this->field = $field;

        $this->widgets = $this->getInstalledWidgets();
    }

    /**
     * Only get widgets that are installed
     *
     * @return array
     */
    protected function getInstalledWidgets()
    {
        $installedWidgets = [];
        $widgetManager = Artificer::widgetManager();
        $widgets = $this->field->getOption('widgets', []);
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.
}

        foreach ($widgets as $widget) {
            if ($widgetManager->isInstalled($widget)) {
                $installedWidgets[] = $widget;
            }
        }

        return $installedWidgets;
    }

    /**
     * @param null $value
     * @return null
     */
    public function show($value = null)
    {
        $value = ($value) ? $this->field->setValue($value) : $this->field->getOption('default');
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.
}

        if ($show = $this->field->getOption('show')) {
            if (is_callable($show)) {
                return $show($value);
            }
        }

        return $this->field->show();
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 bool|mixed|null|string
     */
    public function output()
    {
        if ($this->isHidden()) return null;

        $field = $this;

        if ($this->withWidgets) {
            $field = $this->applyWidgets();
        }

        return $field->field->output();
    }

    public function protectGuarded() {
        if (! $this->isFillable()) {
            $this->field->setOptions([
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.
}
                'attributes' => array_merge($this->field->getAttributes(), ['disabled' => 'disabled'])
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;
    }

    public function withWidgets() {
        $this->withWidgets = true;

        return $this;
    }

    protected function applyWidgets() {
        $field = $this;

        foreach ($this->widgets as $widget) {
            $widget = Artificer::widgetManager()->get($widget);
            $widget->assets(Artificer::assetManager());

            $field = $widget->field($field);
        }

        return $field;
    }

    /**
     * @param $array
     * @return bool
     */
    protected function isAll($array)
    {
        return (is_array($array) && isset($array[0]) && $array[0] == '*' || $array == '*');
    }

    /**
     * @param string $visibility [visible|hidden]
     * @return bool
     */
    protected function isListedAs($visibility, $action = null)
    {
        if (! $action) $action = Artificer::getCurrentAction();

        $listOptions = Artificer::getModelManager()->getOption($action);

        if (! $listOptions || ! isset($listOptions[$visibility])) return false;

        $list = $listOptions[$visibility];

        if ($this->isAll($list)) return true;

        return $this->isInArray($this->field->getName(), $list);
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.
}
    }

    /**
     * Hidden fields have preference.
     *
     * @return bool
     */
    public function isVisible()
    {
        if ($this->isHidden()) return false;

        return $this->isListedAs('visible');
    }

    /**
     * @param $value
     * @param $array
     * @return bool
     */
    public function isInArray($value, $array)
    {
        return (is_array($array) && in_array($value, $array)) ? true : false;
    }

    /**
     * @return bool
     */
    public function isHidden()
    {
        return $this->isListedAs('hidden');
    }

    public static function get($name)
    {
        return array_get(\View::getShared(), 'fields')[$name];
    }

    public function __get($name) {
        $accessor = 'get' . studly_case($name);

        return $this->useFieldMethod($accessor);
    }

    protected function useFieldMethod($method, $args = []) {
        if (! method_exists($this->field, $method)) {
            return null;
        }

        return (empty($args)) ? $this->field->$method() : $this->field->$method($args);
    }

    public function __call($method, $args) {
        return $this->useFieldMethod($method, $args);
    }

    public function isFillable() {
        $fillable = Artificer::getModelManager()->getFillable();

        return $this->isAll($fillable) || in_array($this->field->getName(), $fillable);
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.
}
    }

    /**
     * @param array|string $classes
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    protected function mergeClassAttribute($class) {
        if (! is_array($class)) $class = [$class];

        $attributes = $this->field->getAttributes();
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.
}
        $classes = isset($attributes['class']) ? explode(' ', $attributes['class']) : [];

        return join(' ', array_merge($classes, $class));
    }

    /**
     * @param string $attribute
     * @param array|string $value
     */
    public function addAttribute($attribute, $value) {
        if ($attribute == 'class') {
            $value = $this->mergeClassAttribute($value);
        }

        $this->field->setOptions(['attributes' => [$attribute => $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.
}
    }
}

Push — dev ( 3aade8...05a280 )

FieldWrapper::isListedAs() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php namespace Mascame\Artificer\Fields;
2
3			use Mascame\Artificer\Artificer;
4			use Mascame\Formality\Field\FieldInterface;
5			use Mascame\Formality\Field\TypeInterface;
6
7			class FieldWrapper
8			{
9			use Filterable;
10
11			protected $widgets = [];
12
13			/**
14			* Sometimes ajax limits output, setting this to true will return all
15			*
16			* @var bool
17			*/
18			public $showFullField = false;
19
20			/**
21			* @var bool
22			*/
23			protected $withWidgets = false;
24
25			/**
26			* @var FieldInterface\|TypeInterface
27			*/
28			public $field;
29
30			/**
31			* Field constructor.
32			* @param FieldInterface\|TypeInterface $field
33			* @param null $relation
			0 ignored issues – show Bug introduced 2016-04-03 20:02 UTC by Report Bug Copy Issue Report There is no parameter named `$relation`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
34			*/
35			public function __construct(FieldInterface $field)
36			{
37			$this->field = $field;
38
39			$this->widgets = $this->getInstalledWidgets();
40			}
41
42			/**
43			* Only get widgets that are installed
44			*
45			* @return array
46			*/
47			protected function getInstalledWidgets()
48			{
49			$installedWidgets = [];
50			$widgetManager = Artificer::widgetManager();
51			$widgets = $this->field->getOption('widgets', []);
			0 ignored issues – show Bug introduced 2016-08-07 18:33 UTC by Report Bug Copy Issue Report The method `getOption` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
52
53			foreach ($widgets as $widget) {
54			if ($widgetManager->isInstalled($widget)) {
55			$installedWidgets[] = $widget;
56			}
57			}
58
59			return $installedWidgets;
60			}
61
62			/**
63			* @param null $value
64			* @return null
65			*/
66			public function show($value = null)
67			{
68			$value = ($value) ? $this->field->setValue($value) : $this->field->getOption('default');
			0 ignored issues – show Bug introduced 2016-06-19 10:29 UTC by Report Bug Copy Issue Report The method `setValue` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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... Bug introduced 2016-06-19 10:29 UTC by Report Bug Copy Issue Report The method `getOption` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
69
70			if ($show = $this->field->getOption('show')) {
71			if (is_callable($show)) {
72			return $show($value);
73			}
74			}
75
76			return $this->field->show();
			0 ignored issues – show Bug introduced 2016-06-19 10:29 UTC by Report Bug Copy Issue Report The method `show` does only exist in `Mascame\Formality\Field\TypeInterface`, but not in `Mascame\Formality\Field\FieldInterface`. 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...
77			}
78
79			/**
80			* @return bool\|mixed\|null\|string
81			*/
82			public function output()
83			{
84			if ($this->isHidden()) return null;
85
86			$field = $this;
87
88			if ($this->withWidgets) {
89			$field = $this->applyWidgets();
90			}
91
92			return $field->field->output();
93			}
94
95			public function protectGuarded() {
96			if (! $this->isFillable()) {
97			$this->field->setOptions([
			0 ignored issues – show Bug introduced 2016-08-13 22:53 UTC by Report Bug Copy Issue Report The method `setOptions` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
98			'attributes' => array_merge($this->field->getAttributes(), ['disabled' => 'disabled'])
			0 ignored issues – show Bug introduced 2016-08-13 22:53 UTC by Report Bug Copy Issue Report The method `getAttributes` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
99			]);
100			}
101
102			return $this;
103			}
104
105			public function withWidgets() {
106			$this->withWidgets = true;
107
108			return $this;
109			}
110
111			protected function applyWidgets() {
112			$field = $this;
113
114			foreach ($this->widgets as $widget) {
115			$widget = Artificer::widgetManager()->get($widget);
116			$widget->assets(Artificer::assetManager());
117
118			$field = $widget->field($field);
119			}
120
121			return $field;
122			}
123
124			/**
125			* @param $array
126			* @return bool
127			*/
128			protected function isAll($array)
129			{
130			return (is_array($array) && isset($array[0]) && $array[0] == '' \|\| $array == '');
131			}
132
133			/**
134			* @param string $visibility [visible\|hidden]
135			* @return bool
136			*/
137			protected function isListedAs($visibility, $action = null)
138			{
139			if (! $action) $action = Artificer::getCurrentAction();
140
141			$listOptions = Artificer::getModelManager()->getOption($action);
142
143			if (! $listOptions \|\| ! isset($listOptions[$visibility])) return false;
144
145			$list = $listOptions[$visibility];
146
147			if ($this->isAll($list)) return true;
148
149			return $this->isInArray($this->field->getName(), $list);
			0 ignored issues – show Bug introduced 2016-06-19 10:29 UTC by Report Bug Copy Issue Report The method `getName` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
150			}
151
152			/**
153			* Hidden fields have preference.
154			*
155			* @return bool
156			*/
157			public function isVisible()
158			{
159			if ($this->isHidden()) return false;
160
161			return $this->isListedAs('visible');
162			}
163
164			/**
165			* @param $value
166			* @param $array
167			* @return bool
168			*/
169			public function isInArray($value, $array)
170			{
171			return (is_array($array) && in_array($value, $array)) ? true : false;
172			}
173
174			/**
175			* @return bool
176			*/
177			public function isHidden()
178			{
179			return $this->isListedAs('hidden');
180			}
181
182			public static function get($name)
183			{
184			return array_get(\View::getShared(), 'fields')[$name];
185			}
186
187			public function __get($name) {
188			$accessor = 'get' . studly_case($name);
189
190			return $this->useFieldMethod($accessor);
191			}
192
193			protected function useFieldMethod($method, $args = []) {
194			if (! method_exists($this->field, $method)) {
195			return null;
196			}
197
198			return (empty($args)) ? $this->field->$method() : $this->field->$method($args);
199			}
200
201			public function __call($method, $args) {
202			return $this->useFieldMethod($method, $args);
203			}
204
205			public function isFillable() {
206			$fillable = Artificer::getModelManager()->getFillable();
207
208			return $this->isAll($fillable) \|\| in_array($this->field->getName(), $fillable);
			0 ignored issues – show Bug introduced 2016-08-13 22:53 UTC by Report Bug Copy Issue Report The method `getName` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
209			}
210
211			/**
212			* @param array\|string $classes
			0 ignored issues – show Bug introduced 2016-08-14 09:40 UTC by Report Bug Copy Issue Report There is no parameter named `$classes`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
213			*/
214			protected function mergeClassAttribute($class) {
215			if (! is_array($class)) $class = [$class];
216
217			$attributes = $this->field->getAttributes();
			0 ignored issues – show Bug introduced 2016-08-14 09:40 UTC by Report Bug Copy Issue Report The method `getAttributes` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
218			$classes = isset($attributes['class']) ? explode(' ', $attributes['class']) : [];
219
220			return join(' ', array_merge($classes, $class));
221			}
222
223			/**
224			* @param string $attribute
225			* @param array\|string $value
226			*/
227			public function addAttribute($attribute, $value) {
228			if ($attribute == 'class') {
229			$value = $this->mergeClassAttribute($value);
230			}
231
232			$this->field->setOptions(['attributes' => [$attribute => $value]]);
			0 ignored issues – show Bug introduced 2016-08-14 09:40 UTC by Report Bug Copy Issue Report The method `setOptions` does only exist in `Mascame\Formality\Field\FieldInterface`, but not in `Mascame\Formality\Field\TypeInterface`. 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...
233			}
234			}

marcmascarell / laravel-artificer

Push — dev ( 3aade8...05a280 )

FieldWrapper::isListedAs() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like