User::isForceDeleting() - Code Metrics - Inspection of "Updating the model observers" - ARCANEDEV/LaravelAuth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9)

by ARCANEDEV

created 2016-05-17 12:16 UTC

User::isForceDeleting() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php namespace Arcanedev\LaravelAuth\Models;

use Arcanedev\LaravelAuth\Bases\Model;
use Arcanedev\LaravelAuth\Exceptions\UserConfirmationException;
use Arcanedev\LaravelAuth\Services\UserConfirmator;
use Arcanedev\LaravelAuth\Traits\Activatable;
use Arcanedev\LaravelAuth\Traits\AuthUserTrait;
use Arcanesoft\Contracts\Auth\Models\User as UserContract;
use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Foundation\Auth\Access\Authorizable;

/**
 * Class     User
 *
 * @package  Arcanedev\LaravelAuth\Models
 * @author   ARCANEDEV <[email protected]>
 *
 * @property  int                                       id
 * @property  string                                    username
 * @property  string                                    first_name
 * @property  string                                    last_name
 * @property  string                                    full_name
 * @property  string                                    email
 * @property  string                                    password
 * @property  string                                    remember_token
 * @property  bool                                      is_admin
 * @property  bool                                      is_active
 * @property  bool                                      is_confirmed       (Optional)
 * @property  string                                    confirmation_code  (Optional)
 * @property  \Carbon\Carbon                            confirmed_at       (Optional)
 * @property  \Carbon\Carbon                            created_at
 * @property  \Carbon\Carbon                            updated_at
 * @property  \Carbon\Carbon                            deleted_at
 * @property  \Illuminate\Database\Eloquent\Collection  roles
 * @property  \Illuminate\Database\Eloquent\Collection  permissions
 *
 * @method  static  bool                                   insert(array $values)
 * @method          \Illuminate\Database\Eloquent\Builder  unconfirmed(string $code)
 */
class User

    extends Model
    implements AuthenticatableContract, AuthorizableContract, CanResetPasswordContract, UserContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use Activatable, Authenticatable, Authorizable, AuthUserTrait, CanResetPassword, SoftDeletes;

    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'username', 'first_name', 'last_name', 'email', 'password',
    ];

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden   = [
        'password', 'remember_token', 'confirmation_code',
    ];

    /**
     * The attributes that should be casted to native types.
     *
     * @var array
     */
    protected $casts = [
        'is_admin'     => 'boolean',
        'is_active'    => 'boolean',
        'is_confirmed' => 'boolean',
    ];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [
        'confirmed_at', 'deleted_at'
    ];

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create a new Eloquent model instance.
     *
     * @param  array  $attributes
     */
    public function __construct(array $attributes = [])
    {
        $this->setTable(config('laravel-auth.users.table', 'users'));

        parent::__construct($attributes);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Scopes
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Scope unconfirmed users by code.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  string                                 $code
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeUnconfirmed($query, $code)
    {
        return $query->where('is_confirmed', false)
            ->where('confirmation_code', $code)
            ->whereNull('confirmed_at');
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the full name attribute.
     *
     * @return string
     */
    public function getFullNameAttribute()
    {
        return $this->first_name . ' ' . $this->last_name;
    }

    /**
     * Set the password attribute.
     *
     * @param  string  $password
     */
    public function setPasswordAttribute($password)
    {
        $this->attributes['password'] = bcrypt($password);
    }

    /* ------------------------------------------------------------------------------------------------
     |  CRUD Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Confirm the unconfirmed user account by confirmation code.
     *
     * @param  string  $code
     *
     * @return \Arcanesoft\Contracts\Auth\Models\User
     *
     * @throws \Arcanedev\LaravelAuth\Exceptions\UserConfirmationException
     */
    public function findUnconfirmed($code)
    {
        $unconfirmedUser = self::unconfirmed($code)->first();

        if ( ! $unconfirmedUser instanceof self) {
            throw (new UserConfirmationException)->setModel(self::class);
        }

        return $unconfirmedUser;
    }

    /**
     * Confirm the new user account.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\User|string  $code
     *
     * @return \Arcanesoft\Contracts\Auth\Models\User
     */
    public function confirm($code)
    {
        if ($code instanceof self) {
            $code = $code->confirmation_code;
        }

        $user = $this->findUnconfirmed($code);

        return (new UserConfirmator)->confirm($user);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check if user is an administrator.
     *
     * @return bool
     */
    public function isAdmin()
    {
        return $this->is_admin;
    }

    /**
     * Check if user has a confirmed account.
     *
     * @return bool
     */
    public function isConfirmed()
    {
        return $this->is_confirmed;
    }

    /**
     * Check if user is on force deleting.
     *
     * @return bool
     */
    public function isForceDeleting()
    {
        return $this->forceDeleting;
    }
}


1		<?php namespace Arcanedev\LaravelAuth\Models;
2
3		use Arcanedev\LaravelAuth\Bases\Model;
4		use Arcanedev\LaravelAuth\Exceptions\UserConfirmationException;
5		use Arcanedev\LaravelAuth\Services\UserConfirmator;
6		use Arcanedev\LaravelAuth\Traits\Activatable;
7		use Arcanedev\LaravelAuth\Traits\AuthUserTrait;
8		use Arcanesoft\Contracts\Auth\Models\User as UserContract;
9		use Illuminate\Auth\Authenticatable;
10		use Illuminate\Auth\Passwords\CanResetPassword;
11		use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
12		use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
13		use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
14		use Illuminate\Database\Eloquent\SoftDeletes;
15		use Illuminate\Foundation\Auth\Access\Authorizable;
16
17		/**
18		* Class User
19		*
20		* @package Arcanedev\LaravelAuth\Models
21		* @author ARCANEDEV <[email protected]>
22		*
23		* @property int id
24		* @property string username
25		* @property string first_name
26		* @property string last_name
27		* @property string full_name
28		* @property string email
29		* @property string password
30		* @property string remember_token
31		* @property bool is_admin
32		* @property bool is_active
33		* @property bool is_confirmed (Optional)
34		* @property string confirmation_code (Optional)
35		* @property \Carbon\Carbon confirmed_at (Optional)
36		* @property \Carbon\Carbon created_at
37		* @property \Carbon\Carbon updated_at
38		* @property \Carbon\Carbon deleted_at
39		* @property \Illuminate\Database\Eloquent\Collection roles
40		* @property \Illuminate\Database\Eloquent\Collection permissions
41		*
42		* @method static bool insert(array $values)
43		* @method \Illuminate\Database\Eloquent\Builder unconfirmed(string $code)
44		*/
45		class User
		0 ignored issues – show Bug introduced 2015-12-27 20:26 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: can, getAuthIdentifier, getAuthIdentifierName, getAuthPassword, getEmailForPasswordReset, getRememberToken, getRememberTokenName, setAttribute, setRememberToken Loading history...
46		extends Model
47		implements AuthenticatableContract, AuthorizableContract, CanResetPasswordContract, UserContract
48		{
49		/* ------------------------------------------------------------------------------------------------
50		\| Traits
51		\| ------------------------------------------------------------------------------------------------
52		*/
53		use Activatable, Authenticatable, Authorizable, AuthUserTrait, CanResetPassword, SoftDeletes;
54
55		/* ------------------------------------------------------------------------------------------------
56		\| Properties
57		\| ------------------------------------------------------------------------------------------------
58		*/
59		/**
60		* The attributes that are mass assignable.
61		*
62		* @var array
63		*/
64		protected $fillable = [
65		'username', 'first_name', 'last_name', 'email', 'password',
66		];
67
68		/**
69		* The attributes excluded from the model's JSON form.
70		*
71		* @var array
72		*/
73		protected $hidden = [
74		'password', 'remember_token', 'confirmation_code',
75		];
76
77		/**
78		* The attributes that should be casted to native types.
79		*
80		* @var array
81		*/
82		protected $casts = [
83		'is_admin' => 'boolean',
84		'is_active' => 'boolean',
85		'is_confirmed' => 'boolean',
86		];
87
88		/**
89		* The attributes that should be mutated to dates.
90		*
91		* @var array
92		*/
93		protected $dates = [
94		'confirmed_at', 'deleted_at'
95		];
96
97		/* ------------------------------------------------------------------------------------------------
98		\| Constructor
99		\| ------------------------------------------------------------------------------------------------
100		*/
101		/**
102		* Create a new Eloquent model instance.
103		*
104		* @param array $attributes
105		*/
106	528	public function __construct(array $attributes = [])
107		{
108	528	$this->setTable(config('laravel-auth.users.table', 'users'));
109
110	528	parent::__construct($attributes);
111	528	}
112
113		/* ------------------------------------------------------------------------------------------------
114		\| Scopes
115		\| ------------------------------------------------------------------------------------------------
116		*/
117		/**
118		* Scope unconfirmed users by code.
119		*
120		* @param \Illuminate\Database\Eloquent\Builder $query
121		* @param string $code
122		*
123		* @return \Illuminate\Database\Eloquent\Builder
124		*/
125	32	public function scopeUnconfirmed($query, $code)
126		{
127	32	return $query->where('is_confirmed', false)
128	32	->where('confirmation_code', $code)
129	32	->whereNull('confirmed_at');
130		}
131
132		/* ------------------------------------------------------------------------------------------------
133		\| Getters & Setters
134		\| ------------------------------------------------------------------------------------------------
135		*/
136		/**
137		* Get the full name attribute.
138		*
139		* @return string
140		*/
141	8	public function getFullNameAttribute()
142		{
143	8	return $this->first_name . ' ' . $this->last_name;
144		}
145
146		/**
147		* Set the password attribute.
148		*
149		* @param string $password
150		*/
151	160	public function setPasswordAttribute($password)
152		{
153	160	$this->attributes['password'] = bcrypt($password);
154	160	}
155
156		/* ------------------------------------------------------------------------------------------------
157		\| CRUD Functions
158		\| ------------------------------------------------------------------------------------------------
159		*/
160		/**
161		* Confirm the unconfirmed user account by confirmation code.
162		*
163		* @param string $code
164		*
165		* @return \Arcanesoft\Contracts\Auth\Models\User
166		*
167		* @throws \Arcanedev\LaravelAuth\Exceptions\UserConfirmationException
168		*/
169	32	public function findUnconfirmed($code)
170		{
171	32	$unconfirmedUser = self::unconfirmed($code)->first();
172
173	32	if ( ! $unconfirmedUser instanceof self) {
174	8	throw (new UserConfirmationException)->setModel(self::class);
175		}
176
177	24	return $unconfirmedUser;
178		}
179
180		/**
181		* Confirm the new user account.
182		*
183		* @param \Arcanesoft\Contracts\Auth\Models\User\|string $code
184		*
185		* @return \Arcanesoft\Contracts\Auth\Models\User
186		*/
187	16	public function confirm($code)
188		{
189	16	if ($code instanceof self) {
190	8	$code = $code->confirmation_code;
191	6	}
192
193	16	$user = $this->findUnconfirmed($code);
194
195	16	return (new UserConfirmator)->confirm($user);
196		}
197
198		/* ------------------------------------------------------------------------------------------------
199		\| Check Functions
200		\| ------------------------------------------------------------------------------------------------
201		*/
202		/**
203		* Check if user is an administrator.
204		*
205		* @return bool
206		*/
207	40	public function isAdmin()
208		{
209	40	return $this->is_admin;
210		}
211
212		/**
213		* Check if user has a confirmed account.
214		*
215		* @return bool
216		*/
217	24	public function isConfirmed()
218		{
219	24	return $this->is_confirmed;
220		}
221
222		/**
223		* Check if user is on force deleting.
224		*
225		* @return bool
226		*/
227	16	public function isForceDeleting()
228		{
229	16	return $this->forceDeleting;
230		}
231		}
232

ARCANEDEV / LaravelAuth

Pull Request — master (#9)

User::isForceDeleting() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like