rhosocial\organization\web\user\controllers\OrganizationController

Complexity

Total Complexity

37

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	2
Bugs	0	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
B	initMessages()	0	21	7
A	init()	0	5	1
B	getOrganization()	0	17	7
A	actions()	0	8	1
A	behaviors()	0	20	1
A	actionIndex()	0	4	1
A	actionList()	0	18	2
B	actionSetUpOrganization()	0	21	5
B	actionSetUpDepartment()	0	24	6
A	actionView()	0	7	1
A	actionUpdate()	0	4	1
A	actionRevoke()	0	15	4

<?php

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

namespace rhosocial\organization\web\user\controllers;

use rhosocial\organization\exceptions\RevokePreventedException;
use rhosocial\organization\forms\SetUpForm;
use rhosocial\organization\Organization;
use Yii;
use yii\base\InvalidParamException;
use yii\data\ActiveDataProvider;
use yii\filters\AccessControl;
use yii\filters\VerbFilter;
use yii\web\BadRequestHttpException;
use yii\web\Controller;
use yii\web\ServerErrorHttpException;

/**
 * Organization Controller, designed for user module.
 *
 * @version 1.0
 * @author vistart <i@vistart.me>
 */
class OrganizationController extends Controller
{
    public $layout = '@rhosocial/organization/web/user/views/layouts/organization';
    const RESULT_SUCCESS = 'success';
    const RESULT_FAILED = 'failed';
    const SESSION_KEY_MESSAGE = 'session_key_message';
    const SESSION_KEY_RESULT = 'session_key_result';
    public $organizationSetUpSuccessMessage;
    public $organizationSetUpFailedMessage;
    public $departmentSetUpSuccessMessage;
    public $departmentSetUpFailedMessage;
    public $organizationRevokeSuccessMessage;
    public $organizationRevokeFailedMessage;

    public $viewBasePath = '@rhosocial/organization/web/user/views/organization/';

    protected function initMessages()
    {
        if (!is_string($this->organizationSetUpSuccessMessage)) {
            $this->organizationSetUpSuccessMessage = Yii::t('organization' ,'Organization Set Up.');
        }
        if (!is_string($this->organizationSetUpFailedMessage)) {
            $this->organizationSetUpFailedMessage = Yii::t('organization', 'Organization Set Up Failed.');
        }
        if (!is_string($this->departmentSetUpSuccessMessage)) {
            $this->departmentSetUpSuccessMessage = Yii::t('organization' ,'Department Set Up.');
        }
        if (!is_string($this->departmentSetUpFailedMessage)) {
            $this->departmentSetUpFailedMessage = Yii::t('organization', 'Department Set Up Failed.');
        }
        if (!is_string($this->organizationRevokeSuccessMessage)) {
            $this->organizationRevokeSuccessMessage = Yii::t('organization', 'Successfully revoked.');
        }
        if (!is_string($this->organizationRevokeFailedMessage)) {
            $this->organizationRevokeFailedMessage = Yii::t('organization', 'Failed to revoke.');
        }
    }

    public function init()
    {
        $this->initMessages();
        parent::init();
    }

    /**
     * Get organization by specific parameter.
     * @param Organization|string|integer $organization
     * @return Organization
     */
    public function getOrganization($organization)
    {
        if (!$organization) {
            return null;
        }
        $class = Yii::$app->user->identity->organizationClass;
        if ($organization instanceof $class) {
            $organization = $organization->getID();
        }
        if (is_numeric($organization) || is_int($organization)) {
            return $class::find()->id($organization)->one();
        }
        if (is_string($organization) && strlen($organization) == 16) {
            return $class::find()->guid($organization)->one();
        }
        return null;
    }

    /**
     * @inheritdoc
     */
    public function actions()
    {
        return [
            'view-members' => [
                'class' => 'rhosocial\organization\web\user\controllers\organization\ViewMembersAction',
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return [
            'access' => [
                'class' => AccessControl::class,
                'rules' => [
                    [
                        'allow' => true,
                        'roles' => ['@'],
                    ],
                ],
            ],
            'verbs' => [
                'class' => VerbFilter::class,
                'actions' => [
                    'deregister' => ['post'],
                ],
            ],
        ];
    }

    public function actionIndex()
    {
        return $this->render($this->viewBasePath . 'index');
    }

    /**
     * List all organization(s) and department(s) which current user has joined in.
     * @return string the rendering result.
     */
    public function actionList()
    {
        $identity = Yii::$app->user->identity;
        if (!$identity) {
            throw new ServerErrorHttpException('User Not Found.');
        }
        $dataProvider = new ActiveDataProvider([
            'query' => $identity->getAtOrganizations(),
            'pagination' => [
                'pageParam' => 'oganization-page',
                'pageSize' => 20,
            ],
            'sort' => [
                'sortParam' => 'organization-sort',
            ],
        ]);
        return $this->render($this->viewBasePath . 'list', ['dataProvider' => $dataProvider]);
    }

    /**
     * @return string the rendering result.
     */
    public function actionSetUpOrganization()
    {
        $model = new SetUpForm(['user' => Yii::$app->user->identity]);
        if ($model->load(Yii::$app->request->post())) {
            try {
                if (($result = $model->setUpOrganization()) === true) {
                    Yii::$app->session->setFlash(self::SESSION_KEY_RESULT, self::RESULT_SUCCESS);
                    Yii::$app->session->setFlash(self::SESSION_KEY_MESSAGE, '(' . $model->getUser()->lastSetUpOrganization->getID() . ') ' . $this->organizationSetUpSuccessMessage);
                    return $this->redirect(['list']);
                }
                if ($result instanceof \Exception) {
                    throw $result;
                }
            } catch (\Exception $ex) {
                Yii::error($ex->getMessage(), __METHOD__);
                Yii::$app->session->setFlash(self::SESSION_KEY_RESULT, self::RESULT_FAILED);
                Yii::$app->session->setFlash(self::SESSION_KEY_MESSAGE, $this->organizationSetUpFailedMessage);
            }
        }
        return $this->render($this->viewBasePath . 'set-up-organization', ['model' => $model]);
    }

    /**
     * Set up department.
     * @param string $parent Parent organization or department ID.
     * @return string the rendering result.
     */
    public function actionSetUpDepartment($parent)
    {
        $model = new SetUpForm(['user' => Yii::$app->user->identity, 'parent' => $parent]);
        if (!$model->getParent()) {
            throw new BadRequestHttpException(Yii::t('organization', 'Parent Organization/Department Not Exist.'));
        }
        if ($model->load(Yii::$app->request->post())) {
            try {
                if (($result = $model->setUpDepartment()) === true) {
                    Yii::$app->session->setFlash(self::SESSION_KEY_RESULT, self::RESULT_SUCCESS);
                    Yii::$app->session->setFlash(self::SESSION_KEY_MESSAGE, '(' . $model->getUser()->lastSetUpOrganization->getID() . ') ' . $this->departmentSetUpSuccessMessage);
                    return $this->redirect(['list']);
                }
                if ($result instanceof \Exception) {
                    throw $result;
                }
            } catch (\Exception $ex) {
                Yii::error($ex->getMessage(), __METHOD__);
                Yii::$app->session->setFlash(self::SESSION_KEY_RESULT, self::RESULT_FAILED);
                Yii::$app->session->setFlash(self::SESSION_KEY_MESSAGE, $this->departmentSetUpFailedMessage);
            }
        }
        return $this->render($this->viewBasePath . 'set-up-organization', ['model' => $model]);
    }

    public function actionView($id)
    {
        $user = Yii::$app->user->identity;
        $organization = $user->getAtOrganizations()->id($id)->one();
        $profile = $organization->profile;

$profile is not used, you could remove the assignment.

        return $this->render($this->viewBasePath . 'view');
    }

    public function actionUpdate($id)

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

    {
        return $this->render($this->viewBasePath . 'update');
    }

    /**
     * Revoke organization or department.
     * @param string|integer $id
     */
    public function actionRevoke($id)
    {
        try {
            Yii::$app->user->identity->revokeOrganization($id, true);
        } catch (InvalidParamException $ex) {
            throw new BadRequestHttpException(Yii::t('organization', $ex->getMessage()));
        } catch (RevokePreventedException $ex) {
            throw new BadRequestHttpException(Yii::t('organization', $ex->getMessage()));
        } catch (\Exception $ex) {
            throw new ServerErrorHttpException($ex->getMessage());
        }
        Yii::$app->session->setFlash(self::SESSION_KEY_RESULT, self::RESULT_SUCCESS);
        Yii::$app->session->setFlash(self::SESSION_KEY_MESSAGE, "($id) " . $this->organizationRevokeSuccessMessage);
        return $this->redirect(['list']);
    }
}