modules\users\controllers\common\ProfileController

Complexity

Total Complexity

41

Size/Duplication

Total Lines	261
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	1

15 Methods

Rating	Name	Duplication	Size	Complexity
A	findModel()	0	12	3
A	actionDeleteAvatar()	0	11	1
A	actionUpdate()	0	14	3
A	actionUpdatePassword()	0	11	3
A	actionUpdateAvatar()	0	11	3
A	actionDelete()	0	14	3
A	actionAjaxValidateAvatarForm()	0	8	3
A	actionAjaxValidatePasswordDeleteForm()	0	8	3
A	actionGenerateAuthKey()	0	10	2
A	actionAjaxValidatePasswordForm()	0	8	3
A	actionIndex()	0	10	1
A	actionCropAvatar()	0	8	4
A	actionAvatar()	0	13	3
A	actionUploadImage()	0	16	5
A	processGenerateAuthKey()	0	6	1

<?php

namespace modules\users\controllers\common;

use Yii;
use yii\base\Exception;
use yii\db\StaleObjectException;
use yii\web\Controller;
use yii\web\NotFoundHttpException;
use yii\bootstrap\ActiveForm;
use yii\web\Response;
use yii\web\UploadedFile;
use modules\users\models\UploadForm;
use modules\users\models\User;
use modules\users\models\UpdatePasswordForm;
use modules\users\models\UserDeleteForm;
use modules\rbac\models\Assignment;
use modules\users\Module;

/**
 * Class ProfileController
 * @package modules\users\controllers\common
 */
class ProfileController extends Controller
{
    /**
     * @return string
     * @throws NotFoundHttpException
     */
    public function actionIndex()
    {
        $model = $this->findModel();

        $assignModel = new Assignment();
        $assignModel->user = $model;

        return $this->render('index', [
            'model' => $model,
            'assignModel' => $assignModel
        ]);
    }

    /**
     * @return string
     * @throws NotFoundHttpException
     */
    public function actionUpdate()
    {
        $model = $this->findModel();
        $uploadFormModel = new UploadForm();
        if ($model->profile->load(Yii::$app->request->post()) && $model->profile->save()) {
            /** @var yii\web\Session $session */
            $session = Yii::$app->session;
            $session->setFlash('success', Module::t('module', 'Profile successfully save.'));
            return $this->redirect(['update', 'tab' => 'profile']);

The expression return $this->redirect(array('update', 'tab' => 'profile')) returns the type yii\web\Response which is incompatible with the documented return type string.

        }
        return $this->render('update', [
            'model' => $model,
            'uploadFormModel' => $uploadFormModel,
            'passwordForm' => new UpdatePasswordForm($model)
        ]);
    }

    /**
     * @return Response
     * @throws NotFoundHttpException
     * @throws Exception
     */
    public function actionUpdateAvatar()
    {
        $model = $this->findModel();
        /** @var yii\web\Session $session */
        $session = Yii::$app->session;
        if ($model->profile->load(Yii::$app->request->post()) && $model->profile->save()) {
            $session->setFlash('success', Module::t('module', 'Form successfully saved.'));
        } else {
            $session->setFlash('error', Module::t('module', 'Error! Failed to save the form.'));
        }
        return $this->redirect(['update', 'tab' => 'avatar']);
    }

    /**
     * @return array|Response
     * @throws NotFoundHttpException
     */
    public function actionAjaxValidateAvatarForm()
    {
        $model = $this->findModel();
        if (Yii::$app->request->isAjax && $model->profile->load(Yii::$app->request->post())) {
            Yii::$app->response->format = Response::FORMAT_JSON;
            return ActiveForm::validate($model->profile);
        }
        return $this->redirect(['index']);
    }

    /**
     * Upload file
     * @return Response
     * @throws Exception
     */
    public function actionUploadImage()
    {
        $model = new UploadForm();
        if (Yii::$app->request->isPost) {
            $session = Yii::$app->session;
            $model->imageFile = UploadedFile::getInstance($model, 'imageFile');
            if (($result = $model->upload()) && !is_string($result)) {
                if (isset($result['imageFile'][0])) {
                    $session->setFlash('error', $result['imageFile'][0]);

The method setFlash() does not exist on null.

                } else {
                    $session->setFlash('error', Module::t('module', 'Failed to upload file.'));
                }
                return $this->redirect(['update', 'tab' => 'avatar']);
            }
        }
        return $this->redirect(['update', 'tab' => 'avatar', 'modal' => 'show']);
    }

    /**
     * Crop image
     * @return Response
     */
    public function actionCropAvatar()
    {
        $model = new UploadForm();
        $session = Yii::$app->session;
        if (($post = Yii::$app->request->post()) && $model->load($post) && $model->crop()) {
            $session->setFlash('success', Module::t('module', 'User avatar successfully save.'));
        }
        return $this->redirect(['update', 'tab' => 'avatar']);
    }

    /**
     * Get Avatar
     * @throws NotFoundHttpException
     */
    public function actionAvatar()
    {
        if ($file = Yii::$app->request->get('filename')) {
            $id = Yii::$app->request->get('id') ?: Yii::$app->user->id;
            $model = new UploadForm();
            $storagePath = $model->getPath($id);
            $response = Yii::$app->getResponse();
            $response->headers->set('Content-Type', 'image/jpg');
            $response->format = Response::FORMAT_RAW;
            $response->stream = fopen("$storagePath/$file", 'rb');

It seems like fopen($storagePath.'/'.$file, 'rb') can also be of type false. However, the property $stream is declared as type array|resource. Maybe add an additional type check?

            return $response->send();

Are you sure the usage of $response->send() targeting yii\web\Response::send() seems to always return null.

Are you sure the usage of $response->send() targeting yii\base\Response::send() seems to always return null.

        }
        throw new NotFoundHttpException('The requested page does not exist.');
    }

    /**
     * Delete Avatar files
     * @param int $id
     * @return Response
     */
    public function actionDeleteAvatar($id)
    {
        $model = new UploadForm();
        $fileName = $model->getFileName();
        $avatar = $model->getPath($id) . DIRECTORY_SEPARATOR . $fileName;
        $thumb = $model->getPath($id) . DIRECTORY_SEPARATOR . UploadForm::PREFIX_THUMBNAIL . $fileName;
        $original = $model->getPath($id) . DIRECTORY_SEPARATOR . UploadForm::PREFIX_ORIGINAL . $fileName;
        $model->delete([$avatar, $thumb, $original]);
        $session = Yii::$app->session;
        $session->setFlash('success', Module::t('module', 'Successfully deleted.'));
        return $this->redirect(Yii::$app->request->referrer);
    }

    /**
     * @return Response
     * @throws NotFoundHttpException
     * @throws Exception
     */
    public function actionUpdatePassword()
    {
        $model = new UpdatePasswordForm($this->findModel());
        /** @var yii\web\Session $session */
        $session = Yii::$app->session;
        if ($model->load(Yii::$app->request->post()) && $model->resetPassword()) {
            $session->setFlash('success', Module::t('module', 'Password changed successfully.'));
        } else {
            $session->setFlash('error', Module::t('module', 'Error! Password changed not successfully.'));
        }
        return $this->redirect(['update', 'tab' => 'password']);
    }

    /**
     * @return array|Response
     * @throws NotFoundHttpException
     */
    public function actionAjaxValidatePasswordForm()
    {
        $model = new UpdatePasswordForm($this->findModel());
        if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
            Yii::$app->response->format = Response::FORMAT_JSON;
            return ActiveForm::validate($model);
        }
        return $this->redirect(['index']);
    }

    /**
     * @return array|Response
     * @throws NotFoundHttpException
     */
    public function actionAjaxValidatePasswordDeleteForm()
    {
        $model = new UserDeleteForm($this->findModel());
        if (Yii::$app->request->isAjax && $model->load(Yii::$app->request->post())) {
            Yii::$app->response->format = Response::FORMAT_JSON;
            return ActiveForm::validate($model);
        }
        return $this->redirect(['delete']);
    }

    /**
     * @return array|Response
     * @throws Exception
     * @throws NotFoundHttpException
     */
    public function actionGenerateAuthKey()
    {
        $model = $this->processGenerateAuthKey();
        if (Yii::$app->request->isAjax) {
            Yii::$app->response->format = Response::FORMAT_JSON;
            return [
                'success' => $model->auth_key
            ];
        }
        return $this->redirect(['index']);
    }

    /**
     * @return User
     * @throws Exception
     * @throws NotFoundHttpException
     */
    private function processGenerateAuthKey()
    {
        $model = $this->findModel();
        $model->generateAuthKey();
        $model->save();
        return $model;
    }

    /**
     * @return string|Response
     * @throws NotFoundHttpException
     * @throws \Throwable
     * @throws StaleObjectException
     */
    public function actionDelete()
    {
        $model = new UserDeleteForm($this->findModel());
        if ($model->load(Yii::$app->request->post()) && $model->userDelete()) {

The expression $model->userDelete() of type false|integer is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== false instead.

            /** @var \yii\web\User $user */
            $user = Yii::$app->user;
            $user->logout();
            /** @var yii\web\Session $session */
            $session = Yii::$app->session;
            $session->setFlash('success', Module::t('module', 'Your profile has been successfully deleted!'));
            return $this->goHome();
        }
        return $this->render('delete', [
            'model' => $model
        ]);
    }

    /**
     * @return User
     * @throws NotFoundHttpException
     */
    private function findModel()
    {
        /** @var \yii\web\User $user */
        $user = Yii::$app->user;
        if (!$user->isGuest) {
            /** @var User $identity */
            $identity = Yii::$app->user->identity;
            if (($model = User::findOne($identity->id)) !== null) {
                return $model;
            }
        }
        throw new NotFoundHttpException(Module::t('module', 'The requested page does not exist.'));
    }
}