rhosocial\user\models\UserUsernameTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

83.87%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	hasEnabledUsername()	0	7	4
A	getUsername()	0	10	2
A	removeUsername()	0	4	1
A	createUsername()	0	14	3
A	setUsername()	0	11	4

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link https://vistart.me/
 * @copyright Copyright (c) 2016 - 2017 vistart
 * @license https://vistart.me/license/
 */

namespace rhosocial\user\models;

use rhosocial\base\models\queries\BaseBlameableQuery;

/**
 * Trait UserUsernameTrait
 *
 * @property string|Username $username
 * @package rhosocial\user\models
 * @version 1.0
 * @author vistart <i@vistart.me>
 */
trait UserUsernameTrait
{
    public $usernameClass = false;

    /**
     * Check whether this user enables the username feature or not.
     * @return boolean
     */
    public function hasEnabledUsername()
    {
        if ($this->usernameClass === false || !is_string($this->usernameClass) || !class_exists($this->usernameClass)) {
            return false;
        }
        return true;
    }

    /**
     * Get username.
     * This method may return null, please consider processing the abnormal conditions.
     * @return BaseBlameableQuery
     */
    public function getUsername()
    {
        if (!$this->hasEnabledUsername()) {
            return null;
        }
        $usernameClass = $this->usernameClass;
        $noInit = $usernameClass::buildNoInitModel();
        /* @var $noInit Username */
        return $this->hasOne($usernameClass, [$noInit->createdByAttribute => $this->guidAttribute]);

It seems like hasOne() must be provided by classes using this trait. How about adding it as abstract method to this trait?

The property guidAttribute does not exist. Did you maybe forget to declare it?

    }

    /**
     * Create or get username.
     * @param $username
     * @return null|Username
     */
    public function createUsername($username)
    {
        if (!$this->hasEnabledUsername()) {
            return null;
        }
        $usernameClass = $this->usernameClass;
        $model = $usernameClass::findOne($this->getGUID());

It seems like getGUID() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if (!$model) {
            $model = $this->create($usernameClass);

The method create() does not exist on rhosocial\user\models\UserUsernameTrait. Did you maybe mean createUsername()?

            $model->setGUID($this->getGUID());

It seems like getGUID() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
        $model->content = $username;
        return $model;
    }

    /**
     * Set username.
     * @param string|Username $username
     * @return bool
     */
    public function setUsername($username = null)
    {
        if ($username === null && ($model = $this->getUsername()->one())) {
            return $model->delete() > 0;
        }
        if ($username instanceof Username) {
            $username = $username->content;
        }
        $model = $this->createUsername($username);
        return $model->save();
    }

    /**
     * Remove username.
     * @return bool
     */
    public function removeUsername()
    {
        return $this->setUsername(null);
    }
}