BaseMongoBlameableModel::findByIdentity() - Code Metrics - Inspection of "change mongodb guid reference design pattern." - rhosocial/yii2-base-models - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bd75c7...426d7c )

by vistart

created 2017-01-28 15:57 UTC

BaseMongoBlameableModel::findByIdentity() A

↳ Parent: BaseMongoBlameableModel

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

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

<?php

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

namespace rhosocial\base\models\models;

use MongoDB\BSON\Binary;
use rhosocial\base\helpers\Number;
use rhosocial\base\models\models\BaseUserModel;
use rhosocial\base\models\queries\BaseMongoBlameableQuery;
use rhosocial\base\models\traits\BlameableTrait;
use yii\web\IdentityInterface;

/**
 * Description of BaseMongoBlameableModel
 *
 * @version 1.0
 * @author vistart <[email protected]>
 */
abstract class BaseMongoBlameableModel extends BaseMongoEntityModel
{
    use BlameableTrait;

    /**
     * Initialize the blameable model.
     * If query class is not specified, [[BaseMongoBlameableQuery]] will be taken.
     */
    public function init()
    {
        if (!is_string($this->queryClass) || empty($this->queryClass)) {
            $this->queryClass = BaseMongoBlameableQuery::class;
        }
        if ($this->skipInit) {
            return;
        }
        $this->initBlameableEvents();
        parent::init();
    }

    /**
     * Get the query class with specified identity.
     * @param BaseUserModel $identity
     * @return BaseMongoBlameableQuery
     */
    public static function findByIdentity($identity = null)
    {
        return static::find()->byIdentity($identity);
    }

    /**
     * Because every document has a `MongoId" class, this class no longer needs GUID feature.
     * @var boolean determines whether enable the GUID features.
     */
    public $guidAttribute = false;
    public $idAttribute = '_id';

    /**
     * @inheritdoc
     * You can override this method if enabled fields cannot meet your requirements.
     * @return array
     */
    public function attributes()
    {
        return $this->enabledFields();
    }

    /**
     * Get blame who owned this blameable model.
     * NOTICE! This method will not check whether `$userClass` exists. You should
     * specify it in `init()` method.
     * @return BaseUserQuery user.
     */
    public function getHost()
    {
        $hostClass = $this->hostClass;
        $user = $hostClass::buildNoInitModel();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        /* @var BaseUserModel $user */
        return $this->hasOne($hostClass::className(), ['refGUID' => 'createdByAttribute']);
    }
    
    public function getCreatedByAttribute()
    {
        $createdByAttribute = $this->createdByAttribute;
        return (!is_string($createdByAttribute) || empty($createdByAttribute)) ? null : $this->$createdByAttribute->getData();
    }
    
    /**
     * 
     * @param IdentityInterface $host
     * @return boolean
     */
    public function setHost($host)
    {
        if ($host instanceof $this->hostClass || $host instanceof IdentityInterface) {
            return $this->{$this->createdByAttribute} = new Binary($host->getGUID(), Binary::TYPE_UUID);
        }
        if (is_string($host) && preg_match(Number::GUID_REGEX, $host)) {
            return $this->{$this->createdByAttribute} = new Binary(Number::guid_bin($host), Binary::TYPE_UUID);
        }
        if (strlen($host) == 16) {
            return $this->{$this->createdByAttribute} = new Binary($host, Binary::TYPE_UUID);
        }
        return false;
    }

    /**
     * Get updater who updated this blameable model recently.
     * NOTICE! This method will not check whether `$userClass` exists. You should
     * specify it in `init()` method.
     * @return BaseUserQuery user.
     */
    public function getUpdater()
    {
        if (!is_string($this->updatedByAttribute) || empty($this->updatedByAttribute)) {
            return null;
        }
        $hostClass = $this->hostClass;
        $host = $hostClass::buildNoInitModel();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        /* @var $user BaseUserModel */
        return $this->hasOne($hostClass::className(), ['refGUID' => 'updatedByAttribute']);
    }
    
    public function getUpdatedByAttribute()
    {
        $updatedByAttribute = $this->updatedByAttribute;
        return (!is_string($updatedByAttribute) || empty($updatedByAttribute)) ? null : $this->$updatedByAttribute->getData();
    }
    
    /**
     * 
     * @param IdentityInterface $user
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return boolean
     */
    public function setUpdater($updater)
    {
        if (!is_string($this->updatedByAttribute) || empty($this->updatedByAttribute)) {
            return false;
        }
        if ($updater instanceof $this->hostClass || $updater instanceof IdentityInterface) {
            return $this->{$this->updatedByAttribute} = new Binary($updater->getGUID(), Binary::TYPE_UUID);
        }
        if (is_string($updater) && preg_match(Number::GUID_REGEX, $updater)) {
            return $this->{$this->updatedByAttribute} = new Binary(Number::guid_bin($updater), Binary::TYPE_UUID);
        }
        if (strlen($updater) == 16) {
            return $this->{$this->updatedByAttribute} = new Binary($updater, Binary::TYPE_UUID);
        }
        return false;
    }

    /**
     * Return the current user's GUID if current model doesn't specify the owner
     * yet, or return the owner's GUID if current model has been specified.
     * This method is ONLY used for being triggered by event. DO NOT call,
     * override or modify it directly, unless you know the consequences.
     * @param ModelEvent $event
     * @return string the GUID of current user or the owner.
     */
    public function onGetCurrentUserGuid($event)
    {
        $sender = $event->sender;
        /* @var $sender static */
        if (isset($sender->attributes[$sender->createdByAttribute])) {
            return $sender->attributes[$sender->createdByAttribute];
        }
        $identity = \Yii::$app->user->identity;
        /* @var BaseUserModel $identity */
        if ($identity) {
            return $identity->getReadableGUID();
        }
    }
}


1		<?php
2
3		/**
4		* _ __ __ _____ _____ ___ ____ _____
5		* \| \| / // // ___//_ _// \|\| __\|\|_ _\|
6		* \| \|/ // /(__ ) / / / /\| \|\| \| \| \|
7		* \|___//_//____/ /_/ /_/ \|_\|\|_\| \|_\|
8		* @link https://vistart.me/
9		* @copyright Copyright (c) 2016 - 2017 vistart
10		* @license https://vistart.me/license/
11		*/
12
13		namespace rhosocial\base\models\models;
14
15		use MongoDB\BSON\Binary;
16		use rhosocial\base\helpers\Number;
17		use rhosocial\base\models\models\BaseUserModel;
18		use rhosocial\base\models\queries\BaseMongoBlameableQuery;
19		use rhosocial\base\models\traits\BlameableTrait;
20		use yii\web\IdentityInterface;
21
22		/**
23		* Description of BaseMongoBlameableModel
24		*
25		* @version 1.0
26		* @author vistart <[email protected]>
27		*/
28		abstract class BaseMongoBlameableModel extends BaseMongoEntityModel
29		{
30		use BlameableTrait;
31
32		/**
33		* Initialize the blameable model.
34		* If query class is not specified, [[BaseMongoBlameableQuery]] will be taken.
35		*/
36	12	public function init()
37		{
38	12	if (!is_string($this->queryClass) \|\| empty($this->queryClass)) {
39	12	$this->queryClass = BaseMongoBlameableQuery::class;
40		}
41	12	if ($this->skipInit) {
42	12	return;
43		}
44	12	$this->initBlameableEvents();
45	12	parent::init();
46	12	}
47
48		/**
49		* Get the query class with specified identity.
50		* @param BaseUserModel $identity
51		* @return BaseMongoBlameableQuery
52		*/
53	3	public static function findByIdentity($identity = null)
54		{
55	3	return static::find()->byIdentity($identity);
56		}
57
58		/**
59		* Because every document has a `MongoId" class, this class no longer needs GUID feature.
60		* @var boolean determines whether enable the GUID features.
61		*/
62		public $guidAttribute = false;
63		public $idAttribute = '_id';
64
65		/**
66		* @inheritdoc
67		* You can override this method if enabled fields cannot meet your requirements.
68		* @return array
69		*/
70	12	public function attributes()
71		{
72	12	return $this->enabledFields();
73		}
74
75		/**
76		* Get blame who owned this blameable model.
77		* NOTICE! This method will not check whether `$userClass` exists. You should
78		* specify it in `init()` method.
79		* @return BaseUserQuery user.
80		*/
81		public function getHost()
82		{
83		$hostClass = $this->hostClass;
84		$user = $hostClass::buildNoInitModel();
		0 ignored issues – show Unused Code introduced 2017-01-28 16:05 UTC by Report Bug Copy Issue Report `$user` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
85		/* @var BaseUserModel $user */
86		return $this->hasOne($hostClass::className(), ['refGUID' => 'createdByAttribute']);
87		}
88
89		public function getCreatedByAttribute()
90		{
91		$createdByAttribute = $this->createdByAttribute;
92		return (!is_string($createdByAttribute) \|\| empty($createdByAttribute)) ? null : $this->$createdByAttribute->getData();
93		}
94
95		/**
96		*
97		* @param IdentityInterface $host
98		* @return boolean
99		*/
100	12	public function setHost($host)
101		{
102	12	if ($host instanceof $this->hostClass \|\| $host instanceof IdentityInterface) {
103	12	return $this->{$this->createdByAttribute} = new Binary($host->getGUID(), Binary::TYPE_UUID);
104		}
105		if (is_string($host) && preg_match(Number::GUID_REGEX, $host)) {
106		return $this->{$this->createdByAttribute} = new Binary(Number::guid_bin($host), Binary::TYPE_UUID);
107		}
108		if (strlen($host) == 16) {
109		return $this->{$this->createdByAttribute} = new Binary($host, Binary::TYPE_UUID);
110		}
111		return false;
112		}
113
114		/**
115		* Get updater who updated this blameable model recently.
116		* NOTICE! This method will not check whether `$userClass` exists. You should
117		* specify it in `init()` method.
118		* @return BaseUserQuery user.
119		*/
120		public function getUpdater()
121		{
122		if (!is_string($this->updatedByAttribute) \|\| empty($this->updatedByAttribute)) {
123		return null;
124		}
125		$hostClass = $this->hostClass;
126		$host = $hostClass::buildNoInitModel();
		0 ignored issues – show Unused Code introduced 2017-01-28 16:05 UTC by Report Bug Copy Issue Report `$host` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
127		/* @var $user BaseUserModel */
128		return $this->hasOne($hostClass::className(), ['refGUID' => 'updatedByAttribute']);
129		}
130
131		public function getUpdatedByAttribute()
132		{
133		$updatedByAttribute = $this->updatedByAttribute;
134		return (!is_string($updatedByAttribute) \|\| empty($updatedByAttribute)) ? null : $this->$updatedByAttribute->getData();
135		}
136
137		/**
138		*
139		* @param IdentityInterface $user
		0 ignored issues – show Bug introduced 2017-01-21 07:17 UTC by Report Bug Copy Issue Report There is no parameter named `$user`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
140		* @return boolean
141		*/
142		public function setUpdater($updater)
143		{
144		if (!is_string($this->updatedByAttribute) \|\| empty($this->updatedByAttribute)) {
145		return false;
146		}
147		if ($updater instanceof $this->hostClass \|\| $updater instanceof IdentityInterface) {
148		return $this->{$this->updatedByAttribute} = new Binary($updater->getGUID(), Binary::TYPE_UUID);
149		}
150		if (is_string($updater) && preg_match(Number::GUID_REGEX, $updater)) {
151		return $this->{$this->updatedByAttribute} = new Binary(Number::guid_bin($updater), Binary::TYPE_UUID);
152		}
153		if (strlen($updater) == 16) {
154		return $this->{$this->updatedByAttribute} = new Binary($updater, Binary::TYPE_UUID);
155		}
156		return false;
157		}
158
159		/**
160		* Return the current user's GUID if current model doesn't specify the owner
161		* yet, or return the owner's GUID if current model has been specified.
162		* This method is ONLY used for being triggered by event. DO NOT call,
163		* override or modify it directly, unless you know the consequences.
164		* @param ModelEvent $event
165		* @return string the GUID of current user or the owner.
166		*/
167	12	public function onGetCurrentUserGuid($event)
168		{
169	12	$sender = $event->sender;
170		/* @var $sender static */
171	12	if (isset($sender->attributes[$sender->createdByAttribute])) {
172	12	return $sender->attributes[$sender->createdByAttribute];
173		}
174		$identity = \Yii::$app->user->identity;
175		/* @var BaseUserModel $identity */
176		if ($identity) {
177		return $identity->getReadableGUID();
178		}
179		}
180		}
181

rhosocial / yii2-base-models

Push — master ( bd75c7...426d7c )

BaseMongoBlameableModel::findByIdentity() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like