SettingsForm::attributeHints() - Code Metrics - Inspection of "add exit_allow_withdraw_actively option." - rhosocial/yii2-organization - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9cc424...58c353 )

by vistart

created 2017-04-24 05:35 UTC

SettingsForm::attributeHints() B

↳ Parent: SettingsForm

Complexity

Conditions	6
Paths	8

Size

Total Lines	35
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	35
rs	8.439
cc	6
eloc	30
nc	8
nop	0

<?php

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

namespace rhosocial\organization\forms;

use rhosocial\organization\Organization;
use rhosocial\organization\OrganizationSetting;
use Yii;
use yii\base\InvalidConfigException;
use yii\base\Model;
use yii\helpers\Html;
use yii\web\ServerErrorHttpException;

/**
 * Class SettingsForm
 * @package rhosocial\organization\forms
 * @version 1.0
 * @author vistart <[email protected]>
 */
class SettingsForm extends Model
{
    /**
     * @var string
     */
    public $exclude_other_members;

    /**
     * @var string
     */
    public $disallow_member_join_other;

    /**
     * @var string
     */
    public $only_accept_current_org_member;

    /**
     * @var string
     */
    public $only_accept_superior_org_member;

    /**
     * @var string
     */
    public $join_password;

    /**
     * @var string
     */
    public $join_ip_address;

    /**
     * @var string
     */
    public $join_entrance_url;

    /**
     * @var string
     */
    public $exit_allow_withdraw_actively;

    const SCENARIO_ORGANIZATION = 'organization';
    const SCENARIO_DEPARTMENT = 'department';

    /**
     * @var Organization
     */
    public $organization;

    /**
     * @inheritdoc
     */
    public function init()
    {
        if (!$this->organization) {
            throw new InvalidConfigException('Invalid Organization Model.');
        }
        $this->scenario = $this->organization->isOrganization() ? static::SCENARIO_ORGANIZATION : static::SCENARIO_DEPARTMENT;
        $this->loadSettings();
    }

    /**
     * Load settings.
     */
    protected function loadSettings()
    {
        if ($this->organization->isOrganization()) {
            $this->exclude_other_members = $this->organization->isExcludeOtherMembers ? '1' : '0';
            $this->disallow_member_join_other = $this->organization->isDisallowMemberJoinOther ? '1' : '0';
        } elseif ($this->organization->isDepartment()) {
            $this->only_accept_current_org_member = $this->organization->isOnlyAcceptCurrentOrgMember ? '1' : '0';
            $this->only_accept_superior_org_member = $this->organization->isOnlyAcceptSuperiorOrgMember ? '1' : '0';
        }
        $this->join_password = $this->organization->joinPassword;
        $this->join_ip_address = $this->organization->joinIpAddress;
        $this->join_entrance_url = $this->organization->joinEntranceUrl;
        $this->exit_allow_withdraw_actively = $this->organization->exitAllowWithdrawActively ? '1' : '0';
    }

    /**
     * Submit settings.
     */
    public function submit()
    {
        try {
            if ($this->organization->isOrganization()) {
                if ($this->exclude_other_members != ($this->organization->isExcludeOtherMembers ? '1' : '0')) {
                    $this->organization->isExcludeOtherMembers = ($this->exclude_other_members == '1');
                }
                if ($this->disallow_member_join_other != ($this->organization->isDisallowMemberJoinOther ? '1' : '0')) {
                    $this->organization->isDisallowMemberJoinOther = ($this->disallow_member_join_other == '1');
                }
            } elseif ($this->organization->isDepartment()) {
                if ($this->only_accept_current_org_member != ($this->organization->isOnlyAcceptCurrentOrgMember ? '1' : '0')) {
                    $this->organization->isOnlyAcceptCurrentOrgMember = ($this->only_accept_current_org_member == '1');
                }
                if ($this->only_accept_superior_org_member != ($this->organization->isOnlyAcceptSuperiorOrgMember ? '1' : '0')) {
                    $this->organization->isOnlyAcceptSuperiorOrgMember = ($this->only_accept_superior_org_member == '1');
                }
            }
            if ($this->join_password != $this->organization->joinPassword) {
                $this->organization->joinPassword = $this->join_password;
            }
            if ($this->join_ip_address != $this->organization->joinIpAddress) {
                $this->organization->joinIpAddress = $this->join_ip_address;
            }
            if ($this->join_entrance_url != $this->organization->joinEntranceUrl) {
                $this->organization->joinEntranceUrl = $this->join_entrance_url;
            }
            if ($this->exit_allow_withdraw_actively != ($this->organization->exitAllowWithdrawActively ? '1' : '0')) {
                $this->organization->exitAllowWithdrawActively = ($this->exit_allow_withdraw_actively == '1');
            }
        } catch (\Exception $ex) {
            throw new ServerErrorHttpException($ex->getMessage());
        }
        return true;
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'exclude_other_members' => Yii::t('organization', 'Exclude other members'),
            'disallow_member_join_other' => Yii::t('organization', 'Disallow members to join other'),
            'only_accept_current_org_member' => Yii::t('organization', 'Only accept organization members'),
            'only_accept_superior_org_member' => Yii::t('organization', 'Only accept superior members'),
            'join_password' => Yii::t('organization', 'Password'),
            'join_ip_address' => Yii::t('organization', 'IP Address'),
            'join_entrance_url' => Yii::t('organization', 'Entrance URL Code'),
            'exit_allow_withdraw_actively' => Yii::t('organization', 'Allow to Withdraw Actively'),
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeHints()
    {
        $topName = $this->organization->isDepartment() ? $this->organization->topOrganization->profile->name . ' (' . $this->organization->topOrganization->getID() . ')' : '';
        $parentName = $this->organization->isDepartment() ? $this->organization->parent->profile->name . ' (' . $this->organization->parent->getID() . ')' : '';
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        return [
            'exclude_other_members' =>
                Yii::t('organization', 'This organization does not allow other organizations and their subordinates\' members to join.') . "<br>" .
                Yii::t('organization', 'All members of the other organizations (including their subordinates) who have joined this organization (including subordinate departments) are not affected.'),
            'disallow_member_join_other' =>
                Yii::t('organization', 'This organization does not allow the organization and its subordinates\' members to join other organizations or their subordinates.') . "<br>" .
                Yii::t('organization', 'All members of this organization (including subordinate departments) who have joined other organizations (including their subordinates) are not affected.') . "<br>" .
                Yii::t('organization', 'If this option is enabled, all members of the organization (including subordinate departments) who have the "Set Up Organization" permission will not be able to set up a new organization.'),
            'only_accept_current_org_member' =>
                Yii::t('organization', 'This department is only accepted by members of the organization.') . "<br>" .
                Yii::t('organization', 'That is to say, only the members of {name} are accepted.', ['name' => $topName]),
            'only_accept_superior_org_member' =>
                Yii::t('organization', 'This department only accepts members of the parent organization or department.') . "<br>" .
                Yii::t('organization', 'That is to say, only the members of {name} are accepted.', ['name' => $parentName]),
            'join_entrance_url' => Yii::t('organization', 'You can assign a unique code to the ' . ($this->organization->isOrganization() ? 'organization' : 'department') . ', and we will generate a unique entrance URL based on this code.') . "<br>" .
                Yii::t('organization', 'After you enter the code and submit it, the generated URL will appear below.') . "<br>" .
                Yii::t('organization', 'If you do not want users to join the ' . ($this->organization->isOrganization() ? 'organization' : 'department') . ', please leave blank.') . "<br>" .
                (empty($this->join_entrance_url) ? Yii::t('organization', 'No entrance URL is currently available.') : Html::a(Yii::t('organization', 'The entrance URL'), [
                        '/organization/join/index',
                        'entrance' => $this->join_entrance_url,
                ], [
                    'class' => 'btn btn-primary',
                    'target' => '_blank',
                ])),
            'join_password' =>
                Yii::t('organization', 'If you specify a password, the user needs to provide the password to join.') . "<br>" .
                Yii::t('organization', 'If you do not need a user to enter a password, leave it blank.'),
            'join_ip_address' =>
                Yii::t('organization', 'Only the users from the above IP address (segment) can join the organization / department proactively.'),
        ];
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        $orgClass = get_class($this->organization);
        return [
            [['exclude_other_members', 'disallow_member_join_other', 'only_accept_current_org_member', 'only_accept_superior_org_member', 'exit_allow_withdraw_actively'], 'boolean', 'trueValue' => '1', 'falseValue' => '0'],
            [['join_password', 'join_entrance_url'], 'string', 'max' => 255],
            ['join_ip_address', 'ip', 'subnet' => null, 'normalize' => true],
            ['join_entrance_url', 'setting_unique', 'skipOnError' => false, 'params' => ['item' => $orgClass::SETTING_ITEM_JOIN_ENTRANCE_URL]],
        ];
    }

    /**
     * Check whether the setting is unique.
     * @param string $attribute the attribute currently being validated
     * @param mixed $params the value of the "params" given in the rule
     * @param \yii\validators\InlineValidator related InlineValidator instance.
     */
    public function setting_unique($attribute, $params, $validator)

    {
        $value = (string)$this->$attribute;
        if (empty($value)) {
            return;
        }

        $class = $this->organization->organizationSettingClass;
        if (empty($class) || !is_string($class)) {
            return;
        }

        $setting = $class::find()->andWhere([
            $this->organization->getNoInitOrganizationSetting()->idAttribute => $params['item'],
            $this->organization->getNoInitOrganizationSetting()->contentAttribute => $value,
        ])->one();
        /* @var $setting OrganizationSetting */
        if ($setting && !$setting->host->equals($this->organization)) {
            $this->addError($attribute, Yii::t('organization', "{value} already exists.", ['value' => $value]));
        }
    }

    /**
     * @inheritdoc
     */
    public function scenarios()
    {
        return [
            static::SCENARIO_ORGANIZATION => ['exclude_other_members', 'disallow_member_join_other', 'join_password', 'join_entrance_url', 'join_ip_address', 'exit_allow_withdraw_actively'],
            static::SCENARIO_DEPARTMENT => ['only_accept_current_org_member', 'only_accept_superior_org_member', 'join_password', 'join_entrance_url', 'join_ip_address', 'exit_allow_withdraw_actively'],
        ];
    }
}


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\forms;
14
15			use rhosocial\organization\Organization;
16			use rhosocial\organization\OrganizationSetting;
17			use Yii;
18			use yii\base\InvalidConfigException;
19			use yii\base\Model;
20			use yii\helpers\Html;
21			use yii\web\ServerErrorHttpException;
22
23			/**
24			* Class SettingsForm
25			* @package rhosocial\organization\forms
26			* @version 1.0
27			* @author vistart <[email protected]>
28			*/
29			class SettingsForm extends Model
30			{
31			/**
32			* @var string
33			*/
34			public $exclude_other_members;
35
36			/**
37			* @var string
38			*/
39			public $disallow_member_join_other;
40
41			/**
42			* @var string
43			*/
44			public $only_accept_current_org_member;
45
46			/**
47			* @var string
48			*/
49			public $only_accept_superior_org_member;
50
51			/**
52			* @var string
53			*/
54			public $join_password;
55
56			/**
57			* @var string
58			*/
59			public $join_ip_address;
60
61			/**
62			* @var string
63			*/
64			public $join_entrance_url;
65
66			/**
67			* @var string
68			*/
69			public $exit_allow_withdraw_actively;
70
71			const SCENARIO_ORGANIZATION = 'organization';
72			const SCENARIO_DEPARTMENT = 'department';
73
74			/**
75			* @var Organization
76			*/
77			public $organization;
78
79			/**
80			* @inheritdoc
81			*/
82			public function init()
83			{
84			if (!$this->organization) {
85			throw new InvalidConfigException('Invalid Organization Model.');
86			}
87			$this->scenario = $this->organization->isOrganization() ? static::SCENARIO_ORGANIZATION : static::SCENARIO_DEPARTMENT;
88			$this->loadSettings();
89			}
90
91			/**
92			* Load settings.
93			*/
94			protected function loadSettings()
95			{
96			if ($this->organization->isOrganization()) {
97			$this->exclude_other_members = $this->organization->isExcludeOtherMembers ? '1' : '0';
98			$this->disallow_member_join_other = $this->organization->isDisallowMemberJoinOther ? '1' : '0';
99			} elseif ($this->organization->isDepartment()) {
100			$this->only_accept_current_org_member = $this->organization->isOnlyAcceptCurrentOrgMember ? '1' : '0';
101			$this->only_accept_superior_org_member = $this->organization->isOnlyAcceptSuperiorOrgMember ? '1' : '0';
102			}
103			$this->join_password = $this->organization->joinPassword;
104			$this->join_ip_address = $this->organization->joinIpAddress;
105			$this->join_entrance_url = $this->organization->joinEntranceUrl;
106			$this->exit_allow_withdraw_actively = $this->organization->exitAllowWithdrawActively ? '1' : '0';
107			}
108
109			/**
110			* Submit settings.
111			*/
112			public function submit()
113			{
114			try {
115			if ($this->organization->isOrganization()) {
116			if ($this->exclude_other_members != ($this->organization->isExcludeOtherMembers ? '1' : '0')) {
117			$this->organization->isExcludeOtherMembers = ($this->exclude_other_members == '1');
118			}
119			if ($this->disallow_member_join_other != ($this->organization->isDisallowMemberJoinOther ? '1' : '0')) {
120			$this->organization->isDisallowMemberJoinOther = ($this->disallow_member_join_other == '1');
121			}
122			} elseif ($this->organization->isDepartment()) {
123			if ($this->only_accept_current_org_member != ($this->organization->isOnlyAcceptCurrentOrgMember ? '1' : '0')) {
124			$this->organization->isOnlyAcceptCurrentOrgMember = ($this->only_accept_current_org_member == '1');
125			}
126			if ($this->only_accept_superior_org_member != ($this->organization->isOnlyAcceptSuperiorOrgMember ? '1' : '0')) {
127			$this->organization->isOnlyAcceptSuperiorOrgMember = ($this->only_accept_superior_org_member == '1');
128			}
129			}
130			if ($this->join_password != $this->organization->joinPassword) {
131			$this->organization->joinPassword = $this->join_password;
132			}
133			if ($this->join_ip_address != $this->organization->joinIpAddress) {
134			$this->organization->joinIpAddress = $this->join_ip_address;
135			}
136			if ($this->join_entrance_url != $this->organization->joinEntranceUrl) {
137			$this->organization->joinEntranceUrl = $this->join_entrance_url;
138			}
139			if ($this->exit_allow_withdraw_actively != ($this->organization->exitAllowWithdrawActively ? '1' : '0')) {
140			$this->organization->exitAllowWithdrawActively = ($this->exit_allow_withdraw_actively == '1');
141			}
142			} catch (\Exception $ex) {
143			throw new ServerErrorHttpException($ex->getMessage());
144			}
145			return true;
146			}
147
148			/**
149			* @inheritdoc
150			*/
151			public function attributeLabels()
152			{
153			return [
154			'exclude_other_members' => Yii::t('organization', 'Exclude other members'),
155			'disallow_member_join_other' => Yii::t('organization', 'Disallow members to join other'),
156			'only_accept_current_org_member' => Yii::t('organization', 'Only accept organization members'),
157			'only_accept_superior_org_member' => Yii::t('organization', 'Only accept superior members'),
158			'join_password' => Yii::t('organization', 'Password'),
159			'join_ip_address' => Yii::t('organization', 'IP Address'),
160			'join_entrance_url' => Yii::t('organization', 'Entrance URL Code'),
161			'exit_allow_withdraw_actively' => Yii::t('organization', 'Allow to Withdraw Actively'),
162			];
163			}
164
165			/**
166			* @inheritdoc
167			*/
168			public function attributeHints()
169			{
170			$topName = $this->organization->isDepartment() ? $this->organization->topOrganization->profile->name . ' (' . $this->organization->topOrganization->getID() . ')' : '';
171			$parentName = $this->organization->isDepartment() ? $this->organization->parent->profile->name . ' (' . $this->organization->parent->getID() . ')' : '';
			0 ignored issues – show Bug introduced 2017-04-22 06:00 UTC by Report Bug Copy Issue Report The property `profile` does not seem to exist in `rhosocial\base\models\traits\SelfBlameableTrait`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history... Bug introduced 2017-04-22 06:00 UTC by Report Bug Copy Issue Report It seems like `getID()` 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			return [
173			'exclude_other_members' =>
174			Yii::t('organization', 'This organization does not allow other organizations and their subordinates\' members to join.') . "<br>" .
175			Yii::t('organization', 'All members of the other organizations (including their subordinates) who have joined this organization (including subordinate departments) are not affected.'),
176			'disallow_member_join_other' =>
177			Yii::t('organization', 'This organization does not allow the organization and its subordinates\' members to join other organizations or their subordinates.') . "<br>" .
178			Yii::t('organization', 'All members of this organization (including subordinate departments) who have joined other organizations (including their subordinates) are not affected.') . "<br>" .
179			Yii::t('organization', 'If this option is enabled, all members of the organization (including subordinate departments) who have the "Set Up Organization" permission will not be able to set up a new organization.'),
180			'only_accept_current_org_member' =>
181			Yii::t('organization', 'This department is only accepted by members of the organization.') . "<br>" .
182			Yii::t('organization', 'That is to say, only the members of {name} are accepted.', ['name' => $topName]),
183			'only_accept_superior_org_member' =>
184			Yii::t('organization', 'This department only accepts members of the parent organization or department.') . "<br>" .
185			Yii::t('organization', 'That is to say, only the members of {name} are accepted.', ['name' => $parentName]),
186			'join_entrance_url' => Yii::t('organization', 'You can assign a unique code to the ' . ($this->organization->isOrganization() ? 'organization' : 'department') . ', and we will generate a unique entrance URL based on this code.') . "<br>" .
187			Yii::t('organization', 'After you enter the code and submit it, the generated URL will appear below.') . "<br>" .
188			Yii::t('organization', 'If you do not want users to join the ' . ($this->organization->isOrganization() ? 'organization' : 'department') . ', please leave blank.') . "<br>" .
189			(empty($this->join_entrance_url) ? Yii::t('organization', 'No entrance URL is currently available.') : Html::a(Yii::t('organization', 'The entrance URL'), [
190			'/organization/join/index',
191			'entrance' => $this->join_entrance_url,
192			], [
193			'class' => 'btn btn-primary',
194			'target' => '_blank',
195			])),
196			'join_password' =>
197			Yii::t('organization', 'If you specify a password, the user needs to provide the password to join.') . "<br>" .
198			Yii::t('organization', 'If you do not need a user to enter a password, leave it blank.'),
199			'join_ip_address' =>
200			Yii::t('organization', 'Only the users from the above IP address (segment) can join the organization / department proactively.'),
201			];
202			}
203
204			/**
205			* @inheritdoc
206			*/
207			public function rules()
208			{
209			$orgClass = get_class($this->organization);
210			return [
211			[['exclude_other_members', 'disallow_member_join_other', 'only_accept_current_org_member', 'only_accept_superior_org_member', 'exit_allow_withdraw_actively'], 'boolean', 'trueValue' => '1', 'falseValue' => '0'],
212			[['join_password', 'join_entrance_url'], 'string', 'max' => 255],
213			['join_ip_address', 'ip', 'subnet' => null, 'normalize' => true],
214			['join_entrance_url', 'setting_unique', 'skipOnError' => false, 'params' => ['item' => $orgClass::SETTING_ITEM_JOIN_ENTRANCE_URL]],
215			];
216			}
217
218			/**
219			* Check whether the setting is unique.
220			* @param string $attribute the attribute currently being validated
221			* @param mixed $params the value of the "params" given in the rule
222			* @param \yii\validators\InlineValidator related InlineValidator instance.
223			*/
224			public function setting_unique($attribute, $params, $validator)
			0 ignored issues – show Unused Code introduced 2017-04-23 05:51 UTC by Report Bug Copy Issue Report The parameter `$validator` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
225			{
226			$value = (string)$this->$attribute;
227			if (empty($value)) {
228			return;
229			}
230
231			$class = $this->organization->organizationSettingClass;
232			if (empty($class) \|\| !is_string($class)) {
233			return;
234			}
235
236			$setting = $class::find()->andWhere([
237			$this->organization->getNoInitOrganizationSetting()->idAttribute => $params['item'],
238			$this->organization->getNoInitOrganizationSetting()->contentAttribute => $value,
239			])->one();
240			/* @var $setting OrganizationSetting */
241			if ($setting && !$setting->host->equals($this->organization)) {
242			$this->addError($attribute, Yii::t('organization', "{value} already exists.", ['value' => $value]));
243			}
244			}
245
246			/**
247			* @inheritdoc
248			*/
249			public function scenarios()
250			{
251			return [
252			static::SCENARIO_ORGANIZATION => ['exclude_other_members', 'disallow_member_join_other', 'join_password', 'join_entrance_url', 'join_ip_address', 'exit_allow_withdraw_actively'],
253			static::SCENARIO_DEPARTMENT => ['only_accept_current_org_member', 'only_accept_superior_org_member', 'join_password', 'join_entrance_url', 'join_ip_address', 'exit_allow_withdraw_actively'],
254			];
255			}
256			}
257

rhosocial / yii2-organization

Push — master ( 9cc424...58c353 )

SettingsForm::attributeHints() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like