Attribute::entities() - Code Metrics - Inspection of "Clearing the Attributable static "cache" when crea..." - rinvex/laravel-attributes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#132)

unknown

created 2020-10-14 13:52 UTC

Attribute::entities() A

↳ Parent: Attribute

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	0

<?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\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;

    /**
     * {@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 entities that need to be attached to this attribute.
     *
     * @var array
     */
    protected $entitiesToSave = [];

    /**
     * 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 = [];

    /**
     * {@inheritdoc}
     */
    public static function boot()
    {
        parent::boot();
        static::saved(function ($attribute) {
            $entities = $attribute->entitiesToSave ?: [];
            $attribute->entities()->delete();
            ! $entities || $attribute->entities()->createMany(array_map(function ($entity) {
                return ['entity_type' => $entity];
            }, $entities));
            $attribute->clearAttributableCache();
        });
        static::deleted(function ($attribute) {
            $attribute->clearAttributableCache();
        });
    }

    /**
     * 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:32768',
            'slug' => 'required|alpha_dash|max:150|unique:'.config('rinvex.attributes.tables.attributes').',slug',
            'sort_order' => 'nullable|integer|max:100000',
            '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:32768',
        ]);
    }

    /**
     * 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() ?: $this->entitiesToSave ?: [];
    }

    /**
     * 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
    {
        $this->entitiesToSave = (array) $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');
    }

    /**
     * Clears the attributable cache for all entities that are attached to this attribute.
     *
     * @return void
     */
    public function clearAttributableCache()
    {
        foreach ($this->entities as $entity) {
            // Ensure that the class exists before creating an instance as the database
            // could contain a model that no longer exists.
            if (class_exists($entity)) {
                $entityInstance = app()->make($entity);
                $entityInstance->clearAttributableCache();
            }
        }
    }
}


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\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 whereSlug($value)
44			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereSortOrder($value)
45			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Attributes\Models\Attribute whereName($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
57			/**
58			* {@inheritdoc}
59			*/
60			protected $fillable = [
61			'name',
62			'slug',
63			'description',
64			'sort_order',
65			'group',
66			'type',
67			'is_required',
68			'is_collection',
69			'default',
70			'entities',
71			];
72
73			/**
74			* {@inheritdoc}
75			*/
76			protected $casts = [
77			'slug' => 'string',
78			'sort_order' => 'integer',
79			'group' => 'string',
80			'type' => 'string',
81			'is_required' => 'boolean',
82			'is_collection' => 'boolean',
83			'default' => 'string',
84			];
85
86			/**
87			* {@inheritdoc}
88			*/
89			protected $observables = [
90			'validating',
91			'validated',
92			];
93
94			/**
95			* {@inheritdoc}
96			*/
97			public $translatable = [
98			'name',
99			'description',
100			];
101
102			/**
103			* {@inheritdoc}
104			*/
105			public $sortable = [
106			'order_column_name' => 'sort_order',
107			];
108
109			/**
110			* The entities that need to be attached to this attribute.
111			*
112			* @var array
113			*/
114			protected $entitiesToSave = [];
115
116			/**
117			* The default rules that the model will validate against.
118			*
119			* @var array
120			*/
121			protected $rules = [];
122
123			/**
124			* Whether the model should throw a
125			* ValidationException if it fails validation.
126			*
127			* @var bool
128			*/
129			protected $throwValidationExceptions = true;
130
131			/**
132			* An array to map class names to their type names in database.
133			*
134			* @var array
135			*/
136			protected static $typeMap = [];
137
138			/**
139			* {@inheritdoc}
140			*/
141			public static function boot()
142			{
143			parent::boot();
144			static::saved(function ($attribute) {
145			$entities = $attribute->entitiesToSave ?: [];
146			$attribute->entities()->delete();
147			! $entities \|\| $attribute->entities()->createMany(array_map(function ($entity) {
148			return ['entity_type' => $entity];
149			}, $entities));
150			$attribute->clearAttributableCache();
151			});
152			static::deleted(function ($attribute) {
153			$attribute->clearAttributableCache();
154			});
155			}
156
157			/**
158			* Create a new Eloquent model instance.
159			*
160			* @param array $attributes
161			*/
162			public function __construct(array $attributes = [])
163			{
164			parent::__construct($attributes);
165
166			$this->setTable(config('rinvex.attributes.tables.attributes'));
167			$this->setRules([
168			'name' => 'required\|string\|strip_tags\|max:150',
169			'description' => 'nullable\|string\|max:32768',
170			'slug' => 'required\|alpha_dash\|max:150\|unique:'.config('rinvex.attributes.tables.attributes').',slug',
171			'sort_order' => 'nullable\|integer\|max:100000',
172			'group' => 'nullable\|string\|strip_tags\|max:150',
173			'type' => 'required\|string\|strip_tags\|max:150',
174			'is_required' => 'sometimes\|boolean',
175			'is_collection' => 'sometimes\|boolean',
176			'default' => 'nullable\|string\|strip_tags\|max:32768',
177			]);
178			}
179
180			/**
181			* Enforce clean slugs.
182			*
183			* @param string $value
184			*
185			* @return void
186			*/
187			public function setSlugAttribute($value): void
188			{
189			$this->attributes['slug'] = Str::slug($value, $this->getSlugOptions()->slugSeparator, $this->getSlugOptions()->slugLanguage);
190			}
191
192			/**
193			* Set or get the type map for attribute types.
194			*
195			* @param array\|null $map
196			* @param bool $merge
197			*
198			* @return array
199			*/
200			public static function typeMap(array $map = null, $merge = true)
201			{
202			if (is_array($map)) {
203			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...
204			? $map + static::$typeMap : $map;
205			}
206
207			return static::$typeMap;
208			}
209
210			/**
211			* Get the model associated with a custom attribute type.
212			*
213			* @param string $alias
214			*
215			* @return string\|null
216			*/
217			public static function getTypeModel($alias)
218			{
219			return self::$typeMap[$alias] ?? null;
220			}
221
222			/**
223			* Access entities relation and retrieve entity types as an array,
224			* Accessors/Mutators preceeds relation value when called dynamically.
225			*
226			* @return array
227			*/
228			public function getEntitiesAttribute(): array
229			{
230			return $this->entities()->pluck('entity_type')->toArray() ?: $this->entitiesToSave ?: [];
231			}
232
233			/**
234			* Set the attribute attached entities.
235			*
236			* @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...
237			* @param mixed $entities
238			*
239			* @return void
240			*/
241			public function setEntitiesAttribute($entities): void
242			{
243			$this->entitiesToSave = (array) $entities;
244			}
245
246			/**
247			* Get the options for generating the slug.
248			*
249			* @return \Spatie\Sluggable\SlugOptions
250			*/
251			public function getSlugOptions(): SlugOptions
252			{
253			return SlugOptions::create()
254			->usingSeparator('_')
255			->doNotGenerateSlugsOnUpdate()
256			->generateSlugsFrom('name')
257			->saveSlugsTo('slug');
258			}
259
260			/**
261			* Get the entities attached to this attribute.
262			*
263			* @return \Illuminate\Database\Eloquent\Relations\HasMany
264			*/
265			public function entities(): HasMany
266			{
267			return $this->hasMany(config('rinvex.attributes.models.attribute_entity'), 'attribute_id', 'id');
268			}
269
270			/**
271			* Get the entities attached to this attribute.
272			*
273			* @param string $value
274			*
275			* @return \Illuminate\Database\Eloquent\Relations\HasMany
276			*/
277			public function values(string $value): HasMany
278			{
279			return $this->hasMany($value, 'attribute_id', 'id');
280			}
281
282			/**
283			* Clears the attributable cache for all entities that are attached to this attribute.
284			*
285			* @return void
286			*/
287			public function clearAttributableCache()
288			{
289			foreach ($this->entities as $entity) {
290			// Ensure that the class exists before creating an instance as the database
291			// could contain a model that no longer exists.
292			if (class_exists($entity)) {
293			$entityInstance = app()->make($entity);
294			$entityInstance->clearAttributableCache();
295			}
296			}
297			}
298			}
299

rinvex / laravel-attributes

Pull Request — develop (#132)

Attribute::entities() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like