rhosocial / yii2-organization

forms/SettingsForm.php

<?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 <i@vistart.me>
 */
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() . ')' : '';

The property profile does not seem to exist in rhosocial\base\models\traits\SelfBlameableTrait.

It seems like getID() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        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.') . "<br>" .
                Yii::t('organization', 'For example, the local address segment is {ip}.', ['ip' => '127.0.0.0/8']) . "<br>" .
                Yii::t('organization', 'If you do not restrict the IP address (segment), leave it blank.'),
        ];
    }

    /**
     * @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)

The parameter $validator is not used and could be removed.

    {
        $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'
            ],
        ];
    }
}