Attribute::setGroupAttribute() - Code Metrics - Inspection of "Update Attribute.php" - rinvex/laravel-attributes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c150f0...39891f )

by Abdelrahman

created 2020-06-07 04:44 UTC

Attribute::setGroupAttribute() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

declare(strict_types=1);

namespace Rinvex\Attributes\Models;

use Illuminate\Support\Str;
use Spatie\Sluggable\SlugOptions;
use Rinvex\Support\Traits\HasSlug;
use Spatie\EloquentSortable\Sortable;
use Illuminate\Database\Eloquent\Model;
use Rinvex\Cacheable\CacheableEloquent;
use Rinvex\Support\Traits\HasTranslations;
use Rinvex\Support\Traits\ValidatingTrait;
use Spatie\EloquentSortable\SortableTrait;
use Illuminate\Database\Eloquent\Relations\HasMany;

/**
 * Rinvex\Attributes\Models\Attribute.
 *
 * @property int                                                                               $id
 * @property string                                                                            $slug
 * @property array                                                                             $name
 * @property array                                                                             $description
 * @property int                                                                               $sort_order
 * @property string                                                                            $group
 * @property string                                                                            $type
 * @property bool                                                                              $is_required
 * @property bool                                                                              $is_collection
 * @property string                                                                            $default
 * @property \Carbon\Carbon|null                                                               $created_at
 * @property \Carbon\Carbon|null                                                               $updated_at
 * @property array                                                                             $entities
 * @property-read \Rinvex\Attributes\Support\ValueCollection|\Rinvex\Attributes\Models\Value[] $values
 *
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute ordered($direction = 'asc')
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereDefault($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereDescription($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereGroup($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereIsCollection($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereIsRequired($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereSlug($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereSortOrder($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereType($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Attributes\Models\Attribute whereUpdatedAt($value)
 * @mixin \Eloquent
 */
class Attribute extends Model implements Sortable
{
    use HasSlug;
    use SortableTrait;
    use HasTranslations;
    use ValidatingTrait;
    use CacheableEloquent;

    /**
     * {@inheritdoc}
     */
    protected $fillable = [
        'name',
        'slug',
        'description',
        'sort_order',
        'group',
        'type',
        'is_required',
        'is_collection',
        'default',
        'entities',
    ];

    /**
     * {@inheritdoc}
     */
    protected $casts = [
        'slug' => 'string',
        'sort_order' => 'integer',
        'group' => 'string',
        'type' => 'string',
        'is_required' => 'boolean',
        'is_collection' => 'boolean',
        'default' => 'string',
    ];

    /**
     * {@inheritdoc}
     */
    protected $observables = [
        'validating',
        'validated',
    ];

    /**
     * {@inheritdoc}
     */
    public $translatable = [
        'name',
        'description',
    ];

    /**
     * {@inheritdoc}
     */
    public $sortable = [
        'order_column_name' => 'sort_order',
    ];

    /**
     * The default rules that the model will validate against.
     *
     * @var array
     */
    protected $rules = [];

    /**
     * Whether the model should throw a
     * ValidationException if it fails validation.
     *
     * @var bool
     */
    protected $throwValidationExceptions = true;

    /**
     * An array to map class names to their type names in database.
     *
     * @var array
     */
    protected static $typeMap = [];

    /**
     * Create a new Eloquent model instance.
     *
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->setTable(config('rinvex.attributes.tables.attributes'));
        $this->setRules([
            'name' => 'required|string|strip_tags|max:150',
            'description' => 'nullable|string|max:10000',
            'slug' => 'required|alpha_dash|max:150|unique:'.config('rinvex.attributes.tables.attributes').',slug',
            'sort_order' => 'nullable|integer|max:10000',
            'group' => 'nullable|string|strip_tags|max:150',
            'type' => 'required|string|strip_tags|max:150',
            'is_required' => 'sometimes|boolean',
            'is_collection' => 'sometimes|boolean',
            'default' => 'nullable|string|strip_tags|max:10000',
        ]);
    }

    /**
     * Enforce clean slugs.
     *
     * @param string $value
     *
     * @return void
     */
    public function setSlugAttribute($value): void
    {
        $this->attributes['slug'] = Str::slug($value, $this->getSlugOptions()->slugSeparator, $this->getSlugOptions()->slugLanguage);
    }

    /**
     * Set or get the type map for attribute types.
     *
     * @param array|null $map
     * @param bool       $merge
     *
     * @return array
     */
    public static function typeMap(array $map = null, $merge = true)
    {
        if (is_array($map)) {
            static::$typeMap = $merge && static::$typeMap

                ? $map + static::$typeMap : $map;
        }

        return static::$typeMap;
    }

    /**
     * Get the model associated with a custom attribute type.
     *
     * @param string $alias
     *
     * @return string|null
     */
    public static function getTypeModel($alias)
    {
        return self::$typeMap[$alias] ?? null;
    }

    /**
     * Access entities relation and retrieve entity types as an array,
     * Accessors/Mutators preceeds relation value when called dynamically.
     *
     * @return array
     */
    public function getEntitiesAttribute(): array
    {
        return $this->entities()->pluck('entity_type')->toArray();
    }

    /**
     * Set the attribute attached entities.
     *
     * @param \Illuminate\Support\Collection|array $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param mixed                                $entities
     *
     * @return void
     */
    public function setEntitiesAttribute($entities): void
    {
        static::saved(function ($model) use ($entities) {

            $this->entities()->delete();
            ! $entities || $this->entities()->createMany(array_map(function ($entity) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                return ['entity_type' => $entity];
            }, $entities));
        });
    }

    /**
     * Get the options for generating the slug.
     *
     * @return \Spatie\Sluggable\SlugOptions
     */
    public function getSlugOptions(): SlugOptions
    {
        return SlugOptions::create()
                          ->usingSeparator('_')
                          ->doNotGenerateSlugsOnUpdate()
                          ->generateSlugsFrom('name')
                          ->saveSlugsTo('slug');
    }

    /**
     * Get the entities attached to this attribute.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function entities(): HasMany
    {
        return $this->hasMany(config('rinvex.attributes.models.attribute_entity'), 'attribute_id', 'id');
    }

    /**
     * Get the entities attached to this attribute.
     *
     * @param string $value
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function values(string $value): HasMany
    {
        return $this->hasMany($value, 'attribute_id', 'id');
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Rinvex\Attributes\Models;
6
7			use Illuminate\Support\Str;
8			use Spatie\Sluggable\SlugOptions;
9			use Rinvex\Support\Traits\HasSlug;
10			use Spatie\EloquentSortable\Sortable;
11			use Illuminate\Database\Eloquent\Model;
12			use Rinvex\Cacheable\CacheableEloquent;
13			use Rinvex\Support\Traits\HasTranslations;
14			use Rinvex\Support\Traits\ValidatingTrait;
15			use Spatie\EloquentSortable\SortableTrait;
16			use Illuminate\Database\Eloquent\Relations\HasMany;
17
18			/**
19			* Rinvex\Attributes\Models\Attribute.
20			*
21			* @property int $id
22			* @property string $slug
23			* @property array $name
24			* @property array $description
25			* @property int $sort_order
26			* @property string $group
27			* @property string $type
28			* @property bool $is_required
29			* @property bool $is_collection
30			* @property string $default
31			* @property \Carbon\Carbon\|null $created_at
32			* @property \Carbon\Carbon\|null $updated_at
33			* @property array $entities
34			* @property-read \Rinvex\Attributes\Support\ValueCollection\|\Rinvex\Attributes\Models\Value[] $values
35			*
36			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute ordered($direction = 'asc')
37			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereCreatedAt($value)
38			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereDefault($value)
39			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereDescription($value)
40			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereGroup($value)
41			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereId($value)
42			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereIsCollection($value)
43			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereIsRequired($value)
44			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereSlug($value)
45			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereSortOrder($value)
46			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereName($value)
47			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereType($value)
48			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereUpdatedAt($value)
49			* @mixin \Eloquent
50			*/
51			class Attribute extends Model implements Sortable
52			{
53			use HasSlug;
54			use SortableTrait;
55			use HasTranslations;
56			use ValidatingTrait;
57			use CacheableEloquent;
58
59			/**
60			* {@inheritdoc}
61			*/
62			protected $fillable = [
63			'name',
64			'slug',
65			'description',
66			'sort_order',
67			'group',
68			'type',
69			'is_required',
70			'is_collection',
71			'default',
72			'entities',
73			];
74
75			/**
76			* {@inheritdoc}
77			*/
78			protected $casts = [
79			'slug' => 'string',
80			'sort_order' => 'integer',
81			'group' => 'string',
82			'type' => 'string',
83			'is_required' => 'boolean',
84			'is_collection' => 'boolean',
85			'default' => 'string',
86			];
87
88			/**
89			* {@inheritdoc}
90			*/
91			protected $observables = [
92			'validating',
93			'validated',
94			];
95
96			/**
97			* {@inheritdoc}
98			*/
99			public $translatable = [
100			'name',
101			'description',
102			];
103
104			/**
105			* {@inheritdoc}
106			*/
107			public $sortable = [
108			'order_column_name' => 'sort_order',
109			];
110
111			/**
112			* The default rules that the model will validate against.
113			*
114			* @var array
115			*/
116			protected $rules = [];
117
118			/**
119			* Whether the model should throw a
120			* ValidationException if it fails validation.
121			*
122			* @var bool
123			*/
124			protected $throwValidationExceptions = true;
125
126			/**
127			* An array to map class names to their type names in database.
128			*
129			* @var array
130			*/
131			protected static $typeMap = [];
132
133			/**
134			* Create a new Eloquent model instance.
135			*
136			* @param array $attributes
137			*/
138			public function __construct(array $attributes = [])
139			{
140			parent::__construct($attributes);
141
142			$this->setTable(config('rinvex.attributes.tables.attributes'));
143			$this->setRules([
144			'name' => 'required\|string\|strip_tags\|max:150',
145			'description' => 'nullable\|string\|max:10000',
146			'slug' => 'required\|alpha_dash\|max:150\|unique:'.config('rinvex.attributes.tables.attributes').',slug',
147			'sort_order' => 'nullable\|integer\|max:10000',
148			'group' => 'nullable\|string\|strip_tags\|max:150',
149			'type' => 'required\|string\|strip_tags\|max:150',
150			'is_required' => 'sometimes\|boolean',
151			'is_collection' => 'sometimes\|boolean',
152			'default' => 'nullable\|string\|strip_tags\|max:10000',
153			]);
154			}
155
156			/**
157			* Enforce clean slugs.
158			*
159			* @param string $value
160			*
161			* @return void
162			*/
163			public function setSlugAttribute($value): void
164			{
165			$this->attributes['slug'] = Str::slug($value, $this->getSlugOptions()->slugSeparator, $this->getSlugOptions()->slugLanguage);
166			}
167
168			/**
169			* Set or get the type map for attribute types.
170			*
171			* @param array\|null $map
172			* @param bool $merge
173			*
174			* @return array
175			*/
176			public static function typeMap(array $map = null, $merge = true)
177			{
178			if (is_array($map)) {
179			static::$typeMap = $merge && static::$typeMap
			0 ignored issues – show Bug Best Practice introduced 2017-12-22 19:38 UTC by Report Bug Copy Issue Report The expression `static::$typeMap` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
180			? $map + static::$typeMap : $map;
181			}
182
183			return static::$typeMap;
184			}
185
186			/**
187			* Get the model associated with a custom attribute type.
188			*
189			* @param string $alias
190			*
191			* @return string\|null
192			*/
193			public static function getTypeModel($alias)
194			{
195			return self::$typeMap[$alias] ?? null;
196			}
197
198			/**
199			* Access entities relation and retrieve entity types as an array,
200			* Accessors/Mutators preceeds relation value when called dynamically.
201			*
202			* @return array
203			*/
204			public function getEntitiesAttribute(): array
205			{
206			return $this->entities()->pluck('entity_type')->toArray();
207			}
208
209			/**
210			* Set the attribute attached entities.
211			*
212			* @param \Illuminate\Support\Collection\|array $value
			0 ignored issues – show Bug introduced 2017-09-09 18:32 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. 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			* @param mixed $entities
214			*
215			* @return void
216			*/
217			public function setEntitiesAttribute($entities): void
218			{
219			static::saved(function ($model) use ($entities) {
			0 ignored issues – show Unused Code introduced 2017-09-09 18:32 UTC by Report Bug Copy Issue Report The parameter `$model` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
220			$this->entities()->delete();
221			! $entities \|\| $this->entities()->createMany(array_map(function ($entity) {
			0 ignored issues – show Documentation introduced 2019-09-23 21:53 UTC by Report Bug Copy Issue Report `array_map(function ($ent...$entity); }, $entities)` is of type `array`, but the function expects a `object<Illuminate\Databa...ent\Relations\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
222			return ['entity_type' => $entity];
223			}, $entities));
224			});
225			}
226
227			/**
228			* Get the options for generating the slug.
229			*
230			* @return \Spatie\Sluggable\SlugOptions
231			*/
232			public function getSlugOptions(): SlugOptions
233			{
234			return SlugOptions::create()
235			->usingSeparator('_')
236			->doNotGenerateSlugsOnUpdate()
237			->generateSlugsFrom('name')
238			->saveSlugsTo('slug');
239			}
240
241			/**
242			* Get the entities attached to this attribute.
243			*
244			* @return \Illuminate\Database\Eloquent\Relations\HasMany
245			*/
246			public function entities(): HasMany
247			{
248			return $this->hasMany(config('rinvex.attributes.models.attribute_entity'), 'attribute_id', 'id');
249			}
250
251			/**
252			* Get the entities attached to this attribute.
253			*
254			* @param string $value
255			*
256			* @return \Illuminate\Database\Eloquent\Relations\HasMany
257			*/
258			public function values(string $value): HasMany
259			{
260			return $this->hasMany($value, 'attribute_id', 'id');
261			}
262			}
263

rinvex / laravel-attributes

Push — develop ( c150f0...39891f )

Attribute::setGroupAttribute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like