simialbi/yii2-elfinder

Elfinder implementation for yii2 framework

yii2-elfinder

This extension integrates the jQuery elFinder into yii2 framework (the yii way: with elFinder component, behaviors, configurable objects, events etc.). Additionally it prevents jui/elfinder css from loading and provides it's own styles for elfinder (bootstrap3 / fontawesome scss based style)., _(*1)

, _(*2)

Resources

• elFinder
• yii2 framework

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

$ php composer.phar require --prefer-dist simialbi/yii2-elfinder

or add, _(*5)

"simialbi/yii2-elfinder": "*"

to the require section of your composer.json, _(*6)

Usage

Setup Module

Add the module elfinder to the modules section of your configuration file:, _(*7)

'modules' => [
    'elfinder' => [
        'class'          => 'simialbi\yii2\elfinder\Module',
        'options'        => [
            'default' => [
                'class'      => 'simialbi\yii2\elfinder\ElFinderOptions',
                'locale'     => 'de_DE.UTF-8',
                'maxTargets' => 0
            ]
        ],
        'connectionSets' => [
            'default' => [ // like elfinder roots
                [
                    'class' => 'simialbi\yii2\elfinder\ElFinderConfigurationLocalFileSystem',
                    'path'  => '@webroot/files',
                    'URL'   => '@web/files'
                ]
            ]
        ],
        'volumeBehaviors' => [
            'default' => [ // like elfinder plugins, add behaviors
                'as resizer'   => [
                    'class'     => 'simialbi\yii2\elfinder\behaviors\ImageResizeBehavior',
                    'maxWidth'  => 1920,
                    'maxHeight' => 1080,
                    'quality'   => 70
                ],
                'as optimizer' => [
                    'class' => 'simialbi\yii2\elfinder\behaviors\ImageOptimizeBehavior'
                ]
            ]
        ]
    ]
]

Example Usage

Elfinder widget

To include an elfinder instance in one of your pages, call the elfinder widget like this:, _(*8)

title = 'elFinder';
$this->params['breadcrumbs'][] = $this->title;

?>



 'default' // from module connectionSets/volumeBehaviors configuration (array key)
    ]);
?>

All options from elfinder client configuration options and instanceName can be used to configure the widget., _(*9)

ElFinderInput widget

To include an elfinder input field widget, call the input widget like this:, _(*10)

title = 'elFinder';
$this->params['breadcrumbs'][] = $this->title;

?>



 'my-file',
        'value' => '/path/to/my/file.ext',
        'instanceName' => 'default'
    ]);
    // or model like usage
    /* @var $form \yii\widgets\ActiveForm */
    /* @var $model \yii\base\Model */
    echo $form->field($model, 'my-file')->widget(
        ElFinderInput::className(),
        [
           'instanceName' => 'default'
        ]
    );
?>

License

yii2-elfinder is released under MIT license. See bundled LICENSE for details., _(*11)