app\modules\data\controllers\FileController

Complexity

Total Complexity

29

Size/Duplication

Total Lines	226
Duplicated Lines	6.19 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	behaviors()	14	14	1
A	actionIndex()	0	12	1
F	unifiedAction()	0	129	19
A	actionImport()	0	4	1
A	actionExport()	0	4	1
B	actionDownloadFile()	0	27	6

<?php

namespace app\modules\data\controllers;

use app\modules\data\components\ExportableInterface;
use Yii;
use app\modules\data\models\Import;
use app\modules\data\models\Export;
use app\models\BaseObject;
use app\modules\data\models\ImportModel;
use app\backgroundtasks\helpers\BackgroundTasks;
use yii\base\ErrorException;
use yii\data\ActiveDataProvider;
use yii\filters\AccessControl;
use yii\helpers\ArrayHelper;
use yii\web\HttpException;
use yii\web\UploadedFile;

/**
 * Class FileController
 * @package app\modules\data\controllers
 */
class FileController  extends \app\backend\components\BackendController
{
    /**
     * @return array

Consider making the return type a bit more specific; maybe use array<string,array<string,string|array<string,boolean|string[]>[]>>.

     */
    public function behaviors()
    {
        return [
            'access' => [
                'class' => AccessControl::className(),

The method yii\base\BaseObject::className() has been deprecated with message: since 2.0.14. On PHP >=5.5, use `::class` instead.

                'rules' => [
                    [
                        'allow' => true,
                        'roles' => ['data manage'],
                    ],
                ],
            ],
        ];
    }

    /**
     * @return string
     */
    public function actionIndex()
    {
        $objects = new ActiveDataProvider([
            'query' => BaseObject::find()->with(['lastExport', 'lastImport']),
            'pagination' => [
                'pageSize' => 10,
            ],
            'sort' => false,
        ]);

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

    /**
     * Unified action for import and export
     * @param $id
     * @param $importMode
     * @return string|\yii\web\Response
     * @throws ErrorException
     */
    private function unifiedAction($id, $importMode)
    {
        $object = BaseObject::findById($id);
        /* @var $className \app\modules\data\models\Import */
        $className =
            $importMode ?
            'app\modules\data\models\Import' :
            'app\modules\data\models\Export';

        if ($object !== null) {
            $model = new ImportModel(['object' => $id]);

            $fields = \app\modules\data\components\Import::getFields($model->object);


            if (\Yii::$app->request->isPost) {
                if (
                    $model->load(\Yii::$app->request->post()) && $model->validate()
                ) {
                    $import = $className::find()->where(
                        [
                            'user_id' => Yii::$app->user->id,
                            'object_id' => $id,
                        ]
                    )->one();

                    if ($import === null) {
                        $import = new $className(
                            [
                                'user_id' => Yii::$app->user->id,
                                'object_id' => $id,
                            ]
                        );
                    }

                    $import->filename = null;
                    if ($importMode === true) {
                        $file = UploadedFile::getInstance($model, 'file');
                        $model->type = $file->extension;
                        $filename = $model->getFilename('Import');
                        $import->filename = $filename;
                        $fullFilename =
                            Yii::$app->getModule('data')->importDir .
                            '/' .
                            $filename;
                        if ($file->saveAs($fullFilename) === false) {
                            throw new ErrorException("Unable to save file");
                        }
                    }

                    $import->status = $className::STATUS_PROCESS;

                    $task_options = Yii::$app->request->post('Task', []);

                    if ($import->save()) {
                        BackgroundTasks::addTask([
                            'name' =>
                                $importMode ? 'import' : 'export',
                            'description' =>
                                ($importMode ? 'import' : 'export') .
                                " {$model->object}",
                            'action' =>
                                'data/file/' .
                                ($importMode ? 'import' : 'export'),
                            'params' =>
                                $model->serialize(),
                            'init_event' =>
                                ($importMode ? 'import' : 'export'),
                        ],
                        [
                            'create_notification' => isset($task_options['create_notification']) && 1 == $task_options['create_notification'] ? true : false,
                        ]);
                        \Yii::$app->session->setFlash(
                            'info',
                            \Yii::t('app', 'Task is queued. Come back later.')
                        );
                    } else {
                        \Yii::$app->session->setFlash(
                            'error',
                            \Yii::t('app', 'Import Error')
                        );
                    }



                    return $this->redirect(['/data/file']);
                }
            }

            $availablePropertyGroups = [];

            /** @var \app\modules\shop\models\Product $exampleModel - product for example */
            $exampleModel = new $object->object_class;
            if ($exampleModel->hasMethod('getPropertyGroups')) {
                $availablePropertyGroups = $exampleModel->getPropertyGroups(

The method getPropertyGroups does not exist on object<app\modules\shop\models\Product>? Since you implemented __call, maybe consider adding a @method annotation.

                        false,
                        true
                    );
            }

            \Yii::$app->session->setFlash(
                'info',
                \Yii::t('app', 'Specify fields to import and select the file')
            );

            $fields['additionalFields'] = [];
            if ($exampleModel instanceof ExportableInterface) {
                $fields['additionalFields'] = $exampleModel::exportableAdditionalFields();
            }

            if ($model->type === null) {
                $model->type = Yii::$app->modules['data']->defaultType;
            }

            return $this->render('import-export', [
                'model' => $model,
                'object' => $object,
                'fields' => $fields,
                'availablePropertyGroups' => $availablePropertyGroups,
                'importMode' => $importMode,
            ]);
        } else {
            \Yii::$app->session->setFlash(
                'error',
                \Yii::t('app', 'Object not found')
            );
            return $this->redirect(['/data/file']);
        }
    }

    /**
     * @param $id
     * @return string|\yii\web\Response
     * @throws ErrorException
     */
    public function actionImport($id)
    {
        return $this->unifiedAction($id, true);
    }

    /**
     * @param $id
     * @return string|\yii\web\Response
     * @throws ErrorException
     */
    public function actionExport($id)
    {
        return $this->unifiedAction($id, false);
    }

    /**
     * @param $dir
     * @param $file
     * @throws HttpException
     */
    public function actionDownloadFile($dir, $file)
    {
        $errors = [];
        switch ($dir) {
            case 'import':
                $filePath =  Yii::$app->getModule('data')->importDir.'/'.$file;;
                break;
            case 'export':
                $filePath =  Yii::$app->getModule('data')->exportDir.'/'.$file;;
                break;
            default :
                $filePath = false;
                break;
        }

        if (in_array($dir, ['import', 'export']) === false) {
            $errors[] = 'path not found';
        }
        if (!is_file($filePath)) {
            $errors[] = 'file not found';
        }
        if ($errors !== []) {
            throw new HttpException(403, implode(', ', $errors));
        }

        Yii::$app->response->sendFile($filePath, $file);
    }
}