Tenant::isSuperManager() - Code Metrics - Inspection of "Drop ownership feature of tenants" - rinvex/laravel-tenants - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 7c2b6f...49ae55 )

by Abdelrahman

created 2019-03-03 14:38 UTC

Tenant::isSuperManager() A

↳ Parent: Tenant

Complexity

Conditions	2
Paths	2

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	2
nc	2
nop	1

<?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 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 \Rinvex\Country\Country                       $country
 * @property-read \Rinvex\Language\Language                     $language
 *
 * @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 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',
        'email',
        'website',
        'phone',
        'language_code',
        'country_code',
        'state',
        'city',
        'address',
        'postal_code',
        'launch_date',
        'timezone',
        'currency',
        'is_active',
    ];

    /**
     * {@inheritdoc}
     */
    protected $casts = [
        'slug' => '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',
            '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's country.
     *
     * @return \Rinvex\Country\Country
     */
    public function getCountryAttribute()
    {
        return country($this->country_code);
    }

    /**
     * Get the tenant's language.
     *
     * @return \Rinvex\Language\Language
     */
    public function getLanguageAttribute()
    {
        return language($this->language_code);
    }

    /**
     * Determine if the given model is supermanager of the tenant.
     *
     * @param \Illuminate\Database\Eloquent\Model $model
     *
     * @return bool
     */
    public function isSuperManager(Model $model): bool
    {
        return $this->isManager($model) && $model->isA('supermanager');
    }

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

    /**
     * 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 string $email
24			* @property string $website
25			* @property string $phone
26			* @property string $language_code
27			* @property string $country_code
28			* @property string $state
29			* @property string $city
30			* @property string $address
31			* @property string $postal_code
32			* @property string $launch_date
33			* @property string $timezone
34			* @property string $currency
35			* @property string $group
36			* @property bool $is_active
37			* @property \Carbon\Carbon\|null $created_at
38			* @property \Carbon\Carbon\|null $updated_at
39			* @property \Carbon\Carbon\|null $deleted_at
40			* @property-read \Rinvex\Country\Country $country
41			* @property-read \Rinvex\Language\Language $language
42			*
43			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereAddress($value)
44			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCity($value)
45			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCountryCode($value)
46			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCreatedAt($value)
47			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereCurrency($value)
48			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereDeletedAt($value)
49			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereDescription($value)
50			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereEmail($value)
51			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereGroup($value)
52			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereId($value)
53			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereIsActive($value)
54			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereLanguageCode($value)
55			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereLaunchDate($value)
56			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereTimezone($value)
57			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereTitle($value)
58			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant wherePhone($value)
59			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant wherePostalCode($value)
60			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereSlug($value)
61			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereState($value)
62			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Tenants\Models\Tenant whereUpdatedAt($value)
63			* @mixin \Eloquent
64			*/
65			class Tenant extends Model
66			{
67			use HasSlug;
68			use HasTranslations;
69			use ValidatingTrait;
70			use CacheableEloquent;
71
72			/**
73			* {@inheritdoc}
74			*/
75			protected $fillable = [
76			'slug',
77			'name',
78			'description',
79			'email',
80			'website',
81			'phone',
82			'language_code',
83			'country_code',
84			'state',
85			'city',
86			'address',
87			'postal_code',
88			'launch_date',
89			'timezone',
90			'currency',
91			'is_active',
92			];
93
94			/**
95			* {@inheritdoc}
96			*/
97			protected $casts = [
98			'slug' => 'string',
99			'email' => 'string',
100			'website' => 'string',
101			'phone' => 'string',
102			'country_code' => 'string',
103			'language_code' => 'string',
104			'state' => 'string',
105			'city' => 'string',
106			'address' => 'string',
107			'postal_code' => 'string',
108			'launch_date' => 'string',
109			'timezone' => 'string',
110			'currency' => 'string',
111			'is_active' => 'boolean',
112			'deleted_at' => 'datetime',
113			];
114
115			/**
116			* {@inheritdoc}
117			*/
118			protected $observables = [
119			'validating',
120			'validated',
121			];
122
123			/**
124			* The attributes that are translatable.
125			*
126			* @var array
127			*/
128			public $translatable = [
129			'name',
130			'description',
131			];
132
133			/**
134			* The default rules that the model will validate against.
135			*
136			* @var array
137			*/
138			protected $rules = [];
139
140			/**
141			* Whether the model should throw a
142			* ValidationException if it fails validation.
143			*
144			* @var bool
145			*/
146			protected $throwValidationExceptions = true;
147
148			/**
149			* Create a new Eloquent model instance.
150			*
151			* @param array $attributes
152			*/
153			public function __construct(array $attributes = [])
154			{
155			parent::__construct($attributes);
156
157			$this->setTable(config('rinvex.tenants.tables.tenants'));
158			$this->setRules([
159			'slug' => 'required\|alpha_dash\|max:150\|unique:'.config('rinvex.tenants.tables.tenants').',slug',
160			'name' => 'required\|string\|max:150',
161			'description' => 'nullable\|string\|max:10000',
162			'email' => 'required\|email\|min:3\|max:150\|unique:'.config('rinvex.tenants.tables.tenants').',email',
163			'website' => 'nullable\|string\|max:150',
164			'phone' => 'nullable\|numeric\|phone',
165			'country_code' => 'required\|alpha\|size:2\|country',
166			'language_code' => 'required\|alpha\|size:2\|language',
167			'state' => 'nullable\|string',
168			'city' => 'nullable\|string',
169			'address' => 'nullable\|string',
170			'postal_code' => 'nullable\|string',
171			'launch_date' => 'nullable\|date_format:Y-m-d',
172			'timezone' => 'required\|string\|timezone',
173			'currency' => 'required\|alpha\|size:3',
174			'is_active' => 'sometimes\|boolean',
175			]);
176			}
177
178			/**
179			* Get all attached models of the given class to the tenant.
180			*
181			* @param string $class
182			*
183			* @return \Illuminate\Database\Eloquent\Relations\MorphToMany
184			*/
185			public function entries(string $class): MorphToMany
186			{
187			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...
188			}
189
190			/**
191			* Get the options for generating the slug.
192			*
193			* @return \Spatie\Sluggable\SlugOptions
194			*/
195			public function getSlugOptions(): SlugOptions
196			{
197			return SlugOptions::create()
198			->doNotGenerateSlugsOnUpdate()
199			->generateSlugsFrom('name')
200			->saveSlugsTo('slug');
201			}
202
203			/**
204			* Get the tenant's country.
205			*
206			* @return \Rinvex\Country\Country
207			*/
208			public function getCountryAttribute()
209			{
210			return country($this->country_code);
211			}
212
213			/**
214			* Get the tenant's language.
215			*
216			* @return \Rinvex\Language\Language
217			*/
218			public function getLanguageAttribute()
219			{
220			return language($this->language_code);
221			}
222
223			/**
224			* Determine if the given model is supermanager of the tenant.
225			*
226			* @param \Illuminate\Database\Eloquent\Model $model
227			*
228			* @return bool
229			*/
230			public function isSuperManager(Model $model): bool
231			{
232			return $this->isManager($model) && $model->isA('supermanager');
233			}
234
235			/**
236			* Determine if the given model is manager of the tenant.
237			*
238			* @param \Illuminate\Database\Eloquent\Model $model
239			*
240			* @return bool
241			*/
242			public function isManager(Model $model): bool
243			{
244			return $model->tenants->contains($this);
245			}
246
247			/**
248			* Activate the tenant.
249			*
250			* @return $this
251			*/
252			public function activate()
253			{
254			$this->update(['is_active' => true]);
255
256			return $this;
257			}
258
259			/**
260			* Deactivate the tenant.
261			*
262			* @return $this
263			*/
264			public function deactivate()
265			{
266			$this->update(['is_active' => false]);
267
268			return $this;
269			}
270			}
271

rinvex / laravel-tenants

Push — develop ( 7c2b6f...49ae55 )

Tenant::isSuperManager() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like