AbstractField::getDescendantName() - Code Metrics - Inspection of "Support listing/editing exact value from array col..." - Cherry-Pie/Jarboe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 49dc1a...1f58a4 )

by Yaro

created 2020-08-11 09:30 UTC

AbstractField::getDescendantName() A

↳ Parent: AbstractField

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
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\Errors;
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;
    use Errors;

    const DEFAULT_TAB_IDENT = '[extra]';

    private $crud;
    public static $repeaterAdapterClass;

    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 beforeUpdate($model)
    {
        // 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;
    }

    public function getHistoryView($value)
    {
        return view('jarboe::crud.fields.abstract.history', [
            'value' => $value,
        ]);
    }

    abstract public function getListView($model);


    abstract public function getEditFormView($model);


    abstract public function getCreateFormView();


    // TODO: interface type-hinting
    public function prepare(CRUD $crud)
    {
        $this->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.
    }
}
        }
    }

    protected function crud(): CRUD
    {
        return $this->crud;
    }

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

    public function getAncestorName(): string
    {
        throw new \RuntimeException('Not available: must be inherited from BelongsToArray trait.');
    }

    public function getDescendantName(): string
    {
        throw new \RuntimeException('Not available: must be inherited from BelongsToArray trait.');
    }

    public function getDotPatternName(): string
    {
        throw new \RuntimeException('Not available: must be inherited from BelongsToArray trait.');
    }
}


Push — master ( 49dc1a...1f58a4 )

AbstractField::getDescendantName() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

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\Errors;
11		use Yaro\Jarboe\Table\Fields\Traits\Filter;
12		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...
13		use Yaro\Jarboe\Table\Fields\Traits\Model;
14		use Yaro\Jarboe\Table\Fields\Traits\Name;
15		use Yaro\Jarboe\Table\Fields\Traits\OldAndAttribute;
16		use Yaro\Jarboe\Table\Fields\Traits\Readonly;
17		use Yaro\Jarboe\Table\Fields\Traits\Tab;
18		use Yaro\Jarboe\Table\Fields\Traits\Title;
19		use Yaro\Jarboe\Table\Fields\Traits\Width;
20
21		abstract class AbstractField implements FieldPropsInterface
22		{
23		use Hidden;
24		use Width;
25		use Column;
26		use Tab;
27		use Readonly;
28		use DefaultTrait;
29		use Title;
30		use Name;
31		use OldAndAttribute;
32		use Model;
33		use Filter;
34		use Errors;
35
36		const DEFAULT_TAB_IDENT = '[extra]';
37
38		private $crud;
39	1002	public static $repeaterAdapterClass;
40
41	1002	public static function make($name = '', $title = '')
42		{
43	1002	$field = new static;
44	951
45		if (!$title) {
46	1002	$title = preg_replace('~_~', ' ', ucfirst($name));
47	1002	}
48	1002	$field->title($title);
49		$field->name($name);
50	1002	$field->tab(self::DEFAULT_TAB_IDENT);
51
52		return $field;
53	19	}
54
55	19	public function value(Request $request)
56	19	{
57	3	$value = $request->get($this->name());
58		if (!$value && $this->isNullable()) {
59		return null;
60	19	}
61
62		return $value;
63	14	}
64
65	14	public function shouldSkip(Request $request)
66		{
67		return false;
68	1	}
69
70		public function afterStore($model, Request $request)
71	1	{
72		// dummy
73	2	}
74
75		public function afterUpdate($model, Request $request)
76	2	{
77		// dummy
78	1	}
79
80		public function beforeUpdate($model)
81	1	{
82		// dummy
83	12	}
84
85	12	public function isInline()
86		{
87		return false;
88	19	}
89
90	19	public function isRelationField()
91		{
92		return false;
93	16	}
94
95	16	public function isMultiple()
96		{
97		return false;
98	17	}
99
100	17	public function isEncode()
101		{
102		return false;
103	74	}
104
105	74	public function isMarkupRow()
106		{
107		return false;
108	4	}
109
110	4	public function isOrderable()
111		{
112		return false;
113	17	}
114
115	17	public function isAjax()
116		{
117		return false;
118	3	}
119
120	3	public function isNullable()
121		{
122		return false;
123	13	}
124
125	13	public function hasTooltip()
126		{
127		return false;
128	14	}
129
130	14	public function hasClipboardButton()
131		{
132		return false;
133	70	}
134
135	70	public function isTranslatable()
136		{
137		return false;
138	16	}
139
140	16	public function isMaskable()
141		{
142		return false;
143	8	}
144
145	8	public function getPlaceholder()
146		{
147		return null;
148	15	}
149
150	15	public function hasMaxlength(): bool
151		{
152		return false;
153	1	}
154
155	1	public function getHistoryView($value)
156	1	{
157		return view('jarboe::crud.fields.abstract.history', [
158		'value' => $value,
159		]);
160		}
161
162		abstract public function getListView($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...
163
164		abstract public function getEditFormView($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...
165
166		abstract public function getCreateFormView();
		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...
167	58
168		// TODO: interface type-hinting
169	58	public function prepare(CRUD $crud)
170		{
171	58	$this->crud = $crud;
172
173		if ($this->filter()) {
174		$this->filter()->value(
175		$this->filter()->getValue($crud->tableIdentifier())
176		);
177	58	}
178
179	58	$this->setModel($crud->getModel());
180
181		if (method_exists($this, 'setRelationSearchUrl')) {
182	58	$this->setRelationSearchUrl($crud->relationSearchUrl());
		0 ignored issues – show Bug introduced 2020-06-16 19:56 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\Etc\CustomFields\PermissionField`, `Yaro\Jarboe\Etc\CustomFields\RoleField`, `Yaro\Jarboe\Table\Fields\Radio`, `Yaro\Jarboe\Table\Fields\Select`, `Yaro\Jarboe\Table\Fields\Tags`. 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...
183	58	}
184		if (method_exists($this, 'setInlineUrl')) {
185	58	$this->setInlineUrl($crud->inlineUrl());
		0 ignored issues – show Bug introduced 2020-06-19 18:33 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\Checkbox`, `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...
186		}
187		if ($this->isTranslatable()) {
188		$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...
189	58	$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...
190		}
191		}
192
193		protected function crud(): CRUD
194		{
195		return $this->crud;
196		}
197
198		public function belongsToArray(): bool
199		{
200		return false;
201		}
202
203		public function getAncestorName(): string
204		{
205		throw new \RuntimeException('Not available: must be inherited from BelongsToArray trait.');
206		}
207
208		public function getDescendantName(): string
209		{
210		throw new \RuntimeException('Not available: must be inherited from BelongsToArray trait.');
211		}
212
213		public function getDotPatternName(): string
214		{
215		throw new \RuntimeException('Not available: must be inherited from BelongsToArray trait.');
216		}
217		}
218

Cherry-Pie / Jarboe

Push — master ( 49dc1a...1f58a4 )

AbstractField::getDescendantName() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like