Contact::setSourceAttribute() - Code Metrics - Inspection of "Simplify contact fields" - rinvex/laravel-contacts - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 47820c...92d367 )

by Abdelrahman

created 2018-03-24 06:01 UTC

Contact::setSourceAttribute() A

↳ Parent: Contact

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Rinvex\Contacts\Models;

use Illuminate\Database\Eloquent\Model;
use Rinvex\Cacheable\CacheableEloquent;
use Illuminate\Database\Eloquent\Builder;
use Rinvex\Support\Traits\ValidatingTrait;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

/**
 * Rinvex\Contacts\Models\Contact.
 *
 * @property int                                                                             $id
 * @property int                                                                             $entity_id
 * @property string                                                                          $entity_type
 * @property string                                                                          $source
 * @property string                                                                          $method
 * @property string                                                                          $full_name
 * @property string                                                                          $title
 * @property string                                                                          $email
 * @property string                                                                          $phone
 * @property string                                                                          $fax
 * @property string                                                                          $skype
 * @property string                                                                          $twitter
 * @property string                                                                          $facebook
 * @property string                                                                          $google_plus
 * @property string                                                                          $linkedin
 * @property string                                                                          $country_code
 * @property string                                                                          $language_code
 * @property string                                                                          $birthday
 * @property string                                                                          $gender
 * @property \Carbon\Carbon|null                                                             $created_at
 * @property \Carbon\Carbon|null                                                             $updated_at
 * @property-read \Illuminate\Database\Eloquent\Collection|\Rinvex\Contacts\Models\Contact[] $backRelatives
 * @property-read \Illuminate\Database\Eloquent\Model|\Eloquent                              $entity
 * @property-read string                                                                     $name
 * @property-read \Illuminate\Database\Eloquent\Collection|\Rinvex\Contacts\Models\Contact[] $relatives
 *
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact country($countryCode)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact language($languageCode)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact method($method)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact source($source)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereBirthday($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereCountryCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereEmail($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereEntityId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereEntityType($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereFacebook($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereFax($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereFullName($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereGender($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereGooglePlus($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereLanguageCode($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereLinkedin($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereMethod($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact wherePhone($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereSkype($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereSource($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereTitle($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereTwitter($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\Rinvex\Contacts\Models\Contact whereUpdatedAt($value)
 * @mixin \Eloquent
 */
class Contact extends Model
{
    use ValidatingTrait;
    use CacheableEloquent;

    /**
     * {@inheritdoc}
     */
    protected $fillable = [
        'entity_id',
        'entity_type',
        'source',
        'method',
        'full_name',
        'title',
        'email',
        'phone',
        'fax',
        'skype',
        'twitter',
        'facebook',
        'google_plus',
        'linkedin',
        'country_code',
        'language_code',
        'birthday',
        'gender',
    ];

    /**
     * {@inheritdoc}
     */
    protected $casts = [
        'entity_id' => 'integer',
        'entity_type' => 'string',
        'source' => 'string',
        'method' => 'string',
        'full_name' => 'string',
        'title' => 'string',
        'email' => 'string',
        'phone' => 'string',
        'fax' => 'string',
        'skype' => 'string',
        'twitter' => 'string',
        'facebook' => 'string',
        'google_plus' => 'string',
        'linkedin' => 'string',
        'country_code' => 'string',
        'language_code' => 'string',
        'birthday' => 'string',
        'gender' => 'string',
        'deleted_at' => 'datetime',
    ];

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

    /**
     * The default rules that the model will validate against.
     *
     * @var array
     */
    protected $rules = [
        'entity_id' => 'required|integer',
        'entity_type' => 'required|string|max:150',
        'source' => 'required|string|max:150',
        'method' => 'nullable|string|max:150',
        'full_name' => 'required|string|max:150',
        'title' => 'nullable|string|max:150',
        'email' => 'nullable|email|min:3|max:150',
        'phone' => 'nullable|numeric|phone',
        'fax' => 'nullable|string|max:150',
        'skype' => 'nullable|string|max:150',
        'twitter' => 'nullable|string|max:150',
        'facebook' => 'nullable|string|max:150',
        'google_plus' => 'nullable|string|max:150',
        'linkedin' => 'nullable|string|max:150',
        'country_code' => 'nullable|alpha|size:2|country',
        'language_code' => 'nullable|alpha|size:2|language',
        'birthday' => 'nullable|date_format:Y-m-d',
        'gender' => 'nullable|string|in:male,female',
    ];

    /**
     * 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.contacts.tables.contacts'));
    }

    /**
     * Get the owner model of the contact.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
     */
    public function entity(): MorphTo
    {
        return $this->morphTo('entity', 'entity_type', 'entity_id');
    }

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

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

    /**
     * Scope contacts by the given country.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string                                $countryCode
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeCountry(Builder $builder, string $countryCode): Builder
    {
        return $builder->where('country_code', $countryCode);
    }

    /**
     * Scope contacts by the given language.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string                                $languageCode
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeLanguage(Builder $builder, string $languageCode): Builder
    {
        return $builder->where('language_code', $languageCode);
    }

    /**
     * Scope contacts by the given source.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string                                $source
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeSource(Builder $builder, string $source): Builder
    {
        return $builder->where('source', $source);
    }

    /**
     * Scope contacts by the given method.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param string                                $method
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeMethod(Builder $builder, string $method): Builder
    {
        return $builder->where('method', $method);
    }

    /**
     * A contact may have multiple related contacts.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function relatives(): BelongsToMany
    {
        return $this->belongsToMany(self::class, config('rinvex.contacts.tables.contact_relations'), 'contact_id', 'related_id')

                    ->withPivot('relation')->withTimestamps();
    }

    /**
     * A contact may be related to multiple contacts.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function backRelatives(): BelongsToMany
    {
        return $this->belongsToMany(self::class, config('rinvex.contacts.tables.contact_relations'), 'related_id', 'contact_id')

                    ->withPivot('relation')->withTimestamps();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Rinvex\Contacts\Models;
6
7			use Illuminate\Database\Eloquent\Model;
8			use Rinvex\Cacheable\CacheableEloquent;
9			use Illuminate\Database\Eloquent\Builder;
10			use Rinvex\Support\Traits\ValidatingTrait;
11			use Illuminate\Database\Eloquent\Relations\MorphTo;
12			use Illuminate\Database\Eloquent\Relations\BelongsToMany;
13
14			/**
15			* Rinvex\Contacts\Models\Contact.
16			*
17			* @property int $id
18			* @property int $entity_id
19			* @property string $entity_type
20			* @property string $source
21			* @property string $method
22			* @property string $full_name
23			* @property string $title
24			* @property string $email
25			* @property string $phone
26			* @property string $fax
27			* @property string $skype
28			* @property string $twitter
29			* @property string $facebook
30			* @property string $google_plus
31			* @property string $linkedin
32			* @property string $country_code
33			* @property string $language_code
34			* @property string $birthday
35			* @property string $gender
36			* @property \Carbon\Carbon\|null $created_at
37			* @property \Carbon\Carbon\|null $updated_at
38			* @property-read \Illuminate\Database\Eloquent\Collection\|\Rinvex\Contacts\Models\Contact[] $backRelatives
39			* @property-read \Illuminate\Database\Eloquent\Model\|\Eloquent $entity
40			* @property-read string $name
41			* @property-read \Illuminate\Database\Eloquent\Collection\|\Rinvex\Contacts\Models\Contact[] $relatives
42			*
43			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact country($countryCode)
44			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact language($languageCode)
45			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact method($method)
46			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact source($source)
47			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereBirthday($value)
48			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereCountryCode($value)
49			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereCreatedAt($value)
50			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereEmail($value)
51			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereEntityId($value)
52			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereEntityType($value)
53			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereFacebook($value)
54			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereFax($value)
55			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereFullName($value)
56			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereGender($value)
57			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereGooglePlus($value)
58			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereId($value)
59			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereLanguageCode($value)
60			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereLinkedin($value)
61			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereMethod($value)
62			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact wherePhone($value)
63			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereSkype($value)
64			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereSource($value)
65			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereTitle($value)
66			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereTwitter($value)
67			* @method static \Illuminate\Database\Eloquent\Builder\|\Rinvex\Contacts\Models\Contact whereUpdatedAt($value)
68			* @mixin \Eloquent
69			*/
70			class Contact extends Model
71			{
72			use ValidatingTrait;
73			use CacheableEloquent;
74
75			/**
76			* {@inheritdoc}
77			*/
78			protected $fillable = [
79			'entity_id',
80			'entity_type',
81			'source',
82			'method',
83			'full_name',
84			'title',
85			'email',
86			'phone',
87			'fax',
88			'skype',
89			'twitter',
90			'facebook',
91			'google_plus',
92			'linkedin',
93			'country_code',
94			'language_code',
95			'birthday',
96			'gender',
97			];
98
99			/**
100			* {@inheritdoc}
101			*/
102			protected $casts = [
103			'entity_id' => 'integer',
104			'entity_type' => 'string',
105			'source' => 'string',
106			'method' => 'string',
107			'full_name' => 'string',
108			'title' => 'string',
109			'email' => 'string',
110			'phone' => 'string',
111			'fax' => 'string',
112			'skype' => 'string',
113			'twitter' => 'string',
114			'facebook' => 'string',
115			'google_plus' => 'string',
116			'linkedin' => 'string',
117			'country_code' => 'string',
118			'language_code' => 'string',
119			'birthday' => 'string',
120			'gender' => 'string',
121			'deleted_at' => 'datetime',
122			];
123
124			/**
125			* {@inheritdoc}
126			*/
127			protected $observables = [
128			'validating',
129			'validated',
130			];
131
132			/**
133			* The default rules that the model will validate against.
134			*
135			* @var array
136			*/
137			protected $rules = [
138			'entity_id' => 'required\|integer',
139			'entity_type' => 'required\|string\|max:150',
140			'source' => 'required\|string\|max:150',
141			'method' => 'nullable\|string\|max:150',
142			'full_name' => 'required\|string\|max:150',
143			'title' => 'nullable\|string\|max:150',
144			'email' => 'nullable\|email\|min:3\|max:150',
145			'phone' => 'nullable\|numeric\|phone',
146			'fax' => 'nullable\|string\|max:150',
147			'skype' => 'nullable\|string\|max:150',
148			'twitter' => 'nullable\|string\|max:150',
149			'facebook' => 'nullable\|string\|max:150',
150			'google_plus' => 'nullable\|string\|max:150',
151			'linkedin' => 'nullable\|string\|max:150',
152			'country_code' => 'nullable\|alpha\|size:2\|country',
153			'language_code' => 'nullable\|alpha\|size:2\|language',
154			'birthday' => 'nullable\|date_format:Y-m-d',
155			'gender' => 'nullable\|string\|in:male,female',
156			];
157
158			/**
159			* Whether the model should throw a
160			* ValidationException if it fails validation.
161			*
162			* @var bool
163			*/
164			protected $throwValidationExceptions = true;
165
166			/**
167			* Create a new Eloquent model instance.
168			*
169			* @param array $attributes
170			*/
171			public function __construct(array $attributes = [])
172			{
173			parent::__construct($attributes);
174
175			$this->setTable(config('rinvex.contacts.tables.contacts'));
176			}
177
178			/**
179			* Get the owner model of the contact.
180			*
181			* @return \Illuminate\Database\Eloquent\Relations\MorphTo
182			*/
183			public function entity(): MorphTo
184			{
185			return $this->morphTo('entity', 'entity_type', 'entity_id');
186			}
187
188			/**
189			* Enforce clean sources.
190			*
191			* @param string $value
192			*
193			* @return void
194			*/
195			public function setSourceAttribute($value): void
196			{
197			$this->attributes['source'] = str_slug($value);
198			}
199
200			/**
201			* Enforce clean methods.
202			*
203			* @param string $value
204			*
205			* @return void
206			*/
207			public function setMethodAttribute($value): void
208			{
209			$this->attributes['method'] = str_slug($value);
210			}
211
212			/**
213			* Scope contacts by the given country.
214			*
215			* @param \Illuminate\Database\Eloquent\Builder $builder
216			* @param string $countryCode
217			*
218			* @return \Illuminate\Database\Eloquent\Builder
219			*/
220			public function scopeCountry(Builder $builder, string $countryCode): Builder
221			{
222			return $builder->where('country_code', $countryCode);
223			}
224
225			/**
226			* Scope contacts by the given language.
227			*
228			* @param \Illuminate\Database\Eloquent\Builder $builder
229			* @param string $languageCode
230			*
231			* @return \Illuminate\Database\Eloquent\Builder
232			*/
233			public function scopeLanguage(Builder $builder, string $languageCode): Builder
234			{
235			return $builder->where('language_code', $languageCode);
236			}
237
238			/**
239			* Scope contacts by the given source.
240			*
241			* @param \Illuminate\Database\Eloquent\Builder $builder
242			* @param string $source
243			*
244			* @return \Illuminate\Database\Eloquent\Builder
245			*/
246			public function scopeSource(Builder $builder, string $source): Builder
247			{
248			return $builder->where('source', $source);
249			}
250
251			/**
252			* Scope contacts by the given method.
253			*
254			* @param \Illuminate\Database\Eloquent\Builder $builder
255			* @param string $method
256			*
257			* @return \Illuminate\Database\Eloquent\Builder
258			*/
259			public function scopeMethod(Builder $builder, string $method): Builder
260			{
261			return $builder->where('method', $method);
262			}
263
264			/**
265			* A contact may have multiple related contacts.
266			*
267			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
268			*/
269			public function relatives(): BelongsToMany
270			{
271			return $this->belongsToMany(self::class, config('rinvex.contacts.tables.contact_relations'), 'contact_id', 'related_id')
			0 ignored issues – show Coding Style introduced 2017-07-21 22:53 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 128 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...
272			->withPivot('relation')->withTimestamps();
273			}
274
275			/**
276			* A contact may be related to multiple contacts.
277			*
278			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
279			*/
280			public function backRelatives(): BelongsToMany
281			{
282			return $this->belongsToMany(self::class, config('rinvex.contacts.tables.contact_relations'), 'related_id', 'contact_id')
			0 ignored issues – show Coding Style introduced 2017-07-21 22:53 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 128 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...
283			->withPivot('relation')->withTimestamps();
284			}
285			}
286

rinvex / laravel-contacts

Push — develop ( 47820c...92d367 )

Contact::setSourceAttribute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like