MutualTrait::getInitiator() - Code Metrics - Inspection of "add basic single relation test cases" - rhosocial/yii2-base-models - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bf148f...113cf9 )

by vistart

created 2017-01-16 09:54 UTC

MutualTrait::getInitiator() A

↳ Parent: MutualTrait

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	0
crap	1

<?php

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

namespace rhosocial\base\models\traits;

use rhosocial\base\models\models\BaseUserModel;
use rhosocial\base\models\queries\BaseUserQuery;

/**
 * Description of MutualTrait
 *
 * @property-read mixed $initiator
 * @property mixed $recipient
 * @property-read array $mutualRules
 * @version 1.0
 * @author vistart <[email protected]>
 */
trait MutualTrait
{

    public $otherGuidAttribute = 'other_guid';

    /**
     * Get initiator.
     * @return BaseUserQuery
     */
    public function getInitiator()
    {
        return $this->getUser();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Get recipient.
     * @return BaseUserQuery
     */
    public function getRecipient()
    {
        if (!is_string($this->otherGuidAttribute)) {
            return null;
        }
        $userClass = $this->userClass;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $model = $userClass::buildNoInitModel();
        return $this->hasOne($userClass::className(), [$model->guidAttribute => $this->otherGuidAttribute]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Set recipient.
     * @param BaseUserModel $user
     * @return string
     */
    public function setRecipient($user)
    {
        if (!is_string($this->otherGuidAttribute)) {
            return null;
        }
        $otherGuidAttribute = $this->otherGuidAttribute;
        return $this->$otherGuidAttribute = $user->getGUID();
    }

    /**
     * Get mutual attributes rules.
     * @return array
     */
    public function getMutualRules()
    {
        $rules = [];
        if (is_string($this->otherGuidAttribute)) {
            $rules = [
                [$this->otherGuidAttribute, 'required'],
                [$this->otherGuidAttribute, 'string', 'max' => 36],
            ];
        }
        return $rules;
    }
}


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\traits;
14
15		use rhosocial\base\models\models\BaseUserModel;
16		use rhosocial\base\models\queries\BaseUserQuery;
17
18		/**
19		* Description of MutualTrait
20		*
21		* @property-read mixed $initiator
22		* @property mixed $recipient
23		* @property-read array $mutualRules
24		* @version 1.0
25		* @author vistart <[email protected]>
26		*/
27		trait MutualTrait
28		{
29
30		public $otherGuidAttribute = 'other_guid';
31
32		/**
33		* Get initiator.
34		* @return BaseUserQuery
35		*/
36	1	public function getInitiator()
37		{
38	1	return $this->getUser();
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `getUser()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
39		}
40
41		/**
42		* Get recipient.
43		* @return BaseUserQuery
44		*/
45	1	public function getRecipient()
46		{
47	1	if (!is_string($this->otherGuidAttribute)) {
48		return null;
49		}
50	1	$userClass = $this->userClass;
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report The property `userClass` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
51	1	$model = $userClass::buildNoInitModel();
52	1	return $this->hasOne($userClass::className(), [$model->guidAttribute => $this->otherGuidAttribute]);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `hasOne()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
53		}
54
55		/**
56		* Set recipient.
57		* @param BaseUserModel $user
58		* @return string
59		*/
60		public function setRecipient($user)
61		{
62		if (!is_string($this->otherGuidAttribute)) {
63		return null;
64		}
65		$otherGuidAttribute = $this->otherGuidAttribute;
66		return $this->$otherGuidAttribute = $user->getGUID();
67		}
68
69		/**
70		* Get mutual attributes rules.
71		* @return array
72		*/
73	15	public function getMutualRules()
74		{
75	15	$rules = [];
76	15	if (is_string($this->otherGuidAttribute)) {
77		$rules = [
78	15	[$this->otherGuidAttribute, 'required'],
79	15	[$this->otherGuidAttribute, 'string', 'max' => 36],
80		];
81		}
82	15	return $rules;
83		}
84		}
85

rhosocial / yii2-base-models

Push — master ( bf148f...113cf9 )

MutualTrait::getInitiator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like