Blame view

app/mihaildev/elfinder/README.md 9.32 KB
bf807468   Alex Savenko   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
  ElFinder Расширение для Yii 2
  ===========================
  
  ElFinder — файловый менеджер для сайта.
  
  
  ## Установка
  
  Удобнее всего установить это расширение через [composer](http://getcomposer.org/download/).
  
  Либо запустить
  
  ```
  php composer.phar require --prefer-dist mihaildev/yii2-elfinder "*"
  ```
  
  или добавить
  
  ```json
  "mihaildev/yii2-elfinder": "*"
  ```
  
  в разделе `require` вашего composer.json файла.
  
  ## Настройка
  
  ```php
  'controllerMap' => [
          'elfinder' => [
              'class' => 'mihaildev\elfinder\Controller',
              'access' => ['@'], //глобальный доступ к фаил менеджеру @ - для авторизорованных , ? - для гостей , чтоб открыть всем ['@', '?']
              'disabledCommands' => ['netmount'], //отключение ненужных команд https://github.com/Studio-42/elFinder/wiki/Client-configuration-options#commands
              'roots' => [
                  [
                      'baseUrl'=>'@web',
                      'basePath'=>'@webroot',
                      'path' => 'files/global',
                      'name' => 'Global'
                  ],
                  [
                      'class' => 'mihaildev\elfinder\UserPath',
                      'path'  => 'files/user_{id}',
                      'name'  => 'My Documents'
                  ],
                  [
                      'path' => 'files/some',
                      'name' => ['category' => 'my','message' => 'Some Name'] //перевод Yii::t($category, $message)
                  ],
                  [
                      'path'   => 'files/some',
                      'name'   => ['category' => 'my','message' => 'Some Name'], // Yii::t($category, $message)
                      'access' => ['read' => '*', 'write' => 'UserFilesAccess'] // * - для всех, иначе проверка доступа в даааном примере все могут видет а редактировать могут пользователи только с правами UserFilesAccess
                  ]
              ],
              'watermark' => [
              		'source'         => __DIR__.'/logo.png', // Path to Water mark image
                       'marginRight'    => 5,          // Margin right pixel
                       'marginBottom'   => 5,          // Margin bottom pixel
                       'quality'        => 95,         // JPEG image save quality
                       'transparency'   => 70,         // Water mark image transparency ( other than PNG )
                       'targetType'     => IMG_GIF|IMG_JPG|IMG_PNG|IMG_WBMP, // Target image formats ( bit-field )
                       'targetMinPixel' => 200         // Target image minimum pixel size
              ]
          ]
      ],
  ```
  
  ```php
  'controllerMap' => [
          'elfinder' => [
  			'class' => 'mihaildev\elfinder\PathController',
  			'access' => ['@'],
  			'root' => [
  				'path' => 'files',
  				'name' => 'Files'
  			],
  			'watermark' => [
  						'source'         => __DIR__.'/logo.png', // Path to Water mark image
  						 'marginRight'    => 5,          // Margin right pixel
  						 'marginBottom'   => 5,          // Margin bottom pixel
  						 'quality'        => 95,         // JPEG image save quality
  						 'transparency'   => 70,         // Water mark image transparency ( other than PNG )
  						 'targetType'     => IMG_GIF|IMG_JPG|IMG_PNG|IMG_WBMP, // Target image formats ( bit-field )
  						 'targetMinPixel' => 200         // Target image minimum pixel size
  			]
  		]
      ],
  ```
  
  ## Использование
  
  ```php
  use mihaildev\elfinder\InputFile;
  use mihaildev\elfinder\ElFinder;
  use yii\web\JsExpression;
  
  echo InputFile::widget([
      'language'   => 'ru',
      'controller' => 'elfinder', // вставляем название контроллера, по умолчанию равен elfinder
      'filter'     => 'image',    // фильтр файлов, можно задать массив фильтров https://github.com/Studio-42/elFinder/wiki/Client-configuration-options#wiki-onlyMimes
      'name'       => 'myinput',
      'value'      => '',
  ]);
  
  echo $form->field($model, 'attribute')->widget(InputFile::className(), [
      'language'      => 'ru',
      'controller'    => 'elfinder', // вставляем название контроллера, по умолчанию равен elfinder
      'filter'        => 'image',    // фильтр файлов, можно задать массив фильтров https://github.com/Studio-42/elFinder/wiki/Client-configuration-options#wiki-onlyMimes
      'template'      => '<div class="input-group">{input}<span class="input-group-btn">{button}</span></div>',
      'options'       => ['class' => 'form-control'],
      'buttonOptions' => ['class' => 'btn btn-default'],
      'multiple'      => false       // возможность выбора нескольких файлов
  ]);
  
  echo ElFinder::widget([
      'language'         => 'ru',
      'controller'       => 'elfinder', // вставляем название контроллера, по умолчанию равен elfinder
      'filter'           => 'image',    // фильтр файлов, можно задать массив фильтров https://github.com/Studio-42/elFinder/wiki/Client-configuration-options#wiki-onlyMimes
      'callbackFunction' => new JsExpression('function(file, id){}') // id - id виджета
  ]);
  
  ```
  
  ## Использование при работе с PathController
  ```php
  use mihaildev\elfinder\InputFile;
  use mihaildev\elfinder\ElFinder;
  use yii\web\JsExpression;
  
  echo InputFile::widget([
      'language'   => 'ru',
      'controller' => 'elfinder', // вставляем название контроллера, по умолчанию равен elfinder
      'path' => 'image', // будет открыта папка из настроек контроллера с добавлением указанной под деритории  
      'filter'     => 'image',    // фильтр файлов, можно задать массив фильтров https://github.com/Studio-42/elFinder/wiki/Client-configuration-options#wiki-onlyMimes
      'name'       => 'myinput',
      'value'      => '',
  ]);
  
  echo $form->field($model, 'attribute')->widget(InputFile::className(), [
      'language'      => 'ru',
      'controller'    => 'elfinder', // вставляем название контроллера, по умолчанию равен elfinder
      'path' => 'image', // будет открыта папка из настроек контроллера с добавлением указанной под деритории 
      'filter'        => 'image',    // фильтр файлов, можно задать массив фильтров https://github.com/Studio-42/elFinder/wiki/Client-configuration-options#wiki-onlyMimes
      'template'      => '<div class="input-group">{input}<span class="input-group-btn">{button}</span></div>',
      'options'       => ['class' => 'form-control'],
      'buttonOptions' => ['class' => 'btn btn-default'],
      'multiple'      => false       // возможность выбора нескольких файлов
  ]);
  
  echo ElFinder::widget([
      'language'         => 'ru',
      'controller'       => 'elfinder', // вставляем название контроллера, по умолчанию равен elfinder
      'path' => 'image', // будет открыта папка из настроек контроллера с добавлением указанной под деритории 
      'filter'           => 'image',    // фильтр файлов, можно задать массив фильтров https://github.com/Studio-42/elFinder/wiki/Client-configuration-options#wiki-onlyMimes
      'callbackFunction' => new JsExpression('function(file, id){}') // id - id виджета
  ]);
  
  ```
  
  ## CKEditor
  ```php
  use mihaildev\elfinder\ElFinder;
  
  $ckeditorOptions = ElFinder::ckeditorOptions($controller,[/* Some CKEditor Options */]);
  
  ```
  
  Для указания подкаталога (при использовании PathController)
  ```php
  use mihaildev\elfinder\ElFinder;
  
  $ckeditorOptions = ElFinder::ckeditorOptions([$controller, 'path' => 'some/sub/path'],[/* Some CKEditor Options */]);
  
  ```
  
  Использование совместно с приложением "mihaildev/yii2-ckeditor" (https://github.com/MihailDev/yii2-ckeditor)
  
  ```php
  use mihaildev\ckeditor\CKEditor;
  use mihaildev\elfinder\ElFinder;
  
  $form->field($model, 'attribute')->widget(CKEditor::className(), [
    ...
    'editorOptions' => ElFinder::ckeditorOptions('elfinder',[/* Some CKEditor Options */]),
    ...
  ]);
  ```
  
  Для указания подкаталога (при использовании PathController)
  
  ```php
  use mihaildev\ckeditor\CKEditor;
  use mihaildev\elfinder\ElFinder;
  
  $form->field($model, 'attribute')->widget(CKEditor::className(), [
    ...
    'editorOptions' => ElFinder::ckeditorOptions(['elfinder', 'path' => 'some/sub/path'],[/* Some CKEditor Options */]),
    ...
  ]);
  ```
  
  ## Проблемы
  При встраивание без iframe возможен конфликт с bootstrap.js. Studio-42/elFinder#740
  Решение - добавляем в шаблон запись
  ```php
  
  mihaildev\elfinder\Assets::noConflict($this);
  
  ```
  
  ## Полезные ссылки
  
  ElFinder Wiki - https://github.com/Studio-42/elFinder/wiki