Tenant::owner() - Code Metrics - Inspection of "Add tag model factory" - rinvex/laravel-tenants - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 903485...edab0c )

by Abdelrahman

created 2018-07-20 17:25 UTC

Tenant::owner() A

↳ Parent: Tenant

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\Tenants\Models;

use Spatie\Sluggable\SlugOptions;
use Rinvex\Support\Traits\HasSlug;
use Illuminate\Database\Eloquent\Model;
use Rinvex\Cacheable\CacheableEloquent;
use Illuminate\Database\Eloquent\Builder;
use Rinvex\Support\Traits\HasTranslations;
use Rinvex\Support\Traits\ValidatingTrait;
use Illuminate\Database\Eloquent\Relations\MorphToMany;

/**
 * Rinvex\Tenants\Models\Tenant.
 *
 * @property int                                                $id
 * @property string                                             $slug
 * @property array                                              $title
 * @property array                                              $description
 * @property int                                                $owner_id
 * @property string                                             $owner_type
 * @property string                                             $email
 * @property string                                             $website
 * @property string                                             $phone
 * @property string                                             $language_code
 * @property string                                             $country_code
 * @property string                                             $state
 * @property string                                             $city
 * @property string                                             $address
 * @property string                                             $postal_code
 * @property string                                             $launch_date
 * @property string                                             $timezone
 * @property string                                             $currency
 * @property string                                             $group
 * @property bool                                               $is_active
 * @property \Carbon\Carbon|null                                $created_at
 * @property \Carbon\Carbon|null                                $updated_at
 * @property \Carbon\Carbon|null                                $deleted_at
 * @property-read \Illuminate\Database\Eloquent\Model|\Eloquent $owner
 *
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant ofOwner(\Illuminate\Database\Eloquent\Model $owner)

 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereAddress($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereCity($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereCountryCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereCurrency($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereDeletedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereDescription($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereGroup($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereIsActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereLanguageCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereLaunchDate($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereTimezone($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereTitle($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereOwnerId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereOwnerType($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant wherePhone($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant wherePostalCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereSlug($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereState($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Tenants\Models\Tenant whereUpdatedAt($value)
 * @mixin \Eloquent
 */
class Tenant extends Model
{
    use HasSlug;
    use HasTranslations;
    use ValidatingTrait;
    use CacheableEloquent;

    /**
     * {@inheritdoc}
     */
    protected $fillable = [
        'slug',
        'name',
        'description',
        'owner_id',
        'owner_type',
        'email',
        'website',
        'phone',
        'language_code',
        'country_code',
        'state',
        'city',
        'address',
        'postal_code',
        'launch_date',
        'timezone',
        'currency',
        'is_active',
    ];

    /**
     * {@inheritdoc}
     */
    protected $casts = [
        'slug' => 'string',
        'owner_id' => 'integer',
        'owner_type' => 'string',
        'email' => 'string',
        'website' => 'string',
        'phone' => 'string',
        'country_code' => 'string',
        'language_code' => 'string',
        'state' => 'string',
        'city' => 'string',
        'address' => 'string',
        'postal_code' => 'string',
        'launch_date' => 'string',
        'timezone' => 'string',
        'currency' => 'string',
        'is_active' => 'boolean',
        'deleted_at' => 'datetime',
    ];

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

    /**
     * The attributes that are translatable.
     *
     * @var array
     */
    public $translatable = [
        'name',
        'description',
    ];

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

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

        $this->setTable(config('rinvex.tenants.tables.tenants'));
        $this->setRules([
            'slug' => 'required|alpha_dash|max:150|unique:'.config('rinvex.tenants.tables.tenants').',slug',
            'name' => 'required|string|max:150',
            'description' => 'nullable|string|max:10000',
            'owner_id' => 'required|integer',
            'owner_type' => 'required|string',
            'email' => 'required|email|min:3|max:150|unique:'.config('rinvex.tenants.tables.tenants').',email',
            'website' => 'nullable|string|max:150',
            'phone' => 'nullable|numeric|phone',
            'country_code' => 'required|alpha|size:2|country',
            'language_code' => 'required|alpha|size:2|language',
            'state' => 'nullable|string',
            'city' => 'nullable|string',
            'address' => 'nullable|string',
            'postal_code' => 'nullable|string',
            'launch_date' => 'nullable|date_format:Y-m-d',
            'timezone' => 'required|string|timezone',
            'currency' => 'required|alpha|size:3',
            'is_active' => 'sometimes|boolean',
        ]);
    }

    /**
     * Get all attached models of the given class to the tenant.
     *
     * @param string $class
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphToMany
     */
    public function entries(string $class): MorphToMany
    {
        return $this->morphedByMany($class, 'tenantable', config('rinvex.tenants.tables.tenantables'), 'tenant_id', 'tenantable_id');

    }

    /**
     * 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 tenant owner.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
     */
    public function owner()
    {
        return $this->morphTo('owner', 'owner_type', 'owner_id');
    }

    /**
     * Determine if the given model is owner of tenant.
     *
     * @param \Illuminate\Database\Eloquent\Model $model
     *
     * @return bool
     */
    public function isOwner(Model $model): bool
    {
        return $model->getKey() === $this->owner->getKey();
    }

    /**
     * Determine if the given model is staff of tenant.
     *
     * @param \Illuminate\Database\Eloquent\Model $model
     *
     * @return bool
     */
    public function isStaff(Model $model): bool
    {
        return $model->tenants->contains($this);
    }

    /**
     * Get tenants of the given owner.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param \Illuminate\Database\Eloquent\Model   $owner
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOfOwner(Builder $builder, Model $owner): Builder
    {
        return $builder->where('owner_type', $owner->getMorphClass())->where('owner_id', $owner->getKey());
    }

    /**
     * Activate the tenant.
     *
     * @return $this
     */
    public function activate()
    {
        $this->update(['is_active' => true]);

        return $this;
    }

    /**
     * Deactivate the tenant.
     *
     * @return $this
     */
    public function deactivate()
    {
        $this->update(['is_active' => false]);

        return $this;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Rinvex\Tenants\Models;
6
7			use Spatie\Sluggable\SlugOptions;
8			use Rinvex\Support\Traits\HasSlug;
9			use Illuminate\Database\Eloquent\Model;
10			use Rinvex\Cacheable\CacheableEloquent;
11			use Illuminate\Database\Eloquent\Builder;
12			use Rinvex\Support\Traits\HasTranslations;
13			use Rinvex\Support\Traits\ValidatingTrait;
14			use Illuminate\Database\Eloquent\Relations\MorphToMany;
15
16			/**
17			* Rinvex\Tenants\Models\Tenant.
18			*
19			* @property int $id
20			* @property string $slug
21			* @property array $title
22			* @property array $description
23			* @property int $owner_id
24			* @property string $owner_type
25			* @property string $email
26			* @property string $website
27			* @property string $phone
28			* @property string $language_code
29			* @property string $country_code
30			* @property string $state
31			* @property string $city
32			* @property string $address
33			* @property string $postal_code
34			* @property string $launch_date
35			* @property string $timezone
36			* @property string $currency
37			* @property string $group
38			* @property bool $is_active
39			* @property \Carbon\Carbon\|null $created_at
40			* @property \Carbon\Carbon\|null $updated_at
41			* @property \Carbon\Carbon\|null $deleted_at
42			* @property-read \Illuminate\Database\Eloquent\Model\|\Eloquent $owner
43			*
44			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant ofOwner(\Illuminate\Database\Eloquent\Model $owner)
			0 ignored issues – show Coding Style introduced 2018-02-15 18:23 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 137 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
45			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereAddress($value)
46			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCity($value)
47			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCountryCode($value)
48			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCreatedAt($value)
49			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCurrency($value)
50			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereDeletedAt($value)
51			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereDescription($value)
52			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereEmail($value)
53			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereGroup($value)
54			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereId($value)
55			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereIsActive($value)
56			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereLanguageCode($value)
57			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereLaunchDate($value)
58			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereTimezone($value)
59			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereTitle($value)
60			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereOwnerId($value)
61			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereOwnerType($value)
62			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant wherePhone($value)
63			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant wherePostalCode($value)
64			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereSlug($value)
65			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereState($value)
66			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereUpdatedAt($value)
67			* @mixin \Eloquent
68			*/
69			class Tenant extends Model
70			{
71			use HasSlug;
72			use HasTranslations;
73			use ValidatingTrait;
74			use CacheableEloquent;
75
76			/**
77			* {@inheritdoc}
78			*/
79			protected $fillable = [
80			'slug',
81			'name',
82			'description',
83			'owner_id',
84			'owner_type',
85			'email',
86			'website',
87			'phone',
88			'language_code',
89			'country_code',
90			'state',
91			'city',
92			'address',
93			'postal_code',
94			'launch_date',
95			'timezone',
96			'currency',
97			'is_active',
98			];
99
100			/**
101			* {@inheritdoc}
102			*/
103			protected $casts = [
104			'slug' => 'string',
105			'owner_id' => 'integer',
106			'owner_type' => 'string',
107			'email' => 'string',
108			'website' => 'string',
109			'phone' => 'string',
110			'country_code' => 'string',
111			'language_code' => 'string',
112			'state' => 'string',
113			'city' => 'string',
114			'address' => 'string',
115			'postal_code' => 'string',
116			'launch_date' => 'string',
117			'timezone' => 'string',
118			'currency' => 'string',
119			'is_active' => 'boolean',
120			'deleted_at' => 'datetime',
121			];
122
123			/**
124			* {@inheritdoc}
125			*/
126			protected $observables = [
127			'validating',
128			'validated',
129			];
130
131			/**
132			* The attributes that are translatable.
133			*
134			* @var array
135			*/
136			public $translatable = [
137			'name',
138			'description',
139			];
140
141			/**
142			* The default rules that the model will validate against.
143			*
144			* @var array
145			*/
146			protected $rules = [];
147
148			/**
149			* Whether the model should throw a
150			* ValidationException if it fails validation.
151			*
152			* @var bool
153			*/
154			protected $throwValidationExceptions = true;
155
156			/**
157			* Create a new Eloquent model instance.
158			*
159			* @param array $attributes
160			*/
161			public function __construct(array $attributes = [])
162			{
163			parent::__construct($attributes);
164
165			$this->setTable(config('rinvex.tenants.tables.tenants'));
166			$this->setRules([
167			'slug' => 'required\|alpha_dash\|max:150\|unique:'.config('rinvex.tenants.tables.tenants').',slug',
168			'name' => 'required\|string\|max:150',
169			'description' => 'nullable\|string\|max:10000',
170			'owner_id' => 'required\|integer',
171			'owner_type' => 'required\|string',
172			'email' => 'required\|email\|min:3\|max:150\|unique:'.config('rinvex.tenants.tables.tenants').',email',
173			'website' => 'nullable\|string\|max:150',
174			'phone' => 'nullable\|numeric\|phone',
175			'country_code' => 'required\|alpha\|size:2\|country',
176			'language_code' => 'required\|alpha\|size:2\|language',
177			'state' => 'nullable\|string',
178			'city' => 'nullable\|string',
179			'address' => 'nullable\|string',
180			'postal_code' => 'nullable\|string',
181			'launch_date' => 'nullable\|date_format:Y-m-d',
182			'timezone' => 'required\|string\|timezone',
183			'currency' => 'required\|alpha\|size:3',
184			'is_active' => 'sometimes\|boolean',
185			]);
186			}
187
188			/**
189			* Get all attached models of the given class to the tenant.
190			*
191			* @param string $class
192			*
193			* @return \Illuminate\Database\Eloquent\Relations\MorphToMany
194			*/
195			public function entries(string $class): MorphToMany
196			{
197			return $this->morphedByMany($class, 'tenantable', config('rinvex.tenants.tables.tenantables'), 'tenant_id', 'tenantable_id');
			0 ignored issues – show Coding Style introduced 2017-09-09 09:34 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 133 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
198			}
199
200			/**
201			* Get the options for generating the slug.
202			*
203			* @return \Spatie\Sluggable\SlugOptions
204			*/
205			public function getSlugOptions(): SlugOptions
206			{
207			return SlugOptions::create()
208			->doNotGenerateSlugsOnUpdate()
209			->generateSlugsFrom('name')
210			->saveSlugsTo('slug');
211			}
212
213			/**
214			* Get the tenant owner.
215			*
216			* @return \Illuminate\Database\Eloquent\Relations\MorphTo
217			*/
218			public function owner()
219			{
220			return $this->morphTo('owner', 'owner_type', 'owner_id');
221			}
222
223			/**
224			* Determine if the given model is owner of tenant.
225			*
226			* @param \Illuminate\Database\Eloquent\Model $model
227			*
228			* @return bool
229			*/
230			public function isOwner(Model $model): bool
231			{
232			return $model->getKey() === $this->owner->getKey();
233			}
234
235			/**
236			* Determine if the given model is staff of tenant.
237			*
238			* @param \Illuminate\Database\Eloquent\Model $model
239			*
240			* @return bool
241			*/
242			public function isStaff(Model $model): bool
243			{
244			return $model->tenants->contains($this);
245			}
246
247			/**
248			* Get tenants of the given owner.
249			*
250			* @param \Illuminate\Database\Eloquent\Builder $builder
251			* @param \Illuminate\Database\Eloquent\Model $owner
252			*
253			* @return \Illuminate\Database\Eloquent\Builder
254			*/
255			public function scopeOfOwner(Builder $builder, Model $owner): Builder
256			{
257			return $builder->where('owner_type', $owner->getMorphClass())->where('owner_id', $owner->getKey());
258			}
259
260			/**
261			* Activate the tenant.
262			*
263			* @return $this
264			*/
265			public function activate()
266			{
267			$this->update(['is_active' => true]);
268
269			return $this;
270			}
271
272			/**
273			* Deactivate the tenant.
274			*
275			* @return $this
276			*/
277			public function deactivate()
278			{
279			$this->update(['is_active' => false]);
280
281			return $this;
282			}
283			}
284

rinvex / laravel-tenants

Push — develop ( 903485...edab0c )

Tenant::owner() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like