RegistrationTrait::getSource() - Code Metrics - Inspection of "1.0.x" - rhosocial/yii2-base-models - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by vistart

created 2017-05-06 05:35 UTC

RegistrationTrait::getSource() A

↳ Parent: RegistrationTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	0
crap	2

<?php

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

namespace rhosocial\base\models\traits;

use Yii;
use yii\base\ModelEvent;
use yii\db\IntegrityException;
use yii\rbac\ManagerInterface;
use yii\rbac\Item;

/**
 * User features concerning registration.
 *
 * @property-read mixed $authManager
 * @property mixed $source
 * @property array $sourceRules rules associated with source attribute.
 * @version 1.0
 * @author vistart <[email protected]>
 */
trait RegistrationTrait
{

    /**
     * @event Event an event that is triggered after user is registered successfully.
     */
    public static $eventAfterRegister = "afterRegister";

    /**
     * @event Event an event that is triggered before registration.
     */
    public static $eventBeforeRegister = "beforeRegister";

    /**
     * @event Event an event that is triggered when registration failed.
     */
    public static $eventRegisterFailed = "registerFailed";

    /**
     * @event Event an event that is triggered after user is deregistered successfully.
     */
    public static $eventAfterDeregister = "afterDeregister";

    /**
     * @event Event an event that is triggered before deregistration.
     */
    public static $eventBeforeDeregister = "beforeDeregister";

    /**
     * @event Event an event that is triggered when deregistration failed.
     */
    public static $eventDeregisterFailed = "deregisterFailed";

    /**
     * @var string name of attribute which store the source. if you don't want to
     * record source, please assign false.
     */
    public $sourceAttribute = 'source';
    private $_sourceRules = [];
    public static $sourceSelf = '0';

    /**
     * @var string auth manager component id.
     */
    public $authManagerId = 'authManager';

    /**
     * Get auth manager. If auth manager not configured, Yii::$app->authManager
     * will be given.
     * @return ManagerInterface
     */
    public function getAuthManager()
    {
        $authManagerId = $this->authManagerId;
        return empty($authManagerId) ? Yii::$app->authManager : Yii::$app->$authManagerId;
    }

    /**
     * Register new user.
     * It is equivalent to store the current user and its associated models into
     * database synchronously. The registration will be terminated immediately
     * if any errors occur in the process, and all the earlier steps succeeded
     * are rolled back.
     * If auth manager configured, and auth role(s) provided, it(they) will be
     * assigned to user after registration.
     * If current user is not a new one(isNewRecord = false), the registration
     * will be skipped and return false.
     * The $eventBeforeRegister will be triggered before registration starts.
     * If registration finished, the $eventAfterRegister will be triggered. or
     * $eventRegisterFailed will be triggered when any errors occured.
     * @param array $associatedModels The models associated with user to be stored synchronously.
     * @param string|Item[] $authRoles auth name, auth instance, auth name array or auth instance array.
     * @return boolean Whether the registration succeeds or not.
     * @throws IntegrityException when inserting user and associated models failed.
     */
    public function register($associatedModels = [], $authRoles = [])
    {
        if (!$this->getIsNewRecord()) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            return false;
        }
        $this->trigger(static::$eventBeforeRegister);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $transaction = $this->getDb()->beginTransaction();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        try {
            if (!$this->save()) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                throw new IntegrityException('Registration Error(s) Occured: User Save Failed.', $this->getErrors());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
            if (($authManager = $this->getAuthManager()) && !empty($authRoles)) {
                if (is_string($authRoles) || $authRoles instanceof Item || !is_array($authRoles)) {
                    $authRoles = [$authRoles];
                }
                foreach ($authRoles as $role) {
                    if (is_string($role)) {
                        $role = $authManager->getRole($role);
                    }
                    if ($role instanceof Item) {
                        $authManager->assign($role, $this->getGUID());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    }
                }
            }
            if (!empty($associatedModels) && is_array($associatedModels)) {
                foreach ($associatedModels as $model) {
                    if (!$model->save()) {
                        throw new IntegrityException
                        ('Registration Error(s) Occured: Associated Models Save Failed.', $model->getErrors());
                    }
                }
            }
            $transaction->commit();
        } catch (\Exception $ex) {
            $transaction->rollBack();
            $this->trigger(static::$eventRegisterFailed);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if (YII_DEBUG || YII_ENV !== YII_ENV_PROD) {
                Yii::error($ex->getMessage(), __METHOD__);
                return $ex;
            }
            Yii::warning($ex->getMessage(), __METHOD__);
            return false;
        }
        $this->trigger(static::$eventAfterRegister);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        return true;
    }

    /**
     * Deregister current user itself.
     * It is equivalent to delete current user and its associated models. BUT it
     * deletes current user ONLY, the associated models will not be deleted
     * forwardly. So you should set the foreign key of associated models' table
     * referenced from primary key of user table, and their association mode is
     * 'on update cascade' and 'on delete cascade'.
     * the $eventBeforeDeregister will be triggered before deregistration starts.
     * if deregistration finished, the $eventAfterDeregister will be triggered. or
     * $eventDeregisterFailed will be triggered when any errors occured.
     * @return boolean Whether deregistration succeeds or not.
     * @throws IntegrityException when deleting user failed.
     */
    public function deregister()
    {
        if ($this->getIsNewRecord()) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            return false;
        }
        $this->trigger(static::$eventBeforeDeregister);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $transaction = $this->getDb()->beginTransaction();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        try {
            $result = $this->delete();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if ($result == 0) {
                throw new IntegrityException('User has not existed.');
            }
            if ($result != 1) {
                throw new IntegrityException('Deregistration Error(s) Occured.', $this->getErrors());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
            $transaction->commit();
        } catch (\Exception $ex) {
            $transaction->rollBack();
            $this->trigger(static::$eventDeregisterFailed);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if (YII_DEBUG || YII_ENV !== YII_ENV_PROD) {
                Yii::error($ex->getMessage(), __METHOD__);
                return $ex;
            }
            Yii::warning($ex->getMessage(), __METHOD__);
            return false;
        }
        $this->trigger(static::$eventAfterDeregister);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        return $result == 1;
    }

    /**
     * Get source.
     * @return string
     */
    public function getSource()
    {
        $sourceAttribute = $this->sourceAttribute;
        return is_string($sourceAttribute) ? $this->$sourceAttribute : null;
    }

    /**
     * Set source.
     * @param string $source
     */
    public function setSource($source)
    {
        $sourceAttribute = $this->sourceAttribute;
        return (is_string($sourceAttribute) && !empty($sourceAttribute)) ? $this->$sourceAttribute = $source : null;
    }

    /**
     * Get the rules associated with source attribute.
     * @return array rules.
     */
    public function getSourceRules()
    {
        if (!is_string($this->sourceAttribute) || empty($this->sourceAttribute)) {
            return [];
        }
        if (empty($this->_sourceRules)) {
            $this->_sourceRules = [
                [[$this->sourceAttribute], 'required'],
                [[$this->sourceAttribute], 'string'],
            ];
        }
        return $this->_sourceRules;
    }

    /**
     * Set the rules associated with source attribute.
     * @param array $rules
     */
    public function setSourceRules($rules)
    {
        if (!empty($rules) && is_array($rules)) {
            $this->_sourceRules = $rules;
        }
    }

    /**
     * Initialize the source attribute with $sourceSelf.
     * 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
     */
    public function onInitSourceAttribute($event)
    {
        $sender = $event->sender;
        /* @var $sender static */
        return $sender->setSource(static::$sourceSelf);
    }
}


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 Yii;
16		use yii\base\ModelEvent;
17		use yii\db\IntegrityException;
18		use yii\rbac\ManagerInterface;
19		use yii\rbac\Item;
20
21		/**
22		* User features concerning registration.
23		*
24		* @property-read mixed $authManager
25		* @property mixed $source
26		* @property array $sourceRules rules associated with source attribute.
27		* @version 1.0
28		* @author vistart <[email protected]>
29		*/
30		trait RegistrationTrait
31		{
32
33		/**
34		* @event Event an event that is triggered after user is registered successfully.
35		*/
36		public static $eventAfterRegister = "afterRegister";
37
38		/**
39		* @event Event an event that is triggered before registration.
40		*/
41		public static $eventBeforeRegister = "beforeRegister";
42
43		/**
44		* @event Event an event that is triggered when registration failed.
45		*/
46		public static $eventRegisterFailed = "registerFailed";
47
48		/**
49		* @event Event an event that is triggered after user is deregistered successfully.
50		*/
51		public static $eventAfterDeregister = "afterDeregister";
52
53		/**
54		* @event Event an event that is triggered before deregistration.
55		*/
56		public static $eventBeforeDeregister = "beforeDeregister";
57
58		/**
59		* @event Event an event that is triggered when deregistration failed.
60		*/
61		public static $eventDeregisterFailed = "deregisterFailed";
62
63		/**
64		* @var string name of attribute which store the source. if you don't want to
65		* record source, please assign false.
66		*/
67		public $sourceAttribute = 'source';
68		private $_sourceRules = [];
69		public static $sourceSelf = '0';
70
71		/**
72		* @var string auth manager component id.
73		*/
74		public $authManagerId = 'authManager';
75
76		/**
77		* Get auth manager. If auth manager not configured, Yii::$app->authManager
78		* will be given.
79		* @return ManagerInterface
80		*/
81	277	public function getAuthManager()
82		{
83	277	$authManagerId = $this->authManagerId;
84	277	return empty($authManagerId) ? Yii::$app->authManager : Yii::$app->$authManagerId;
85		}
86
87		/**
88		* Register new user.
89		* It is equivalent to store the current user and its associated models into
90		* database synchronously. The registration will be terminated immediately
91		* if any errors occur in the process, and all the earlier steps succeeded
92		* are rolled back.
93		* If auth manager configured, and auth role(s) provided, it(they) will be
94		* assigned to user after registration.
95		* If current user is not a new one(isNewRecord = false), the registration
96		* will be skipped and return false.
97		* The $eventBeforeRegister will be triggered before registration starts.
98		* If registration finished, the $eventAfterRegister will be triggered. or
99		* $eventRegisterFailed will be triggered when any errors occured.
100		* @param array $associatedModels The models associated with user to be stored synchronously.
101		* @param string\|Item[] $authRoles auth name, auth instance, auth name array or auth instance array.
102		* @return boolean Whether the registration succeeds or not.
103		* @throws IntegrityException when inserting user and associated models failed.
104		*/
105	278	public function register($associatedModels = [], $authRoles = [])
106		{
107	278	if (!$this->getIsNewRecord()) {
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `getIsNewRecord()` 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...
108	3	return false;
109		}
110	278	$this->trigger(static::$eventBeforeRegister);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `trigger()` 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...
111	278	$transaction = $this->getDb()->beginTransaction();
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `getDb()` 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...
112		try {
113	278	if (!$this->save()) {
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `save()` 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...
114	1	throw new IntegrityException('Registration Error(s) Occured: User Save Failed.', $this->getErrors());
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `getErrors()` 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...
115		}
116	277	if (($authManager = $this->getAuthManager()) && !empty($authRoles)) {
117		if (is_string($authRoles) \|\| $authRoles instanceof Item \|\| !is_array($authRoles)) {
118		$authRoles = [$authRoles];
119		}
120		foreach ($authRoles as $role) {
121		if (is_string($role)) {
122		$role = $authManager->getRole($role);
123		}
124		if ($role instanceof Item) {
125		$authManager->assign($role, $this->getGUID());
		0 ignored issues – show Bug introduced 2017-01-13 13:50 UTC by Report Bug Copy Issue Report It seems like `getGUID()` 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... Compatibility introduced 2017-03-18 18:10 UTC by Report Bug Copy Issue Report `$role` of type `object<yii\rbac\Item>` is not a sub-type of `object<yii\rbac\Role>`. It seems like you assume a child class of the class `yii\rbac\Item` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
126		}
127		}
128		}
129	277	if (!empty($associatedModels) && is_array($associatedModels)) {
130	131	foreach ($associatedModels as $model) {
131	131	if (!$model->save()) {
132		throw new IntegrityException
133		('Registration Error(s) Occured: Associated Models Save Failed.', $model->getErrors());
134		}
135		}
136		}
137	277	$transaction->commit();
138	1	} catch (\Exception $ex) {
139	1	$transaction->rollBack();
140	1	$this->trigger(static::$eventRegisterFailed);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `trigger()` 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...
141	1	if (YII_DEBUG \|\| YII_ENV !== YII_ENV_PROD) {
142	1	Yii::error($ex->getMessage(), __METHOD__);
143	1	return $ex;
144		}
145		Yii::warning($ex->getMessage(), __METHOD__);
146		return false;
147		}
148	277	$this->trigger(static::$eventAfterRegister);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `trigger()` 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...
149	277	return true;
150		}
151
152		/**
153		* Deregister current user itself.
154		* It is equivalent to delete current user and its associated models. BUT it
155		* deletes current user ONLY, the associated models will not be deleted
156		* forwardly. So you should set the foreign key of associated models' table
157		* referenced from primary key of user table, and their association mode is
158		* 'on update cascade' and 'on delete cascade'.
159		* the $eventBeforeDeregister will be triggered before deregistration starts.
160		* if deregistration finished, the $eventAfterDeregister will be triggered. or
161		* $eventDeregisterFailed will be triggered when any errors occured.
162		* @return boolean Whether deregistration succeeds or not.
163		* @throws IntegrityException when deleting user failed.
164		*/
165	302	public function deregister()
166		{
167	302	if ($this->getIsNewRecord()) {
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `getIsNewRecord()` 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...
168	255	return false;
169		}
170	278	$this->trigger(static::$eventBeforeDeregister);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `trigger()` 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...
171	278	$transaction = $this->getDb()->beginTransaction();
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `getDb()` 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...
172		try {
173	278	$result = $this->delete();
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `delete()` 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...
174	278	if ($result == 0) {
175		throw new IntegrityException('User has not existed.');
176		}
177	278	if ($result != 1) {
178		throw new IntegrityException('Deregistration Error(s) Occured.', $this->getErrors());
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `getErrors()` 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...
179		}
180	278	$transaction->commit();
181		} catch (\Exception $ex) {
182		$transaction->rollBack();
183		$this->trigger(static::$eventDeregisterFailed);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `trigger()` 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...
184		if (YII_DEBUG \|\| YII_ENV !== YII_ENV_PROD) {
185		Yii::error($ex->getMessage(), __METHOD__);
186		return $ex;
187		}
188		Yii::warning($ex->getMessage(), __METHOD__);
189		return false;
190		}
191	278	$this->trigger(static::$eventAfterDeregister);
		0 ignored issues – show Bug introduced 2017-01-12 08:52 UTC by Report Bug Copy Issue Report It seems like `trigger()` 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...
192	278	return $result == 1;
193		}
194
195		/**
196		* Get source.
197		* @return string
198		*/
199	1	public function getSource()
200		{
201	1	$sourceAttribute = $this->sourceAttribute;
202	1	return is_string($sourceAttribute) ? $this->$sourceAttribute : null;
203		}
204
205		/**
206		* Set source.
207		* @param string $source
208		*/
209	302	public function setSource($source)
210		{
211	302	$sourceAttribute = $this->sourceAttribute;
212	302	return (is_string($sourceAttribute) && !empty($sourceAttribute)) ? $this->$sourceAttribute = $source : null;
213		}
214
215		/**
216		* Get the rules associated with source attribute.
217		* @return array rules.
218		*/
219	288	public function getSourceRules()
220		{
221	288	if (!is_string($this->sourceAttribute) \|\| empty($this->sourceAttribute)) {
222		return [];
223		}
224	288	if (empty($this->_sourceRules)) {
225	287	$this->_sourceRules = [
226	287	[[$this->sourceAttribute], 'required'],
227	287	[[$this->sourceAttribute], 'string'],
228		];
229		}
230	288	return $this->_sourceRules;
231		}
232
233		/**
234		* Set the rules associated with source attribute.
235		* @param array $rules
236		*/
237	1	public function setSourceRules($rules)
238		{
239	1	if (!empty($rules) && is_array($rules)) {
240	1	$this->_sourceRules = $rules;
241		}
242	1	}
243
244		/**
245		* Initialize the source attribute with $sourceSelf.
246		* This method is ONLY used for being triggered by event. DO NOT call,
247		* override or modify it directly, unless you know the consequences.
248		* @param ModelEvent $event
249		*/
250	302	public function onInitSourceAttribute($event)
251		{
252	302	$sender = $event->sender;
253		/* @var $sender static */
254	302	return $sender->setSource(static::$sourceSelf);
255		}
256		}
257

rhosocial / yii2-base-models

Pull Request — master (#1)

RegistrationTrait::getSource() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like