User::setupValidation() - Code Metrics - Inspection of "User Administration" - ronanchilvers/deploy - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#50)

by Ronan

created 2021-06-17 07:53 UTC

User::setupValidation() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	14
c	3
b	0
f	0
dl	0
loc	19
ccs	0
cts	3
cp	0
rs	9.7998
cc	1
nc	1
nop	0
crap	2

<?php

namespace App\Model;

use App\Model\Finder\UserFinder;
use Carbon\Carbon;
use Respect\Validation\Validator;
use Ronanchilvers\Orm\Model;
use Ronanchilvers\Orm\Traits\HasValidationTrait;
use Ronanchilvers\Utility\Str;

/**
 * Model representing a project
 *
 * @property int id
 * @property string name
 * @property string email
 * @property string password
 * @property string status
 * @property null|string preferences
 * @property string level
 * @property null|\Carbon\Carbon created
 * @property null|\Carbon\Carbon updated
 * @author Ronan Chilvers <[email protected]>
 */
class User extends Model
{
    const STATUS_ACTIVE   = 'active';
    const STATUS_INACTIVE = 'inactive';
    const STATUS_PENDING  = 'pending';

    const LEVEL_USER      = 'user';
    const LEVEL_ADMIN     = 'admin';

    use HasValidationTrait;

    static protected $finder       = UserFinder::class;
    static protected $columnPrefix = 'user';

    protected $data = [
        'user_status' => 'pending',
        'user_level'  => 'user',
    ];

    /**
     * @author Ronan Chilvers <[email protected]>
     */
    protected function boot()
    {
        $this->addType('datetime', 'last_login');
        $this->addType('array', 'preferences');
    }

    /**
     * @author Ronan Chilvers <[email protected]>
     */
    protected function setupValidation()
    {
        $this->registerRules([
            'name'     => Validator::notEmpty(),
            'email'    => Validator::notEmpty()->email(),
            'password' => Validator::notEmpty(),
            'status'   => Validator::notEmpty()->in([
                static::STATUS_PENDING,
                static::STATUS_INACTIVE,
                static::STATUS_ACTIVE,
            ]),
            'level'   => Validator::notEmpty()->in([
                static::LEVEL_USER,
                static::LEVEL_ADMIN,
            ]),
        ]);
        $this->registerRules([
            'password' => Validator::notEmpty(),
        ], 'security');
    }

    /**
     * Get the user level options for this user
     *
     * @return array
     * @author Ronan Chilvers <[email protected]>
     */
    public function getLevelOptions(): array
    {
        return [
            static::LEVEL_USER => static::LEVEL_USER,
            static::LEVEL_ADMIN => static::LEVEL_ADMIN,
        ];
    }

    /**
     * Get the status options for this user
     *
     * @return array
     * @author Ronan Chilvers <[email protected]>
     */
    public function getStatusOptions(): array
    {
        return [
            static::STATUS_INACTIVE => static::STATUS_INACTIVE,
            static::STATUS_ACTIVE   => static::STATUS_ACTIVE,
        ];
    }

    /**
     * Get a preference by key
     *
     * @param string $key
     * @param mixed $default
     * @author Ronan Chilvers <[email protected]>
     */
    public function preference($key, $default = null)
    {
        $preferences = $this->preferences;
        if (is_null($preferences)) {
            return $default;
        }
        if (!isset($preferences[$key])) {
            return $default;
        }

        return $preferences[$key];
    }

    /**
     * Set a preference value for the user
     *
     * @param $key
     * @param mixed $value
     * @author Ronan Chilvers <[email protected]>
     */
    public function setPreference($key, $value)
    {
        $preferences       = $this->preferences;
        $preferences[$key] = $value;
        $this->preferences = $preferences;

        return $this->save();
    }

    /**
     * Verify a password against this user
     *
     * @param string $password
     * @return boolean
     * @author Ronan Chilvers <[email protected]>
     */
    public function verify($password)
    {
        if (!$this->isLoaded()) {
            return false;
        }

        return password_verify($password, $this->password);
    }

    /**
     * Verify and set a new password
     *
     * @param string $old
     * @param string $new
     * @param string $confirm
     * @return bool
     * @author Ronan Chilvers <[email protected]>
     */
    public function setNewPassword(string $old, string $new, string $confirm)
    {
        foreach (['old', 'new', 'confirm'] as $var) {
            $$var = trim($$var);
        }
        if (!$this->verify($old)) {
            return false;
        }

        if (empty($new)) {
            return false;
        }

        if ($new !== $confirm) {
            return false;
        }

        $this->password = password_hash($new, PASSWORD_DEFAULT);

        return true;
    }

    /**
     * Record a last login timestamp
     *
     * @author Ronan Chilvers <[email protected]>
     */
    public function recordLogin(): bool
    {
        $this->last_login = Carbon::now();


        return $this->save();
    }
}


1			<?php
2
3			namespace App\Model;
4
5			use App\Model\Finder\UserFinder;
6			use Carbon\Carbon;
7			use Respect\Validation\Validator;
8			use Ronanchilvers\Orm\Model;
9			use Ronanchilvers\Orm\Traits\HasValidationTrait;
10			use Ronanchilvers\Utility\Str;
11
12			/**
13			* Model representing a project
14			*
15			* @property int id
16			* @property string name
17			* @property string email
18			* @property string password
19			* @property string status
20			* @property null\|string preferences
21			* @property string level
22			* @property null\|\Carbon\Carbon created
23			* @property null\|\Carbon\Carbon updated
24			* @author Ronan Chilvers <[email protected]>
25			*/
26			class User extends Model
27			{
28			const STATUS_ACTIVE = 'active';
29			const STATUS_INACTIVE = 'inactive';
30			const STATUS_PENDING = 'pending';
31
32			const LEVEL_USER = 'user';
33			const LEVEL_ADMIN = 'admin';
34
35			use HasValidationTrait;
36
37			static protected $finder = UserFinder::class;
38			static protected $columnPrefix = 'user';
39
40			protected $data = [
41			'user_status' => 'pending',
42			'user_level' => 'user',
43			];
44
45			/**
46			* @author Ronan Chilvers <[email protected]>
47			*/
48			protected function boot()
49			{
50			$this->addType('datetime', 'last_login');
51			$this->addType('array', 'preferences');
52			}
53
54			/**
55			* @author Ronan Chilvers <[email protected]>
56			*/
57			protected function setupValidation()
58			{
59			$this->registerRules([
60			'name' => Validator::notEmpty(),
61			'email' => Validator::notEmpty()->email(),
62			'password' => Validator::notEmpty(),
63			'status' => Validator::notEmpty()->in([
64			static::STATUS_PENDING,
65			static::STATUS_INACTIVE,
66			static::STATUS_ACTIVE,
67			]),
68			'level' => Validator::notEmpty()->in([
69			static::LEVEL_USER,
70			static::LEVEL_ADMIN,
71			]),
72			]);
73			$this->registerRules([
74			'password' => Validator::notEmpty(),
75			], 'security');
76			}
77
78			/**
79			* Get the user level options for this user
80			*
81			* @return array
82			* @author Ronan Chilvers <[email protected]>
83			*/
84			public function getLevelOptions(): array
85			{
86			return [
87			static::LEVEL_USER => static::LEVEL_USER,
88			static::LEVEL_ADMIN => static::LEVEL_ADMIN,
89			];
90			}
91
92			/**
93			* Get the status options for this user
94			*
95			* @return array
96			* @author Ronan Chilvers <[email protected]>
97			*/
98			public function getStatusOptions(): array
99			{
100			return [
101			static::STATUS_INACTIVE => static::STATUS_INACTIVE,
102			static::STATUS_ACTIVE => static::STATUS_ACTIVE,
103			];
104			}
105
106			/**
107			* Get a preference by key
108			*
109			* @param string $key
110			* @param mixed $default
111			* @author Ronan Chilvers <[email protected]>
112			*/
113			public function preference($key, $default = null)
114			{
115			$preferences = $this->preferences;
116			if (is_null($preferences)) {
117			return $default;
118			}
119			if (!isset($preferences[$key])) {
120			return $default;
121			}
122
123			return $preferences[$key];
124			}
125
126			/**
127			* Set a preference value for the user
128			*
129			* @param $key
130			* @param mixed $value
131			* @author Ronan Chilvers <[email protected]>
132			*/
133			public function setPreference($key, $value)
134			{
135			$preferences = $this->preferences;
136			$preferences[$key] = $value;
137			$this->preferences = $preferences;
138
139			return $this->save();
140			}
141
142			/**
143			* Verify a password against this user
144			*
145			* @param string $password
146			* @return boolean
147			* @author Ronan Chilvers <[email protected]>
148			*/
149			public function verify($password)
150			{
151			if (!$this->isLoaded()) {
152			return false;
153			}
154
155			return password_verify($password, $this->password);
156			}
157
158			/**
159			* Verify and set a new password
160			*
161			* @param string $old
162			* @param string $new
163			* @param string $confirm
164			* @return bool
165			* @author Ronan Chilvers <[email protected]>
166			*/
167			public function setNewPassword(string $old, string $new, string $confirm)
168			{
169			foreach (['old', 'new', 'confirm'] as $var) {
170			$$var = trim($$var);
171			}
172			if (!$this->verify($old)) {
173			return false;
174			}
175
176			if (empty($new)) {
177			return false;
178			}
179
180			if ($new !== $confirm) {
181			return false;
182			}
183
184			$this->password = password_hash($new, PASSWORD_DEFAULT);
185
186			return true;
187			}
188
189			/**
190			* Record a last login timestamp
191			*
192			* @author Ronan Chilvers <[email protected]>
193			*/
194			public function recordLogin(): bool
195			{
196			$this->last_login = Carbon::now();
			0 ignored issues – show Bug Best Practice introduced 2021-06-16 09:00 UTC by Report Bug Copy Issue Report The property `last_login` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
197
198			return $this->save();
199			}
200			}
201

ronanchilvers / deploy

Pull Request — master (#50)

User::setupValidation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like