AbstractField::make() - Code Metrics - Inspection of "Revert "speed up coverage"" - Cherry-Pie/Jarboe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 798e92...ea2dad )

by Yaro

created 2020-02-06 14:12 UTC

AbstractField::make() A

↳ Parent: AbstractField

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
ccs	8
cts	8
cp	1
cc	2
nc	2
nop	2
crap	2

<?php

namespace Yaro\Jarboe\Table\Fields;

use Illuminate\Http\Request;
use Yaro\Jarboe\Table\CRUD;
use Yaro\Jarboe\Table\Fields\Interfaces\FieldPropsInterface;
use Yaro\Jarboe\Table\Fields\Traits\Column;
use Yaro\Jarboe\Table\Fields\Traits\DefaultTrait;
use Yaro\Jarboe\Table\Fields\Traits\Filter;
use Yaro\Jarboe\Table\Fields\Traits\Hidden;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Yaro\Jarboe\Table\Fields\Traits\Model;
use Yaro\Jarboe\Table\Fields\Traits\Name;
use Yaro\Jarboe\Table\Fields\Traits\OldAndAttribute;
use Yaro\Jarboe\Table\Fields\Traits\Readonly;
use Yaro\Jarboe\Table\Fields\Traits\Tab;
use Yaro\Jarboe\Table\Fields\Traits\Title;
use Yaro\Jarboe\Table\Fields\Traits\Width;

abstract class AbstractField implements FieldPropsInterface
{
    use Hidden;
    use Width;
    use Column;
    use Tab;
    use Readonly;
    use DefaultTrait;
    use Title;
    use Name;
    use OldAndAttribute;
    use Model;
    use Filter;

    const DEFAULT_TAB_IDENT = '[extra]';

    public static function make($name = '', $title = '')
    {
        $field = new static;

        if (!$title) {
            $title = preg_replace('~_~', ' ', ucfirst($name));
        }
        $field->title($title);
        $field->name($name);
        $field->tab(self::DEFAULT_TAB_IDENT);

        return $field;
    }

    public function value(Request $request)
    {
        $value = $request->get($this->name());
        if (!$value && $this->isNullable()) {
            return null;
        }

        return $value;
    }

    public function shouldSkip(Request $request)
    {
        return false;
    }

    public function afterStore($model, Request $request)
    {
        // dummy
    }

    public function afterUpdate($model, Request $request)
    {
        // dummy
    }

    public function isInline()
    {
        return false;
    }

    public function isRelationField()
    {
        return false;
    }

    public function isMultiple()
    {
        return false;
    }

    public function isEncode()
    {
        return false;
    }

    public function isMarkupRow()
    {
        return false;
    }

    public function isOrderable()
    {
        return false;
    }

    public function isAjax()
    {
        return false;
    }

    public function isNullable()
    {
        return false;
    }

    public function hasTooltip()
    {
        return false;
    }

    public function hasClipboardButton()
    {
        return false;
    }

    public function isTranslatable()
    {
        return false;
    }

    public function isMaskable()
    {
        return false;
    }

    public function getPlaceholder()
    {
        return null;
    }

    public function hasMaxlength(): bool
    {
        return false;
    }

    abstract public function getListValue($model);


    abstract public function getEditFormValue($model);


    abstract public function getCreateFormValue();


    // TODO: interface type-hinting
    public function prepare(CRUD $crud)
    {
        if ($this->filter()) {
            $this->filter()->value(
                $this->filter()->getValue($crud->tableIdentifier())
            );
        }

        $this->setModel($crud->getModel());

        if (method_exists($this, 'setRelationSearchUrl')) {
            $this->setRelationSearchUrl($crud->relationSearchUrl());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
        if (method_exists($this, 'setInlineUrl')) {
            $this->setInlineUrl($crud->inlineUrl());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
        if ($this->isTranslatable()) {
            $this->locales($crud->getLocales());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->setCurrentLocale($crud->getCurrentLocale());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }
}


1		<?php
2
3		namespace Yaro\Jarboe\Table\Fields;
4
5		use Illuminate\Http\Request;
6		use Yaro\Jarboe\Table\CRUD;
7		use Yaro\Jarboe\Table\Fields\Interfaces\FieldPropsInterface;
8		use Yaro\Jarboe\Table\Fields\Traits\Column;
9		use Yaro\Jarboe\Table\Fields\Traits\DefaultTrait;
10		use Yaro\Jarboe\Table\Fields\Traits\Filter;
11		use Yaro\Jarboe\Table\Fields\Traits\Hidden;
		0 ignored issues – show Bug introduced 2019-10-25 12:48 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Yaro\Jarboe\Table\Fields\Hidden`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
12		use Yaro\Jarboe\Table\Fields\Traits\Model;
13		use Yaro\Jarboe\Table\Fields\Traits\Name;
14		use Yaro\Jarboe\Table\Fields\Traits\OldAndAttribute;
15		use Yaro\Jarboe\Table\Fields\Traits\Readonly;
16		use Yaro\Jarboe\Table\Fields\Traits\Tab;
17		use Yaro\Jarboe\Table\Fields\Traits\Title;
18		use Yaro\Jarboe\Table\Fields\Traits\Width;
19
20		abstract class AbstractField implements FieldPropsInterface
21		{
22		use Hidden;
23		use Width;
24		use Column;
25		use Tab;
26		use Readonly;
27		use DefaultTrait;
28		use Title;
29		use Name;
30		use OldAndAttribute;
31		use Model;
32		use Filter;
33
34		const DEFAULT_TAB_IDENT = '[extra]';
35
36	811	public static function make($name = '', $title = '')
37		{
38	811	$field = new static;
39
40	811	if (!$title) {
41	763	$title = preg_replace('~_~', ' ', ucfirst($name));
42		}
43	811	$field->title($title);
44	811	$field->name($name);
45	811	$field->tab(self::DEFAULT_TAB_IDENT);
46
47	811	return $field;
48		}
49
50	18	public function value(Request $request)
51		{
52	18	$value = $request->get($this->name());
53	18	if (!$value && $this->isNullable()) {
54	3	return null;
55		}
56
57	18	return $value;
58		}
59
60	14	public function shouldSkip(Request $request)
61		{
62	14	return false;
63		}
64
65	1	public function afterStore($model, Request $request)
66		{
67		// dummy
68	1	}
69
70	2	public function afterUpdate($model, Request $request)
71		{
72		// dummy
73	2	}
74
75	12	public function isInline()
76		{
77	12	return false;
78		}
79
80	16	public function isRelationField()
81		{
82	16	return false;
83		}
84
85	15	public function isMultiple()
86		{
87	15	return false;
88		}
89
90	16	public function isEncode()
91		{
92	16	return false;
93		}
94
95	65	public function isMarkupRow()
96		{
97	65	return false;
98		}
99
100	3	public function isOrderable()
101		{
102	3	return false;
103		}
104
105	16	public function isAjax()
106		{
107	16	return false;
108		}
109
110	3	public function isNullable()
111		{
112	3	return false;
113		}
114
115	12	public function hasTooltip()
116		{
117	12	return false;
118		}
119
120	13	public function hasClipboardButton()
121		{
122	13	return false;
123		}
124
125	13	public function isTranslatable()
126		{
127	13	return false;
128		}
129
130	15	public function isMaskable()
131		{
132	15	return false;
133		}
134
135	7	public function getPlaceholder()
136		{
137	7	return null;
138		}
139
140	14	public function hasMaxlength(): bool
141		{
142	14	return false;
143		}
144
145		abstract public function getListValue($model);
		0 ignored issues – show Documentation introduced 2019-08-31 12:57 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
146
147		abstract public function getEditFormValue($model);
		0 ignored issues – show Documentation introduced 2019-08-31 12:57 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
148
149		abstract public function getCreateFormValue();
		0 ignored issues – show Documentation introduced 2019-08-31 12:57 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
150
151		// TODO: interface type-hinting
152	49	public function prepare(CRUD $crud)
153		{
154	49	if ($this->filter()) {
155		$this->filter()->value(
156		$this->filter()->getValue($crud->tableIdentifier())
157		);
158		}
159
160	49	$this->setModel($crud->getModel());
161
162	49	if (method_exists($this, 'setRelationSearchUrl')) {
163		$this->setRelationSearchUrl($crud->relationSearchUrl());
		0 ignored issues – show Bug introduced 2019-08-09 05:40 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Yaro\Jarboe\Table\Fields\AbstractField` as the method `setRelationSearchUrl()` does only exist in the following sub-classes of `Yaro\Jarboe\Table\Fields\AbstractField`: `Yaro\Jarboe\Table\Fields\Radio`, `Yaro\Jarboe\Table\Fields\Select`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
164		}
165	49	if (method_exists($this, 'setInlineUrl')) {
166	49	$this->setInlineUrl($crud->inlineUrl());
		0 ignored issues – show Bug introduced 2019-08-09 05:40 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Yaro\Jarboe\Table\Fields\AbstractField` as the method `setInlineUrl()` does only exist in the following sub-classes of `Yaro\Jarboe\Table\Fields\AbstractField`: `Yaro\Jarboe\Table\Fields\Date`, `Yaro\Jarboe\Table\Fields\Number`, `Yaro\Jarboe\Table\Fields\Text`, `Yaro\Jarboe\Table\Fields\Textarea`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
167		}
168	49	if ($this->isTranslatable()) {
169		$this->locales($crud->getLocales());
		0 ignored issues – show Bug introduced 2019-10-24 14:58 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Yaro\Jarboe\Table\Fields\AbstractField` as the method `locales()` does only exist in the following sub-classes of `Yaro\Jarboe\Table\Fields\AbstractField`: `Yaro\Jarboe\Table\Fields\Repeater`, `Yaro\Jarboe\Table\Fields\Text`, `Yaro\Jarboe\Table\Fields\Textarea`, `Yaro\Jarboe\Table\Fields\Wysiwyg`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
170		$this->setCurrentLocale($crud->getCurrentLocale());
		0 ignored issues – show Bug introduced 2019-10-24 14:58 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Yaro\Jarboe\Table\Fields\AbstractField` as the method `setCurrentLocale()` does only exist in the following sub-classes of `Yaro\Jarboe\Table\Fields\AbstractField`: `Yaro\Jarboe\Table\Fields\Repeater`, `Yaro\Jarboe\Table\Fields\Text`, `Yaro\Jarboe\Table\Fields\Textarea`, `Yaro\Jarboe\Table\Fields\Wysiwyg`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
171		}
172	49	}
173		}
174

Cherry-Pie / Jarboe

Push — master ( 798e92...ea2dad )

AbstractField::make() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like