flipbox\spark\models\traits\UserTrait

Complexity

Total Complexity

20

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setUserId()	0	15	4
A	getUserId()	0	4	1
A	setUser()	0	20	2
B	getUser()	0	26	5
A	findUserElement()	0	18	4
A	userRules()	0	23	1
A	userFields()	0	7	1
A	userAttributes()	0	7	1
A	userAttributeLabels()	0	7	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipbox/spark/blob/master/LICENSE
 * @link       https://github.com/flipbox/spark
 */

namespace flipbox\spark\models\traits;

use Craft;
use craft\elements\User as UserElement;
use flipbox\spark\helpers\ModelHelper;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
trait UserTrait
{

    /**
     * @var int|null
     */
    private $userId;

    /**
     * @var UserElement|null
     */
    private $user;

    /**
     * Set associated userId
     *
     * @param $id
     * @return $this
     */
    public function setUserId(int $id)
    {

        // Has the id changed?
        if ($id !== $this->userId) {
            // Invalidate existing user
            if ($this->user !== null && $this->user->getId() !== $id) {
                $this->user = null;
            };

            $this->userId = $id;
        }

        return $this;
    }

    /**
     * Get associated userId
     *
     * @return int|null
     */
    public function getUserId()
    {
        return $this->userId;
    }


    /**
     * Associate a user
     *
     * @param $user
     * @return $this
     */
    public function setUser($user)
    {

        // Clear cache
        $this->user = null;

        // Find element
        if (!$user = $this->findUserElement($user)) {
            // Clear property / cache
            $this->userId = $this->user = null;
        } else {
            // Set property
            $this->userId = $user->getId();

            // Set cache
            $this->user = $user;
        }

        return $this;
    }

    /**
     * @return UserElement|null
     */
    public function getUser()
    {

        // Check cache
        if (is_null($this->user)) {
            // Check property
            if (!empty($this->userId)) {
                // Find element
                if ($userElement = Craft::$app->getUsers()->getUserById($this->userId)) {
                    // Set
                    $this->setUser($userElement);
                } else {
                    // Clear property (it's invalid)
                    $this->userId = null;

                    // Prevent subsequent look-ups
                    $this->user = false;

It seems like false of type false is incompatible with the declared type object<craft\elements\User>|null of property $user.

                }
            } else {
                // Prevent subsequent look-ups
                $this->user = false;
            }
        }

        return !$this->user ? null : $this->user;
    }

    /**
     * @param $user
     * @return UserElement|null
     */
    private function findUserElement($user)
    {

        // Element
        if ($user instanceof UserElement) {
            return $user;

            // Id
        } elseif (is_numeric($user)) {
            return Craft::$app->getUsers()->getUserById($user);

            // Username / Email
        } elseif (!is_null($user)) {
            return Craft::$app->getUsers()->getUserByUsernameOrEmail($user);
        }

        return null;
    }

    /**
     * @return array
     */
    protected function userRules(): array
    {

        return [
            [
                [
                    'userId'
                ],
                'number',
                'integerOnly' => true
            ],
            [
                [
                    'userId',
                    'user'
                ],
                'safe',
                'on' => [
                    ModelHelper::SCENARIO_DEFAULT
                ]
            ]
        ];
    }

    /**
     * @return array
     */
    protected function userFields(): array
    {

        return [
            'userId'
        ];
    }

    /**
     * @return array
     */
    protected function userAttributes(): array
    {

        return [
            'userId'
        ];
    }

    /**
     * @return array
     */
    protected function userAttributeLabels(): array
    {

        return [
            'userId' => Craft::t('app', 'User Id')
        ];
    }
}