Organization::init() - Code Metrics - Inspection of "add administrator and test cases." - rhosocial/yii2-organization - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a274db...6e4772 )

by vistart

created 2017-03-30 09:54 UTC

Organization::init() A

↳ Parent: Organization

Complexity

Conditions	3
Paths	4

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	9
cts	9
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	4
nop	0
crap	3

<?php

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

namespace rhosocial\organization;

use rhosocial\base\models\traits\SelfBlameableTrait;
use rhosocial\base\models\queries\BaseUserQuery;
use rhosocial\user\User;
use rhosocial\user\rbac\Role;
use rhosocial\organization\rbac\roles\DepartmentAdmin;
use rhosocial\organization\rbac\roles\DepartmentCreator;
use rhosocial\organization\rbac\roles\OrganizationAdmin;
use rhosocial\organization\rbac\roles\OrganizationCreator;
use rhosocial\organization\queries\MemberQuery;
use rhosocial\organization\queries\DepartmentQuery;
use rhosocial\organization\queries\OrganizationQuery;
use Yii;
use yii\base\Event;
use yii\db\IntegrityException;

/**
 * Base Organization.
 * This class is an abstract class that can not be instantiated directly.
 * You can use [[Organization]] or [[Department]] instead.
 *
 * @method Member createMember(array $config) Create member who is subordinate to this.
 * @property integer $type Whether indicate this instance is an organization or a department.
 
 * @version 1.0
 * @author vistart <[email protected]>
 */
class Organization extends User
{
    use SelfBlameableTrait;

    const TYPE_ORGANIZATION = 1;
    const TYPE_DEPARTMENT = 2;

    /**
     * @var boolean Organization does not need password and corresponding features.
     */
    public $passwordHashAttribute = false;

    /**
     * @var boolean Organization does not need password and corresponding features.
     */
    public $passwordResetTokenAttribute = false;

    /**
     * @var boolean Organization does not need password and corresponding features.
     */
    public $passwordHistoryClass = false;

    /**
     * @var boolean Organization does not need source.
     */
    public $sourceAttribute = false;

    /**
     * @var boolean Organization does not need auth key.
     */
    public $authKeyAttribute = false;

    /**
     * @var boolean Organization does not need access token.
     */
    public $accessTokenAttribute = false;

    /**
     *
     * @var boolean Organization does not need login log.
     */
    public $loginLogClass = false;

    public $profileClass = Profile::class;

    public $memberClass = Member::class;
    private $noInitMember;
    /**
     * @return Member
     */
    protected function getNoInitMember()
    {
        if (!$this->noInitMember) {
            $class = $this->memberClass;
            $this->noInitMember = $class::buildNoInitModel();
        }
        return $this->noInitMember;
    }

    public function init()
    {
        $this->parentAttribute = 'parent_guid';
        if (class_exists($this->memberClass)) {
            $this->addSubsidiaryClass('Member', ['class' => $this->memberClass]);
        }
        if ($this->skipInit) {
            return;
        }
        $this->on(static::$eventBeforeDeregister, [$this, 'onRevokeCreatorBeforeDeregister']);
        parent::init();
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'guid' => Yii::t('app', 'GUID'),
            'id' => Yii::t('app', 'ID'),
            'ip' => Yii::t('app', 'IP'),
            'ip_type' => Yii::t('app', 'IP Address Type'),
            'parent' => Yii::t('app', 'Parent'),
            'created_at' => Yii::t('app', 'Create Time'),
            'updated_at' => Yii::t('app', 'Update Time'),
            'status' => Yii::t('app', 'Status'),
            'type' => Yii::t('app', 'Type'),
        ];
    }

    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return '{{%organization}}';
    }

    protected function getTypeRules()
    {
        return [
            ['type', 'default', 'value' => static::TYPE_ORGANIZATION],
            ['type', 'required'],
            ['type', 'in', 'range' => [static::TYPE_ORGANIZATION, static::TYPE_DEPARTMENT]],
        ];
    }

    public function rules()
    {
        return array_merge(parent::rules(), $this->getTypeRules(), $this->getSelfBlameableRules());
    }

    /**
     * Get Member Query.
     * @return MemberQuery
     */
    public function getMembers()
    {
        return $this->hasMany($this->memberClass, [$this->getNoInitMember()->createdByAttribute => $this->guidAttribute])->inverseOf('organization');
    }

    /**
     * Get organization member users' query.
     * @return BaseUserQuery
     */
    public function getMemberUsers()
    {
        $noInit = $this->getNoInitMember();
        $class = $noInit->memberUserClass;
        $noInitUser = $class::buildNoInitModel();
        return $this->hasMany($class, [$noInitUser->guidAttribute => $this->getNoInitMember()->memberAttribute])->via('members')->inverseOf('atOrganizations');
    }

    /**
     * Get member with specified user.
     * @param User|string|integer $user
     * @return Member Null if `user` is not in this organization.
     */
    public function getMember($user)
    {
        return $this->getMembers()->user($user)->one();

    }

    /**
     * Add member to organization.
     * @param Member|User|string|integer $member
     * @see createMemberModel
     * @see createMemberModelWithUser
     * @return boolean
     */
    public function addMember(&$member)
    {
        if ($this->getIsNewRecord()) {
            return false;
        }
        $model = null;
        if ($member instanceof Member) {
            $model = $this->createMemberModel($member);
        }
        if (($member instanceof User) || is_string($member) || is_int($member)) {
            $model = $this->createMemberModelWithUser($member);
        }
        $member = $model;
        return ($member instanceof Member) ? $member->save() : false;
    }

    /**
     * Create member model, and set organization with this.
     * @param Member $member If this parameter is not new record, it's organization
     * will be set with this, and return it. Otherwise, it will extract `User`
     * model and create new `Member` model.
     * @see createMemberModelWithUser
     * @return Member
     */
    public function createMemberModel($member)
    {
        if (!$member->getIsNewRecord()) {
            $member->setOrganization($this);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return $member;
        }
        return $this->createMemberModelWithUser($member->memberUser);
    }

    /**
     * Create member model with user, and set organization with this.
     * @param User|string|integer $user
     * @return Member
     */
    public function createMemberModelWithUser($user)
    {
        $config = [
            'memberUser' => $user,
            'organization' => $this,
            'nickname' => '',
        ];
        if ($user->profile) {
            $config['nickname'] = $user->profile->nickname;
        }
        return $this->createMember($config);
    }

    /**
     * Remove member.
     * @param Member|User $member
     * @return boolean
     */
    public function removeMember(&$member)
    {
        if ($this->getIsNewRecord()) {
            return false;
        }
        if ($member instanceof $this->memberClass) {
            $member = $member->{$member->memberAttribute};
        }
        $member = $this->getMember($member);
        return $member && $member->delete() > 0;
    }

    /**
     * 
     * @param Event $event
     */
    public function onRevokeCreatorBeforeDeregister($event)
    {
        $sender = $event->sender;
        /* @var $sender static */
        $member = $sender->getMemberCreators()->one();
        /* @var $member Member */
        $role = $this->type == static::TYPE_ORGANIZATION ? (new OrganizationCreator) : (new DepartmentCreator);
        return $member->revokeRole($role);
    }

    /**
     * 
     * @return boolean
     */
    public function isOrganization()
    {
        return $this->type == static::TYPE_ORGANIZATION;
    }

    /**
     * 
     * @return boolean
     */
    public function isDepartment()
    {
        return $this->type == static::TYPE_DEPARTMENT;
    }

    /**
     * Check whether the current organization has a member.
     * @param User $user
     * @return boolean
     */
    public function hasMember($user)
    {
        return !is_null($this->getMember($user));
    }

    /**
     * Get creator query.
     * @return MemberQuery
     */
    public function getMemberCreators()
    {
        $roleNames = [];
        $roleNames[] = (new DepartmentCreator)->name;
        $roleNames[] = (new OrganizationCreator)->name;
        return $this->getMembers()->andWhere(['role' => $roleNames]);
    }

    /**
     * Get administrator query.
     * @return MemberQuery
     */
    public function getMemberAdministrators()
    {
        $roleNames = [];
        $roleNames[] = (new DepartmentAdmin)->name;
        $roleNames[] = (new OrganizationAdmin)->name;
        return $this->getMembers()->andWhere(['role' => $roleNames]);
    }

    /**
     * 
     * @param User $user
     */
    public function addAdministrator($user)
    {
        $member = $user;
        $transaction = Yii::$app->db->beginTransaction();
        try {
            if (!$this->addMember($member)) {
                throw new IntegrityException('Failed to add member.');
            }
            $role = $this->type == static::TYPE_ORGANIZATION ? (new OrganizationAdmin) : (new DepartmentAdmin);
            $member->assignRole($role);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            if (!$member->save()) {
                throw new IntegrityException('Failed to assign administrator.');
            }
            $transaction->commit();
        } catch (\Exception $ex) {
            $transaction->rollBack();
            Yii::error($ex->getMessage(), __METHOD__);
            throw $ex;
        }
        return true;
    }
}


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\organization;
14
15		use rhosocial\base\models\traits\SelfBlameableTrait;
16		use rhosocial\base\models\queries\BaseUserQuery;
17		use rhosocial\user\User;
18		use rhosocial\user\rbac\Role;
19		use rhosocial\organization\rbac\roles\DepartmentAdmin;
20		use rhosocial\organization\rbac\roles\DepartmentCreator;
21		use rhosocial\organization\rbac\roles\OrganizationAdmin;
22		use rhosocial\organization\rbac\roles\OrganizationCreator;
23		use rhosocial\organization\queries\MemberQuery;
24		use rhosocial\organization\queries\DepartmentQuery;
25		use rhosocial\organization\queries\OrganizationQuery;
26		use Yii;
27		use yii\base\Event;
28		use yii\db\IntegrityException;
29
30		/**
31		* Base Organization.
32		* This class is an abstract class that can not be instantiated directly.
33		* You can use [[Organization]] or [[Department]] instead.
34		*
35		* @method Member createMember(array $config) Create member who is subordinate to this.
36		* @property integer $type Whether indicate this instance is an organization or a department.
37
38		* @version 1.0
39		* @author vistart <[email protected]>
40		*/
41		class Organization extends User
42		{
43		use SelfBlameableTrait;
44
45		const TYPE_ORGANIZATION = 1;
46		const TYPE_DEPARTMENT = 2;
47
48		/**
49		* @var boolean Organization does not need password and corresponding features.
50		*/
51		public $passwordHashAttribute = false;
52
53		/**
54		* @var boolean Organization does not need password and corresponding features.
55		*/
56		public $passwordResetTokenAttribute = false;
57
58		/**
59		* @var boolean Organization does not need password and corresponding features.
60		*/
61		public $passwordHistoryClass = false;
62
63		/**
64		* @var boolean Organization does not need source.
65		*/
66		public $sourceAttribute = false;
67
68		/**
69		* @var boolean Organization does not need auth key.
70		*/
71		public $authKeyAttribute = false;
72
73		/**
74		* @var boolean Organization does not need access token.
75		*/
76		public $accessTokenAttribute = false;
77
78		/**
79		*
80		* @var boolean Organization does not need login log.
81		*/
82		public $loginLogClass = false;
83
84		public $profileClass = Profile::class;
85
86		public $memberClass = Member::class;
87		private $noInitMember;
88		/**
89		* @return Member
90		*/
91	16	protected function getNoInitMember()
92		{
93	16	if (!$this->noInitMember) {
94	16	$class = $this->memberClass;
95	16	$this->noInitMember = $class::buildNoInitModel();
96		}
97	16	return $this->noInitMember;
98		}
99
100	25	public function init()
101		{
102	25	$this->parentAttribute = 'parent_guid';
103	25	if (class_exists($this->memberClass)) {
104	25	$this->addSubsidiaryClass('Member', ['class' => $this->memberClass]);
105		}
106	25	if ($this->skipInit) {
107	25	return;
108		}
109	25	$this->on(static::$eventBeforeDeregister, [$this, 'onRevokeCreatorBeforeDeregister']);
110	25	parent::init();
111	25	}
112
113		/**
114		* @inheritdoc
115		*/
116	1	public function attributeLabels()
117		{
118		return [
119	1	'guid' => Yii::t('app', 'GUID'),
120	1	'id' => Yii::t('app', 'ID'),
121	1	'ip' => Yii::t('app', 'IP'),
122	1	'ip_type' => Yii::t('app', 'IP Address Type'),
123	1	'parent' => Yii::t('app', 'Parent'),
124	1	'created_at' => Yii::t('app', 'Create Time'),
125	1	'updated_at' => Yii::t('app', 'Update Time'),
126	1	'status' => Yii::t('app', 'Status'),
127	1	'type' => Yii::t('app', 'Type'),
128		];
129		}
130
131		/**
132		* @inheritdoc
133		*/
134	25	public static function tableName()
135		{
136	25	return '{{%organization}}';
137		}
138
139	24	protected function getTypeRules()
140		{
141		return [
142	24	['type', 'default', 'value' => static::TYPE_ORGANIZATION],
143		['type', 'required'],
144	24	['type', 'in', 'range' => [static::TYPE_ORGANIZATION, static::TYPE_DEPARTMENT]],
145		];
146		}
147
148	24	public function rules()
149		{
150	24	return array_merge(parent::rules(), $this->getTypeRules(), $this->getSelfBlameableRules());
151		}
152
153		/**
154		* Get Member Query.
155		* @return MemberQuery
156		*/
157	16	public function getMembers()
158		{
159	16	return $this->hasMany($this->memberClass, [$this->getNoInitMember()->createdByAttribute => $this->guidAttribute])->inverseOf('organization');
160		}
161
162		/**
163		* Get organization member users' query.
164		* @return BaseUserQuery
165		*/
166	2	public function getMemberUsers()
167		{
168	2	$noInit = $this->getNoInitMember();
169	2	$class = $noInit->memberUserClass;
170	2	$noInitUser = $class::buildNoInitModel();
171	2	return $this->hasMany($class, [$noInitUser->guidAttribute => $this->getNoInitMember()->memberAttribute])->via('members')->inverseOf('atOrganizations');
172		}
173
174		/**
175		* Get member with specified user.
176		* @param User\|string\|integer $user
177		* @return Member Null if `user` is not in this organization.
178		*/
179	7	public function getMember($user)
180		{
181	7	return $this->getMembers()->user($user)->one();
		0 ignored issues – show Bug Compatibility introduced 2017-03-29 11:21 UTC by Report Bug Copy Issue Report The expression `$this->getMembers()->user($user)->one();` of type `yii\db\ActiveRecord\|array\|null` adds the type `array` to the return on line 181 which is incompatible with the return type documented by `rhosocial\organization\Organization::getMember` of type `rhosocial\organization\Member\|null`. Loading history...
182		}
183
184		/**
185		* Add member to organization.
186		* @param Member\|User\|string\|integer $member
187		* @see createMemberModel
188		* @see createMemberModelWithUser
189		* @return boolean
190		*/
191	5	public function addMember(&$member)
192		{
193	5	if ($this->getIsNewRecord()) {
194		return false;
195		}
196	5	$model = null;
197	5	if ($member instanceof Member) {
198		$model = $this->createMemberModel($member);
199		}
200	5	if (($member instanceof User) \|\| is_string($member) \|\| is_int($member)) {
201	5	$model = $this->createMemberModelWithUser($member);
202		}
203	5	$member = $model;
204	5	return ($member instanceof Member) ? $member->save() : false;
205		}
206
207		/**
208		* Create member model, and set organization with this.
209		* @param Member $member If this parameter is not new record, it's organization
210		* will be set with this, and return it. Otherwise, it will extract `User`
211		* model and create new `Member` model.
212		* @see createMemberModelWithUser
213		* @return Member
214		*/
215		public function createMemberModel($member)
216		{
217		if (!$member->getIsNewRecord()) {
218		$member->setOrganization($this);
		0 ignored issues – show Documentation introduced 2017-03-29 11:21 UTC by Report Bug Copy Issue Report `$this` is of type `this<rhosocial\organization\Organization>`, but the function expects a `object<rhosocial\organization\BaseOrganization>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
219		return $member;
220		}
221		return $this->createMemberModelWithUser($member->memberUser);
222		}
223
224		/**
225		* Create member model with user, and set organization with this.
226		* @param User\|string\|integer $user
227		* @return Member
228		*/
229	23	public function createMemberModelWithUser($user)
230		{
231		$config = [
232	23	'memberUser' => $user,
233	23	'organization' => $this,
234	23	'nickname' => '',
235		];
236	23	if ($user->profile) {
237	23	$config['nickname'] = $user->profile->nickname;
238		}
239	23	return $this->createMember($config);
240		}
241
242		/**
243		* Remove member.
244		* @param Member\|User $member
245		* @return boolean
246		*/
247	1	public function removeMember(&$member)
248		{
249	1	if ($this->getIsNewRecord()) {
250		return false;
251		}
252	1	if ($member instanceof $this->memberClass) {
253	1	$member = $member->{$member->memberAttribute};
254		}
255	1	$member = $this->getMember($member);
256	1	return $member && $member->delete() > 0;
257		}
258
259		/**
260		*
261		* @param Event $event
262		*/
263	13	public function onRevokeCreatorBeforeDeregister($event)
264		{
265	13	$sender = $event->sender;
266		/* @var $sender static */
267	13	$member = $sender->getMemberCreators()->one();
268		/* @var $member Member */
269	13	$role = $this->type == static::TYPE_ORGANIZATION ? (new OrganizationCreator) : (new DepartmentCreator);
270	13	return $member->revokeRole($role);
271		}
272
273		/**
274		*
275		* @return boolean
276		*/
277	2	public function isOrganization()
278		{
279	2	return $this->type == static::TYPE_ORGANIZATION;
280		}
281
282		/**
283		*
284		* @return boolean
285		*/
286	2	public function isDepartment()
287		{
288	2	return $this->type == static::TYPE_DEPARTMENT;
289		}
290
291		/**
292		* Check whether the current organization has a member.
293		* @param User $user
294		* @return boolean
295		*/
296	1	public function hasMember($user)
297		{
298	1	return !is_null($this->getMember($user));
299		}
300
301		/**
302		* Get creator query.
303		* @return MemberQuery
304		*/
305	13	public function getMemberCreators()
306		{
307	13	$roleNames = [];
308	13	$roleNames[] = (new DepartmentCreator)->name;
309	13	$roleNames[] = (new OrganizationCreator)->name;
310	13	return $this->getMembers()->andWhere(['role' => $roleNames]);
311		}
312
313		/**
314		* Get administrator query.
315		* @return MemberQuery
316		*/
317		public function getMemberAdministrators()
318		{
319		$roleNames = [];
320		$roleNames[] = (new DepartmentAdmin)->name;
321		$roleNames[] = (new OrganizationAdmin)->name;
322		return $this->getMembers()->andWhere(['role' => $roleNames]);
323		}
324
325		/**
326		*
327		* @param User $user
328		*/
329	1	public function addAdministrator($user)
330		{
331	1	$member = $user;
332	1	$transaction = Yii::$app->db->beginTransaction();
333		try {
334	1	if (!$this->addMember($member)) {
335		throw new IntegrityException('Failed to add member.');
336		}
337	1	$role = $this->type == static::TYPE_ORGANIZATION ? (new OrganizationAdmin) : (new DepartmentAdmin);
338	1	$member->assignRole($role);
		0 ignored issues – show Bug introduced 2017-03-30 09:58 UTC by Report Bug Copy Issue Report The method `assignRole` does only exist in `rhosocial\organization\Member`, but not in `rhosocial\user\User`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
339	1	if (!$member->save()) {
340		throw new IntegrityException('Failed to assign administrator.');
341		}
342	1	$transaction->commit();
343		} catch (\Exception $ex) {
344		$transaction->rollBack();
345		Yii::error($ex->getMessage(), __METHOD__);
346		throw $ex;
347		}
348	1	return true;
349		}
350		}
351

rhosocial / yii2-organization

Push — master ( a274db...6e4772 )

Organization::init() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like