Merge pull request #16 from yii2mod/add_file_upload

Add files uploading

Author: Igor Chepurnoy

Bootstrap.php

@@ -23,8 +23,22 @@ public function bootstrap($app)
             ];
         }
 
-        if ($app->getModule('comment') === null) {
+        if (!$app->hasModule('comment')) {
             $app->setModule('comment', ['class' => 'yii2mod\comments\Module']);
         }
+
+        if (!$app->has('fileStorage')) {
+            $app->set('fileStorage', [
+                'class' => 'yii2tech\filestorage\local\Storage',
+                'basePath' => '@webroot/files',
+                'baseUrl' => '@web/files',
+                'filePermission' => 0777,
+                'buckets' => [
+                    'item' => [
+                        'baseSubPath' => 'attachment',
+                    ],
+                ],
+            ]);
+        }
     }
 }

Module.php

@@ -20,12 +20,22 @@ class Module extends \yii\base\Module
     public $defaultRoute = 'manage';
 
     /**
-     * @var array imperavi editor options
+     * @var array froala editor options
+     *
+     * @see https://www.froala.com/wysiwyg-editor/docs
      */
-    public $imperaviEditorOptions = [
-        'plugins' => ['video', 'fullscreen', 'table'],
-        'options' => [
-            'minHeight' => 200,
+    public $froalaEditorOptions = [
+        'clientOptions' => [
+            'heightMin' => 300,
+            'theme' => 'gray',
+            'imageUploadURL' => '/cms/manage/upload-image',
+            'imageManagerDeleteURL' => '/cms/manage/delete-image',
+            'imageManagerDeleteMethod' => 'POST',
+            'imageManagerLoadURL' => '/cms/manage/images',
+        ],
+        'excludedPlugins' => [
+            'file',
+            'emoticons',
         ],
     ];
 

README.md

@@ -4,6 +4,7 @@ This module provides a web interface for content management system and includes
 
 - Allows CRUD operations for pages
 - [Support Markdown Editor](https://github.com/yii2mod/yii2-markdown)
+- [Support Froala Editor](https://www.froala.com/wysiwyg-editor)
 - [Support Comments Management System](https://github.com/yii2mod/yii2-comments)
 - Integrated with [yii2mod/base](https://github.com/yii2mod/base)
 

Widget.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace yii2mod\cms;
+
+use froala\froalaeditor\FroalaEditorWidget;
+use Yii;
+
+/**
+ * Class Widget
+ *
+ * @package yii2mod\cms
+ */
+class Widget extends FroalaEditorWidget
+{
+    /**
+     * @inheritdoc
+     */
+    public function init()
+    {
+        parent::init();
+
+        $request = Yii::$app->getRequest();
+
+        if ($request->enableCsrfValidation) {
+            $this->clientOptions['imageUploadParams'][$request->csrfParam] = $request->getCsrfToken();
+            $this->clientOptions['imageManagerDeleteParams'][$request->csrfParam] = $request->getCsrfToken();
+        }
+    }
+}

composer.json

@@ -15,18 +15,21 @@
         },
         {
             "name": "Igor Chepurnoy",
-            "email": "igorzfort@gmail.com"
+            "email": "chepurnoi.igor@gmail.com"
         }
     ],
     "require": {
         "php": ">=5.6",
         "yiisoft/yii2": "~2.0.11",
+        "yiisoft/yii2-bootstrap": "*",
         "yii2mod/yii2-enum": "*",
         "yii2mod/yii2-editable": "*",
         "yii2mod/yii2-comments": "*",
         "yii2mod/yii2-markdown": "*",
-        "asofter/yii2-imperavi-redactor": "*",
-        "cebe/markdown": "~1.1.1"
+        "froala/yii2-froala-editor": "dev-master",
+        "cebe/markdown": "~1.1.1",
+        "yii2tech/ar-file": "*",
+        "yiisoft/yii2-imagine": "^2.1"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "~2.0"

controllers/ManageController.php

@@ -3,9 +3,12 @@
 namespace yii2mod\cms\controllers;
 
 use Yii;
-use yii\filters\VerbFilter;
+use yii\db\ActiveRecord;
 use yii\web\Controller;
 use yii\web\NotFoundHttpException;
+use yii\web\UnprocessableEntityHttpException;
+use yii\web\UploadedFile;
+use yii2mod\cms\models\AttachmentModel;
 use yii2mod\cms\models\CmsModel;
 use yii2mod\editable\EditableAction;
 
@@ -41,6 +44,27 @@ class ManageController extends Controller
      */
     public $modelClass = 'yii2mod\cms\models\CmsModel';
 
+    /**
+     * @var string class name for attachment model
+     */
+    public $attachmentModelClass = 'yii2mod\cms\models\AttachmentModel';
+
+    /**
+     * @var array verb filter config
+     */
+    public $verbFilterConfig = [
+        'class' => 'yii\filters\VerbFilter',
+        'actions' => [
+            'index' => ['get'],
+            'create' => ['get', 'post'],
+            'update' => ['get', 'post'],
+            'delete' => ['post'],
+            'upload-image' => ['post'],
+            'delete-image' => ['post'],
+            'images' => ['get'],
+        ],
+    ];
+
     /**
      * @var array access control config
      */
@@ -60,15 +84,7 @@ class ManageController extends Controller
     public function behaviors()
     {
         return [
-            'verbs' => [
-                'class' => VerbFilter::class,
-                'actions' => [
-                    'index' => ['get'],
-                    'create' => ['get', 'post'],
-                    'update' => ['get', 'post'],
-                    'delete' => ['post'],
-                ],
-            ],
+            'verbs' => $this->verbFilterConfig,
             'access' => $this->accessControlConfig,
         ];
     }
@@ -87,7 +103,7 @@ public function actions()
     }
 
     /**
-     * Lists all CmsModel models.
+     * List of all cms models.
      *
      * @return mixed
      */
@@ -103,7 +119,7 @@ public function actionIndex()
     }
 
     /**
-     * Creates a new CmsModel model.
+     * Creates a new CmsModel.
      *
      * If creation is successful, the browser will be redirected to the 'index' page.
      *
@@ -125,7 +141,7 @@ public function actionCreate()
     }
 
     /**
-     * Updates an existing CmsModel model.
+     * Updates an existing CmsModel.
      *
      * If update is successful, the browser will be redirected to the 'index' page.
      *
@@ -135,7 +151,7 @@ public function actionCreate()
      */
     public function actionUpdate($id)
     {
-        $model = $this->findModel($id);
+        $model = $this->findModel($this->modelClass, $id);
 
         if ($model->load(Yii::$app->request->post()) && $model->save()) {
             Yii::$app->session->setFlash('success', Yii::t('yii2mod.cms', 'Page has been updated.'));
@@ -149,7 +165,7 @@ public function actionUpdate($id)
     }
 
     /**
-     * Deletes an existing CmsModel model.
+     * Deletes an existing CmsModel.
      *
      * If deletion is successful, the browser will be redirected to the 'index' page.
      *
@@ -159,27 +175,85 @@ public function actionUpdate($id)
      */
     public function actionDelete($id)
     {
-        $this->findModel($id)->delete();
+        $this->findModel($this->modelClass, $id)->delete();
         Yii::$app->session->setFlash('success', Yii::t('yii2mod.cms', 'Page has been deleted.'));
 
         return $this->redirect(['index']);
     }
 
     /**
-     * Finds the CmsModel model based on its primary key value.
+     * Upload an image
+     *
+     * @return \yii\web\Response
+     *
+     * @throws UnprocessableEntityHttpException
+     */
+    public function actionUploadImage()
+    {
+        $model = Yii::createObject($this->attachmentModelClass);
+        $model->file = UploadedFile::getInstanceByName('file');
+
+        if (!$model->save()) {
+            throw new UnprocessableEntityHttpException($model->getFirstError('file'));
+        }
+
+        return $this->asJson([
+            'link' => $model->getFileUrl('origin'),
+        ]);
+    }
+
+    /**
+     * Delete the image
+     *
+     * @return \yii\web\Response
+     *
+     * @throws UnprocessableEntityHttpException
+     */
+    public function actionDeleteImage()
+    {
+        $model = $this->findModel($this->attachmentModelClass, Yii::$app->request->post('id'));
+
+        $model->delete();
+
+        return $this->asJson([
+            'status' => 'success',
+        ]);
+    }
+
+    /**
+     * Return list of all images
+     *
+     * @return \yii\web\Response
+     */
+    public function actionImages()
+    {
+        $result = [];
+
+        foreach (AttachmentModel::find()->each() as $attachment) {
+            $result[] = [
+                'id' => $attachment->id,
+                'url' => $attachment->getFileUrl('origin'),
+                'thumb' => $attachment->getFileUrl('thumbnail'),
+            ];
+        }
+
+        return $this->asJson($result);
+    }
+
+    /**
+     * Finds the model based on its primary key value.
      * If the model is not found, a 404 HTTP exception will be thrown.
      *
-     * @param int $id
+     * @param string|ActiveRecord $modelClass
+     * @param $condition
      *
-     * @return CmsModel the loaded model
+     * @return ActiveRecord the loaded model
      *
      * @throws NotFoundHttpException if the model cannot be found
      */
-    protected function findModel($id)
+    protected function findModel($modelClass, $condition)
     {
-        $cmsModel = $this->modelClass;
-
-        if (($model = $cmsModel::findOne($id)) !== null) {
+        if (($model = $modelClass::findOne($condition)) !== null) {
             return $model;
         } else {
             throw new NotFoundHttpException(Yii::t('yii2mod.cms', 'The requested page does not exist.'));

messages/en/yii2mod.cms.php

@@ -48,4 +48,6 @@
     'Page has been updated.' => 'Page has been updated.',
     'Page has been deleted.' => 'Page has been deleted.',
     'The requested page does not exist.' => 'The requested page does not exist.',
+    'File Extension' => 'File Extension',
+    'File Version' => 'File Version',
 ];

messages/ru/yii2mod.cms.php

@@ -48,4 +48,6 @@
     'Page has been updated.' => 'Страница был обновлена.',
     'Page has been deleted.' => 'Страница был удалена.',
     'The requested page does not exist.' => 'Ошибка 404 - страница не найдена!',
+    'File Extension' => 'Расширение Файла',
+    'File Version' => 'Версия Файла',
 ];

migrations/m170419_224001_create_attachment_table.php

@@ -0,0 +1,29 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Handles the creation of table `attachment`.
+ */
+class m170419_224001_create_attachment_table extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function up()
+    {
+        $this->createTable('{{%attachment}}', [
+            'id' => $this->primaryKey(),
+            'file_extension' => $this->string(),
+            'file_version' => $this->integer(),
+        ]);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function down()
+    {
+        $this->dropTable('{{%attachment}}');
+    }
+}