App\Model\User

Complexity

Total Complexity

13

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	boot()	0	3	1
A	setPreference()	0	7	1
A	preference()	0	11	3
A	setupValidation()	0	11	1
A	verify()	0	7	2
A	setNewPassword()	0	20	5

<?php

namespace App\Model;

use App\Model\Finder\UserFinder;
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 null|\Carbon\Carbon created
 * @property null|\Carbon\Carbon updated
 * @author Ronan Chilvers <ronan@d3r.com>
 */
class User extends Model
{
    const STATUS_ACTIVE   = 'active';
    const STATUS_INACTIVE = 'inactive';

    use HasValidationTrait;

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

    protected $data = [
        'user_status' => 'active',
    ];

    /**
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    protected function boot()
    {
        $this->addType('array', 'preferences');
    }

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

    /**
     * Get a preference by key
     *
     * @param string $key
     * @param mixed $default
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    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 <ronan@d3r.com>
     */
    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 <ronan@d3r.com>
     */
    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 <ronan@d3r.com>
     */
    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;
    }
}