Attribute::boot() - Code Metrics - Inspection of "Merge branch 'release/v0.0.4'" - rinvex/laravel-attributes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 338f76...18945f )

by Abdelrahman

created 2018-02-18 02:50 UTC

Attribute::boot() B

↳ Parent: Project

Complexity

Conditions	5
Paths	1

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	7
nc	1
nop	0

<?php

declare(strict_types=1);

namespace Rinvex\Attributes\Models;

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 whereName($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 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|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:10000000',
            'group' => 'nullable|string|max:150',
            'type' => 'required|string|max:150',
            'is_required' => 'sometimes|boolean',
            'is_collection' => 'sometimes|boolean',
            'default' => 'nullable|string|max:10000',
        ]);
    }

    /**
     * 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;
    }

    /**
     * Enforce clean groups.
     *
     * @param string $value
     *
     * @return void
     */
    public function setGroupAttribute($value): void
    {
        $this->attributes['group'] = str_slug($value);
    }

    /**
     * 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";
}
     *
     * @return void
     */
    public function setEntitiesAttribute($entities): void
    {
        static::saved(function ($model) use ($entities) {

            $this->entities()->delete();
            ! $entities || $this->entities()->createMany(array_map(function ($entity) {
                return ['entity_type' => $entity];
            }, $entities));
        });
    }

    /**
     * Get the options for generating the slug.
     *
     * @return \Spatie\Sluggable\SlugOptions
     */
    public function getSlugOptions(): SlugOptions
    {
        return SlugOptions::create()
                          ->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 Spatie\Sluggable\SlugOptions;
8			use Rinvex\Support\Traits\HasSlug;
9			use Spatie\EloquentSortable\Sortable;
10			use Illuminate\Database\Eloquent\Model;
11			use Rinvex\Cacheable\CacheableEloquent;
12			use Rinvex\Support\Traits\HasTranslations;
13			use Rinvex\Support\Traits\ValidatingTrait;
14			use Spatie\EloquentSortable\SortableTrait;
15			use Illuminate\Database\Eloquent\Relations\HasMany;
16
17			/**
18			* Rinvex\Attributes\Models\Attribute.
19			*
20			* @property int $id
21			* @property string $slug
22			* @property array $name
23			* @property array $description
24			* @property int $sort_order
25			* @property string $group
26			* @property string $type
27			* @property bool $is_required
28			* @property bool $is_collection
29			* @property string $default
30			* @property \Carbon\Carbon\|null $created_at
31			* @property \Carbon\Carbon\|null $updated_at
32			* @property array $entities
33			* @property-read \Rinvex\Attributes\Support\ValueCollection\|\Rinvex\Attributes\Models\Value[] $values
34			*
35			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute ordered($direction = 'asc')
36			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereCreatedAt($value)
37			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereDefault($value)
38			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereDescription($value)
39			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereGroup($value)
40			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereId($value)
41			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereIsCollection($value)
42			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereIsRequired($value)
43			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereName($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 whereType($value)
47			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereUpdatedAt($value)
48			* @mixin \Eloquent
49			*/
50			class Attribute extends Model implements Sortable
51			{
52			use HasSlug;
53			use SortableTrait;
54			use HasTranslations;
55			use ValidatingTrait;
56			use CacheableEloquent;
57
58			/**
59			* {@inheritdoc}
60			*/
61			protected $fillable = [
62			'name',
63			'slug',
64			'description',
65			'sort_order',
66			'group',
67			'type',
68			'is_required',
69			'is_collection',
70			'default',
71			'entities',
72			];
73
74			/**
75			* {@inheritdoc}
76			*/
77			protected $casts = [
78			'slug' => 'string',
79			'sort_order' => 'integer',
80			'group' => 'string',
81			'type' => 'string',
82			'is_required' => 'boolean',
83			'is_collection' => 'boolean',
84			'default' => 'string',
85			];
86
87			/**
88			* {@inheritdoc}
89			*/
90			protected $observables = [
91			'validating',
92			'validated',
93			];
94
95			/**
96			* {@inheritdoc}
97			*/
98			public $translatable = [
99			'name',
100			'description',
101			];
102
103			/**
104			* {@inheritdoc}
105			*/
106			public $sortable = [
107			'order_column_name' => 'sort_order',
108			];
109
110			/**
111			* The default rules that the model will validate against.
112			*
113			* @var array
114			*/
115			protected $rules = [];
116
117			/**
118			* Whether the model should throw a
119			* ValidationException if it fails validation.
120			*
121			* @var bool
122			*/
123			protected $throwValidationExceptions = true;
124
125			/**
126			* An array to map class names to their type names in database.
127			*
128			* @var array
129			*/
130			protected static $typeMap = [];
131
132			/**
133			* Create a new Eloquent model instance.
134			*
135			* @param array $attributes
136			*/
137			public function __construct(array $attributes = [])
138			{
139			parent::__construct($attributes);
140
141			$this->setTable(config('rinvex.attributes.tables.attributes'));
142			$this->setRules([
143			'name' => 'required\|string\|max:150',
144			'description' => 'nullable\|string\|max:10000',
145			'slug' => 'required\|alpha_dash\|max:150\|unique:'.config('rinvex.attributes.tables.attributes').',slug',
146			'sort_order' => 'nullable\|integer\|max:10000000',
147			'group' => 'nullable\|string\|max:150',
148			'type' => 'required\|string\|max:150',
149			'is_required' => 'sometimes\|boolean',
150			'is_collection' => 'sometimes\|boolean',
151			'default' => 'nullable\|string\|max:10000',
152			]);
153			}
154
155			/**
156			* Set or get the type map for attribute types.
157			*
158			* @param array\|null $map
159			* @param bool $merge
160			*
161			* @return array
162			*/
163			public static function typeMap(array $map = null, $merge = true)
164			{
165			if (is_array($map)) {
166			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...
167			? $map + static::$typeMap : $map;
168			}
169
170			return static::$typeMap;
171			}
172
173			/**
174			* Get the model associated with a custom attribute type.
175			*
176			* @param string $alias
177			*
178			* @return string\|null
179			*/
180			public static function getTypeModel($alias)
181			{
182			return self::$typeMap[$alias] ?? null;
183			}
184
185			/**
186			* Enforce clean groups.
187			*
188			* @param string $value
189			*
190			* @return void
191			*/
192			public function setGroupAttribute($value): void
193			{
194			$this->attributes['group'] = str_slug($value);
195			}
196
197			/**
198			* Access entities relation and retrieve entity types as an array,
199			* Accessors/Mutators preceeds relation value when called dynamically.
200			*
201			* @return array
202			*/
203			public function getEntitiesAttribute(): array
204			{
205			return $this->entities()->pluck('entity_type')->toArray();
206			}
207
208			/**
209			* Set the attribute attached entities.
210			*
211			* @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...
212			*
213			* @return void
214			*/
215			public function setEntitiesAttribute($entities): void
216			{
217			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...
218			$this->entities()->delete();
219			! $entities \|\| $this->entities()->createMany(array_map(function ($entity) {
220			return ['entity_type' => $entity];
221			}, $entities));
222			});
223			}
224
225			/**
226			* Get the options for generating the slug.
227			*
228			* @return \Spatie\Sluggable\SlugOptions
229			*/
230			public function getSlugOptions(): SlugOptions
231			{
232			return SlugOptions::create()
233			->doNotGenerateSlugsOnUpdate()
234			->generateSlugsFrom('name')
235			->saveSlugsTo('slug');
236			}
237
238			/**
239			* Get the entities attached to this attribute.
240			*
241			* @return \Illuminate\Database\Eloquent\Relations\HasMany
242			*/
243			public function entities(): HasMany
244			{
245			return $this->hasMany(config('rinvex.attributes.models.attribute_entity'), 'attribute_id', 'id');
246			}
247
248			/**
249			* Get the entities attached to this attribute.
250			*
251			* @param string $value
252			*
253			* @return \Illuminate\Database\Eloquent\Relations\HasMany
254			*/
255			public function values(string $value): HasMany
256			{
257			return $this->hasMany($value, 'attribute_id', 'id');
258			}
259			}
260

rinvex / laravel-attributes

Push — master ( 338f76...18945f )

Attribute::boot() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like