helios-ag / fm-elfinder-bundle
ElFinder bundle, adds ElFinder file manager to your Symfony project
Installs: 3 782 701
Dependents: 36
Suggesters: 4
Security: 0
Stars: 275
Watchers: 13
Forks: 128
Open Issues: 18
Type:symfony-bundle
Requires
- php: ^7.4 || ^8.0
- ext-json: *
- studio-42/elfinder: ~2.1.62
- symfony/asset: ^4.4 || ^5.0 || ^5.2 || ^6.0 || ^7.0
- symfony/form: ^4.4 || ^5.0 || ^5.2 || ^6.0 || ^7.0
- symfony/framework-bundle: ^4.4 || ^5.0 || ^5.2 || ^6.0 || ^7.0
- symfony/twig-bundle: ^4.4 || ^5.0 || ^5.2 || ^6.0 || ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: dev-master
- matthiasnoback/symfony-config-test: ^4.0
- matthiasnoback/symfony-dependency-injection-test: ^4.1
- php-coveralls/php-coveralls: ^2.0
- symfony/finder: ^4.4 || ^5.0 || ^5.2 || ^6.0 || ^7.0
- symfony/phpunit-bridge: ^7.0.1
Suggests
- barryvdh/elfinder-flysystem-driver: Flysystem driver for elfinder
- friendsofsymfony/ckeditor-bundle: FOSCKEditorBundle WYSIWYG Editor Bundle
- helios-ag/fm-summernote-bundle: FMSummernoteBundle WYSIWYG Editor Bundle
- helios-ag/fm-tinymce-bundle: FMTinyMCEBundle WYSIWYG Editor Bundle
- spatie/flysystem-dropbox: Dropbox 2 Driver for Flysystem
- dev-main
- 12.6
- 12.5
- 12.4
- 12.3.3
- 12.3.2
- 12.3.1
- 12.3
- 12.2.3
- 12.2.2
- 12.2.1
- 12.2
- 12.1.3
- 12.1.2
- 12.1.1
- 12.1
- 11.0
- 10.1
- 10.0.4
- 10.0.3
- 10.0.2
- 10.0.1
- 10
- 9.3.2
- 9.3.1
- 9.3
- 9.2.1
- 9.2
- 9.1.1
- 9.1
- 9
- 8.0.3
- 8.0.2
- 8.0.1
- 8.0
- 7.0.1
- 7.0
- 6.2.1
- 6.2
- 6.1.2
- 6.1.1
- 6.1
- 6.0.3
- 6.0.2
- 6.0.1
- 6.0
- 5.3
- 5.2.1
- 5.2
- 5.1
- 5.0.5
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5
- 4.0.2
- 4.0.1
- 4.0
- 3.4
- 3.3
- 3.2.1
- 3.2
- 3.1
- 3.0
- 2.5.1
- 2.5
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.1
- v2.0
- 1.5
- 1.4.2
- 1.4.1
- 1.4
- 1.3
- 1.2
- 1.1
- 1.0
- dev-updates
- dev-trash-volume
This package is auto-updated.
Last update: 2024-12-01 13:44:37 UTC
README
ElFinder integration in Symfony
Code Quality Assurance
elFinder is an open-source file manager for web, written in JavaScript using jQuery UI. Creation is inspired by simplicity and convenience of Finder program used in Mac OS X operating system.
Recommended bundles to use with:
Table of contents
- Installation
- Basic configuration
- CORS support
- Events listeners / subscribers
- Elfinder Form Type
- CKEditor integration
- TinyMCE integration
- Summernote integration
- Advanced configuration
- Configuration dump
Installation
Step 1: Installation
For Symfony Flex installation you need to enable community recipes:
composer config extra.symfony.allow-contrib true
Install
composer require helios-ag/fm-elfinder-bundle
Copy elfinder assets to public folder
bin/console elfinder:install
Step 2: Enable the bundle (Optional)
Enable the bundle in the kernel (not needed with symfony flex):
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new FM\ElfinderBundle\FMElfinderBundle(), ); }
Step 3: Import FMElfinderBundle routing file
# app/config/routing.yaml elfinder: resource: "@FMElfinderBundle/Resources/config/routing.yaml"
Step 4: Configure your application's security.yaml
Secure ElFinder with access_control:
# app/config/security.yaml security: //.... access_control: - { path: ^/efconnect, role: ROLE_USER } - { path: ^/elfinder, role: ROLE_USER }
Basic configuration
Add configuration options to your config.yaml
fm_elfinder: #assets_path: / # default is /assets, this is where css/js elfinder files are instances: default: locale: '%locale%' # defaults to current request locale editor: ckeditor # other options are tinymce, tinymce4, fm_tinymce, form, simple, custom relative_path: false #default true, will produce absolute urls to specified file(s) #editor_template: custom template for your editor # default null #path_prefix: / # for setting custom assets path prefix, useful for non vhost configurations, i.e. http://127.0.0.1/mysite/ #fullscreen: true|false # default is true, applies to simple and ckeditor editors #theme: smoothness # jquery theme, default is 'smoothness' #visible_mime_types: ['image/png', 'image/jpg', 'image/jpeg'] # only show these mime types, defaults to show all connector: #debug: true|false # defaults to false roots: # at least one root must be defined, defines root filemanager directories uploads: #show_hidden: true|false # defaults to false, hides dotfiles driver: LocalFileSystem path: uploads upload_allow: ['image/png', 'image/jpg', 'image/jpeg'] upload_deny: ['all'] upload_max_size: 2M # also file upload sizes restricted in php.ini #attributes: example of setting attributes permission # - { pattern: '/(.*?)/', read: true, write: false, locked: true }
- default - instance of elfinder, can be used to define multiple configurations of ElFinder, allows simultaneous configuration for different types of WYSIWYG editors in your project
- path - define root directory for the files inside web/ directory, default is "uploads". Make sure to set proper write/read and owner permissions to this directory.
- url - url to be prefixed to image path, for displaying. Can be either
absolute
orrelative
. If absolute, you can use{homeFolder}
string as placeholder which will be replaced automatically. If relative, it will be prefixed with the applications base-url. If left blank, url will be the base-url, append with the value of the 'path' parameter - driver - can be LocalFileSystem, FTP or MySQL, Flysystem, S3 and etc, check class FM\ElfinderBundle\DependencyInjection\Configuration
- locale - locale determines, which language, ElFinder will use, to translate user interface, default is current request locale
- cors_support - allows cross domain responses handling (default false)
- editor - determines what template to render, to be compatible with WYSIWYG web editor, currently supported options are: "ckeditor" (to use with FOSCKEditorBundle or TrsteelCkeditorBundle), "fm_tinymce" for tinymce4 (to use with FMTinyMCEBundle), "form" for form type, "simple" for standalone and "custom" for custom template. How to configure CKEDitor and TinyMCE to work with this bundle, will be explained further in this document.
- editor_template - define template to render when editor is set to "custom".
- connector - root node for defining options for elfinder root directories.
- roots - define "virtual directories" that reflect directories in your project.
- path_prefix - path prefix with relative_path enabled, default is slash ('/')
- show_hidden - show files and folders that starts from . (dot)
- driver - driver type, LocalFileSystem, Dropbox, FTP
- volume_id - (optional) can be used to force a volume id when mounting volume (default auto-increments). If provided, it must be an integer bigger than 0.
- alias - directory alias
- path - directory that contains files
- upload_allow: ['image/png', 'image/jpg', 'image/jpeg']
- upload_deny: ['all']
- upload_max_size: 2M
You can see the full list of roots options here. To use them, convert camelCased option name to snake_case name.
Use multiple upload folder by instance
You can set multiple upload root folder by instance configuration.
If you have configured your instance with /uploads
path, you can provide
an additional folder as a home folder (e.g. for a multi-users application) when accessing to the instance URL :
/elfinder/{instance}/{homeFolder}
or /efconnect/{instance}/{homeFolder}
For example, accessing to /elfinder/acmeInstance/bob
URL will open up elfinder with
/uploads/bob
as root directory which only contains Bob's files.
Then, accessing to /elfinder/acmeInstance/alice
URL will re-use your instance,
but open up elfinder with /uploads/alice
folder as root directory, containing only Alice's files.
To use this feature, you must provide the instance name in the URL, and of course be sure to set proper write/read permissions on home folders.
Note: this feature is only available with LocalFileSystem
driver.
If I want more one home folder is possible ?
Yes you can with this configuration in your fm_elfinder.yaml
where_is_multi: {connector}: {index of the connector} multi_home_folder: true folder_separator: {one char other of /}
Example
fm_elfinder:
instances:
default:
locale: fr # defaults to current request locale
editor: ckeditor # other options are tinymce, tinymce4, fm_tinymce, form, simple, custom
#editor_template: custom template for your editor # default null
#path_prefix: http://localhost/ # for setting custom assets path prefix, useful for non vhost configurations, i.e. http://127.0.0.1/mysite/
fullscreen: false # default is true, applies to simple and ckeditor editors
where_is_multi:
roots: 0
multi_home_folder: true
folder_separator: "|"
#theme: smoothness # jquery theme, default is 'smoothness'
#visible_mime_types: ['image/png', 'image/jpg', 'image/jpeg'] # only show these mime types, defaults to show all
connector:
#debug: true|false # defaults to false
roots: # at least one root must be defined, defines root filemanager directories
uploads:
#show_hidden: true|false # defaults to false, hides dotfiles
driver: LocalFileSystem
path: "/var"
alias: Bibliothèque générale
upload_allow: ['all']
#upload_deny: ['all']
upload_max_size: 500M # also file upload sizes restricted in php.ini
attributes:
- {pattern: '..', read: true, write: true, locked: false}
#attributes: example of setting attributes permission
# - { pattern: '/(.*?)/', read: true, write: false, locked: true }