stump90/yii2-redactor

A redactor extension for the Yii2 Framework.

2.90.3 2022-06-08 10:35 UTC

Requires

• fedemotta/yii2-aws-sdk: *
• yiisoft/yii2: *

BSD-3-Clause

• Nghia Nguyen
• Stuart Millington

• wysiwyg
• extension
• Redactor
• html editor
• yii2
• imperavi

README

A redactor extension for Yii2 Framework. This version is a fork of yiidoc/yii2-redactor to allow some additional settings and options.

For install, replace "yiidoc/" with "stump90/" along with a repository if this has not been published on packagelist yet...

Changes

English (UK) language added

    'clientOptions' => [
        ...
        'lang' => 'en_gb',
        ...
    ]

.size()

.size() replaced with .length for JQuery compatibility.

removePastedImages (default false)

Additional option to remove images pasted in to content (as base64 data) - less restrictive than pastePlainText.

removePastedImagesMessage (default blank)

Additional option to tell users the correct way to upload images.

        'clientOptions' => [
            ...
            'pastePlainText' => false,
            'removePastedImages' => true,
            'removePastedImagesMessage' => "<h1>Please upload images via filemanager or drag'n'drop</h1>",
            ...
        ]

authUserDir config option

Additional config option added - authUserDir (default blank, allowed characters a-zA-Z0-9 only) When set, this hides logged in user id's in file paths and uses a common folder for all logged in users. The guest user file path is still 'guest'.

    'modules' => [
        'redactor' => [
            'class' => 'yii\redactor\RedactorModule',
            'uploadDir' => '@webroot/uploads',
            'uploadUrl' => '@web/uploads',
            'imageAllowExtensions'=>['jpg','jpeg','png','gif','webp'],
            'authUserDir' => 'files'
        ],
    ],

Integrate Redactor-10-clipboardPaste-plugin

Integrated CFDan's clipboardPaste plugin and added clipboard upload action.

Source: https://github.com/CFDan/Redactor-10-clipboardPaste-plugin

        'clientOptions' => [
            ...
            'removePastedImages' => true,
            'removePastedImagesMessage' => "",
            'plugins' => ['fontcolor','imagemanager','filemanager','clipboardPaste'],
            'clipboardUploadUrl' => ['/redactor/upload/image-clip'],
            'clipboardUpload' => true,
            ...
        ]

Original yiidoc/yii2-redactor Readme:

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yiidoc/yii2-redactor "*"

or

 "yiidoc/yii2-redactor": "*"

to the require section of your composer.json.

Configure

Add to config file (config/web.php or common\config\main.php)

    'modules' => [
        'redactor' => 'yii\redactor\RedactorModule',
    ],

or if you want to change the upload directory. to path/to/uploadfolder default value @webroot/uploads

    'modules' => [
        'redactor' => [
            'class' => 'yii\redactor\RedactorModule',
            'uploadDir' => '@webroot/path/to/uploadfolder',
            'uploadUrl' => '@web/path/to/uploadfolder',
            'imageAllowExtensions'=>['jpg','png','gif']
        ],
    ],

note: You need to create uploads folder and chmod and set security for folder upload reference: Protect Your Uploads Folder with .htaccess, How to Setup Secure Media Uploads

Config view/form

<?= $form->field($model, 'body')->widget(\yii\redactor\widgets\Redactor::className()) ?>

or not use ActiveField

<?= \yii\redactor\widgets\Redactor::widget([
    'model' => $model,
    'attribute' => 'body'
]) ?>

or config advanced redactor reference Docs

<?= $form->field($model, 'body')->widget(\yii\redactor\widgets\Redactor::className(), [
    'clientOptions' => [
        'imageManagerJson' => ['/redactor/upload/image-json'],
        'imageUpload' => ['/redactor/upload/image'],
        'fileUpload' => ['/redactor/upload/file'],
        'lang' => 'zh_cn',
        'plugins' => ['clips', 'fontcolor','imagemanager']
    ]
])?>