Laravel elFinder

https://github.com/barryvdh/laravel-elfinder
Admin
Laravel elFinder is a Laravel package that integrates the elFinder file manager with support for...
Tokens:31,679
Snippets:267
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET request: open command with init

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Example GET request to the connector endpoint with the 'open' command and 'init' parameter to include the initial tree and root listing.

```http
GET /elfinder/connector?cmd=open&target=&init=1
```

--------------------------------

### Method: start()

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Starts the underlying Laravel session store and returns the instance for chaining.

```APIDOC
## Method: start()

### Description
Starts the underlying Laravel session store and returns the instance for chaining.

### Method
start

### Signature
```php
public function start()
```

### Parameters
None.

### Returns
- **$this** (LaravelSession) - The current instance for fluent chaining.
```

--------------------------------

### Usage Examples

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

Examples for publishing config/views, overriding routes, and retrieving the command binding.

```APIDOC
## Usage Examples

### Publish the config file
```bash
php artisan vendor:publish --provider='Barryvdh\Elfinder\ElfinderServiceProvider' --tag=config
```

### Publish the views
```bash
php artisan vendor:publish --provider='Barryvdh\Elfinder\ElfinderServiceProvider' --tag=views
```

### Override the route mapping
Extend the provider and override `boot()` to customize routes:

```php
use Barryvdh\Elfinder\ElfinderServiceProvider;
use Illuminate\Routing\Router;

class CustomElfinderServiceProvider extends ElfinderServiceProvider
{
    public function boot(Router $router)
    {
        // Custom route group, e.g. require a different middleware.
        $router->group([
            'prefix'     => 'file-manager',
            'middleware' => ['web', 'can:manage-files'],
            'namespace'  => 'Barryvdh\Elfinder',
        ], function (Router $router) {
            $router->get('/', ['as' => 'elfinder.index', 'uses' => 'ElfinderController@showIndex']);
            $router->any('connector', ['as' => 'elfinder.connector', 'uses' => 'ElfinderController@showConnector']);
            // ... other routes, or none if you want a minimal surface.
        });

        // Remember to also load/publish views and define the constant
        // if your subclass bypasses the parent implementation.
    }
}
```

Register the subclass in `config/app.php` instead of the original provider.

### Retrieve the registered command binding
```php
$command = app('command.elfinder.publish'); // instance of Barryvdh\Elfinder\Console\PublishCommand
```
```

--------------------------------

### GET request: file command

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Example GET request to download a file using the 'file' command with a target hash.

```http
GET /elfinder/connector?cmd=file&target=l1_Lw_L3RtcA
```

--------------------------------

### LaravelSession start() method

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Starts the underlying session store and returns $this for fluent chaining.

```php
public function start()
{
    $this->store->start();

    return $this;
}
```

--------------------------------

### Rendered asset URL example

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

Example output of the asset() method when $dir is 'packages/barryvdh/elfinder'.

```text
https://example.com/packages/barryvdh/elfinder/js/elfinder.min.js?v=ab12cd34
```

--------------------------------

### GET request: ls command

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Example GET request to list the contents of a target directory using the 'ls' command.

```http
GET /elfinder/connector?cmd=ls&target=l1_Lw
```

--------------------------------

### Using the version string yourself

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

PHP example showing how to use AssetHelper::version() and asset() directly, including handling a leading slash in the filename.

```php
use Barryvdh\Elfinder\AssetHelper;

$v = AssetHelper::version();               // e.g. "ab12cd34"
$url = AssetHelper::asset('path/to/dir', '/js/app.min.js'); // leading slash is fine
```

--------------------------------

### Install package with Composer

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/readme.md

Run this command to require the laravel-elfinder package via Composer.

```bash
composer require barryvdh/laravel-elfinder
```

--------------------------------

### Serve the picker under your own route

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Example of defining custom routes in routes/web.php to serve the Elfinder controller under an admin middleware group.

```php
// routes/web.php
Route::middleware(['web', 'admin'])->group(function () {
    Route::get('admin/files', 'Barryvdh\Elfinder\ElfinderController@showIndex');
    Route::any('admin/files/connector', 'Barryvdh\Elfinder\ElfinderController@showConnector');
    Route::get('admin/files/popup/{input_id}', 'Barryvdh\Elfinder\ElfinderController@showPopup');
});
```

--------------------------------

### Typical JSON response for open command

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Example JSON response body returned by the connector for an 'open' command with 'init', showing the standard elFinder response structure.

```json
{
  "api": "2.1",
  "files": [],
  "cwd": {},
  "options": {},
  "uplMaxSize": "50M",
  "netDrivers": []
}
```

--------------------------------

### Executing a connector command and returning the response

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Connector.md

Example controller that creates a Connector with elFinder options, runs it, and returns the response. The session wiring is illustrative; the package resolves session.store via the container.

```php
use Barryvdh\Elfinder\Connector;
use Barryvdh\Elfinder\Session\LaravelSession;
use Illuminate\Routing\Controller;

class FileConnectorController extends Controller
{
    public function __invoke()
    {
        $opts = [
            'roots' => [
                [
                    'driver' => 'LocalFileSystem',
                    'path'   => public_path('storage'),
                    'URL'    => url('storage'),
                ],
            ],
            'session' => new LaravelSession(session()->driver()->getHandler() ? session()->driver() : app('session.store')),
        ];

        $connector = new Connector(new \elFinder($opts));
        $connector->run();

        return $connector->getResponse();
    }
}
```

--------------------------------

### Add a custom disk with extra root options

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Configuration example for config/elfinder.php to add a custom disk with an alias and a custom glideURL option. showConnector() will turn the 'public' disk into a Flysystem root.

```php
// config/elfinder.php
return [
    'dir' => ['storage'],
    'disks' => [
        'public' => [
            'alias' => 'Public uploads',
            'glideURL' => '/glide',           // custom option passed to the Flysystem driver
        ],
    ],
    // ...
];
```

--------------------------------

### Blade view usage example

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

Example of using AssetHelper in a Blade view to include CSS and JavaScript assets, with conditional locale script. Assumes $dir is set to 'packages/barryvdh/elfinder'.

```blade
<link rel="stylesheet" type="text/css" href="{{ \Barryvdh\Elfinder\AssetHelper::asset($dir, 'css/elfinder.min.css') }}">
<script src="{{ \Barryvdh\Elfinder\AssetHelper::asset($dir, 'js/elfinder.min.js') }}"></script>

@if($locale)
    <script src="{{ \Barryvdh\Elfinder\AssetHelper::asset($dir, "js/i18n/elfinder.$locale.js") }}"></script>
@endif
```

--------------------------------

### Method: get($key, $empty = null)

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Reads a value from the session store, returning a default if the key is absent.

```APIDOC
## Method: get($key, $empty = null)

### Description
Reads a value from the session store, returning a default if the key is absent.

### Method
get

### Signature
```php
public function get($key, $empty = null)
```

### Parameters
- **$key** (string) - Required - Session key to read
- **$empty** (mixed) - Optional - Default value returned when the key is absent (default: null)

### Returns
- **mixed** - The stored value, or `$empty`.
```

--------------------------------

### POST request: open command with form data

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Example POST request to the connector endpoint with form-encoded data for the 'open' command, including a CSRF token.

```http
POST /elfinder/connector
Content-Type: application/x-www-form-urlencoded

cmd=open&target=l1_Lw&_token=...
```

--------------------------------

### GET /elfinder

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Renders the full-size standalone file manager interface. This is the main entry point for the elFinder UI.

```APIDOC
## GET /elfinder

### Description
Renders the full-size standalone file manager interface.

### Method
GET

### Endpoint
/elfinder

### Response
#### Success Response (200)
Returns an HTML page with the elFinder interface.

#### Response Example
(HTML content of the elFinder view)

```

--------------------------------

### Root configuration with accessControl in ElfinderController::showConnector()

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Elfinder.md

Example of a root array where 'accessControl' is set to the checkAccess method, ensuring dot-files are hidden and write-protected.

```php
$roots[] = [
    'driver'        => 'LocalFileSystem',
    'path'          => public_path('storage'),
    'URL'           => url('storage'),
    'accessControl' => 'Barryvdh\Elfinder\Elfinder::checkAccess',
];
```

--------------------------------

### LaravelSession get() method

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Retrieves a value from the session store, returning a default if the key is absent.

```php
public function get($key, $empty = null)
{
    return $this->store->get($key, $empty);
}
```

--------------------------------

### GET /elfinder/filepicker/{input_id}

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Renders a compact file picker that can filter by MIME type. The selected file is passed to the parent window.

```APIDOC
## GET /elfinder/filepicker/{input_id}

### Description
Renders a compact file picker that can filter by MIME type.

### Method
GET

### Endpoint
/elfinder/filepicker/{input_id}

### Parameters
#### Path Parameters
- **input_id** (string) - Required - The id of the target input.

#### Query Parameters
- **type** (string) - Optional - Comma-separated MIME filter, e.g. `image`.

### Response
#### Success Response (200)
Returns an HTML page for the file picker.

#### Response Example
(HTML content of the file picker view)

```

--------------------------------

### Include Colorbox stylesheet

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/readme.md

Include the Colorbox CSS file in the head section of your page. The example uses the example1 styles, but any Colorbox style will work.

```html
<link href="/assets/css/colorbox.css" rel="stylesheet">
```

--------------------------------

### GET /elfinder/tinymce5

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Renders a popup browser for TinyMCE 5.x integration. Posts a message to the parent window with the selected file.

```APIDOC
## GET /elfinder/tinymce5

### Description
Renders a popup browser for TinyMCE 5.x integration.

### Method
GET

### Endpoint
/elfinder/tinymce5

### Response
#### Success Response (200)
Returns an HTML page for the TinyMCE 5.x popup.

#### Response Example
(HTML content of the TinyMCE 5 popup view)

```

--------------------------------

### Invoking checkAccess() directly

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Elfinder.md

Direct invocation example showing return values: false for a dot-file with read attribute, null for a normal file.

```php
use Barryvdh\Elfinder\Elfinder;

$readable = Elfinder::checkAccess('read', '/var/www/public/storage/.hidden.txt', null, null); // false
$visible  = Elfinder::checkAccess('read', '/var/www/public/storage/readme.txt', null, null);  // null (defer)
```

--------------------------------

### Example error response body

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/errors.md

Shows the JSON body returned for command-level errors, e.g., unknown command. The HTTP status is 200.

```json
{"error": ["errUnknownCmd"]}
```

--------------------------------

### GET /elfinder/tinymce4

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Renders a popup browser for TinyMCE 4.x integration. Uses the file_browser_callback or windowManager.open API.

```APIDOC
## GET /elfinder/tinymce4

### Description
Renders a popup browser for TinyMCE 4.x integration.

### Method
GET

### Endpoint
/elfinder/tinymce4

### Response
#### Success Response (200)
Returns an HTML page for the TinyMCE 4.x popup.

#### Response Example
(HTML content of the TinyMCE 4 popup view)

```

--------------------------------

### GET /elfinder/tinymce

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Renders a popup browser for TinyMCE 3.x integration. Uses the tinyMCEPopup API to select files.

```APIDOC
## GET /elfinder/tinymce

### Description
Renders a popup browser for TinyMCE 3.x integration.

### Method
GET

### Endpoint
/elfinder/tinymce

### Response
#### Success Response (200)
Returns an HTML page for the TinyMCE 3.x popup.

#### Response Example
(HTML content of the TinyMCE popup view)

```

--------------------------------

### Overriding a view and keeping versioning

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

Blade example for overriding a view while using AssetHelper to keep versioning.

```blade
{{-- resources/views/vendor/elfinder/elfinder.blade.php --}}
<script src="{{ \Barryvdh\Elfinder\AssetHelper::asset('packages/barryvdh/elfinder', 'js/elfinder.min.js') }}"></script>
```

--------------------------------

### Override route mapping by extending the provider

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

Example of extending ElfinderServiceProvider and overriding the boot() method to customize the route group, such as changing the prefix and middleware. Remember to also load/publish views and define the constant if bypassing the parent implementation.

```php
use Barryvdh\Elfinder\ElfinderServiceProvider;
use Illuminate\Routing\Router;

class CustomElfinderServiceProvider extends ElfinderServiceProvider
{
    public function boot(Router $router)
    {
        // Custom route group, e.g. require a different middleware.
        $router->group([
            'prefix'     => 'file-manager',
            'middleware' => ['web', 'can:manage-files'],
            'namespace'  => 'Barryvdh\Elfinder',
        ], function (Router $router) {
            $router->get('/', ['as' => 'elfinder.index', 'uses' => 'ElfinderController@showIndex']);
            $router->any('connector', ['as' => 'elfinder.connector', 'uses' => 'ElfinderController@showConnector']);
            // ... other routes, or none if you want a minimal surface.
        });

        // Remember to also load/publish views and define the constant
        // if your subclass bypasses the parent implementation.
    }
}
```

--------------------------------

### getElfinderPath() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Returns the resolved parent directory of the installed elFinder class file, i.e., the studio-42/elfinder vendor package root.

```php
protected function getElfinderPath()
```

--------------------------------

### GET /elfinder/popup/{input_id}

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Renders a standalone popup file manager that fills a specified HTML input element. Intended to be opened in a colorbox iframe.

```APIDOC
## GET /elfinder/popup/{input_id}

### Description
Renders a standalone popup file manager that fills a specified HTML input element.

### Method
GET

### Endpoint
/elfinder/popup/{input_id}

### Parameters
#### Path Parameters
- **input_id** (string) - Required - The id of the HTML input element the popup fills.

### Response
#### Success Response (200)
Returns an HTML page for the standalone popup.

#### Response Example
(HTML content of the standalone popup view)

```

--------------------------------

### Elfinder::checkAccess() denies read/write on dot-files

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/errors.md

Returns false for read/write on basenames starting with '.', true for other attrs on dot-files, and null otherwise. Used to enforce access-control denial reported as errPerm.

```php
public static function checkAccess($attr, $path, $data, $volume) {
    return strpos(basename($path), '.') === 0
        ? !($attr == 'read' || $attr == 'write')
        : null;
}
```

--------------------------------

### LaravelSession implements elFinderSessionInterface

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/types.md

The LaravelSession class implements the upstream elFinderSessionInterface. It provides methods for session management: start, close, get, set, and remove. The constructor accepts a Session store. This class is accepted by the 'session' key of the elFinder constructor options array.

```php
class LaravelSession implements elFinderSessionInterface
{
    public function __construct(protected Session $store) {}

    public function start() {}  // returns $this
    public function close() {}  // returns $this
    public function get($key, $empty = null) {}  // returns mixed
    public function set($key, $data) {}  // returns $this
    public function remove($key) {}  // returns $this
}
```

--------------------------------

### Direct instantiation of PublishCommand

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Shows how to instantiate and run the command directly in a test or custom command, using Laravel's Filesystem and console input/output.

```php
use Barryvdh\Elfinder\Console\PublishCommand;
use Illuminate\Filesystem\Filesystem;

$command = new PublishCommand(new Filesystem(), public_path());
$command->setLaravel(app());
$command->run(new \Symfony\Component\Console\Input\ArrayInput([]), new \Symfony\Component\Console\Output\BufferedOutput());
```

--------------------------------

### boot() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

The boot() method signature as defined in the ElfinderServiceProvider. It accepts an injected Router instance and returns void.

```php
public function boot(Router $router)
```

--------------------------------

### showConnector()

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

This method is the main entry point for the elFinder connector. It constructs the elFinder instance with configured roots and options, runs the connector, and returns the HTTP response.

```APIDOC
## showConnector()

### Description
This method is the heart of the package. It builds the elFinder roots from configuration, optionally wraps the session, merges options, and returns the connector response.

### Method
GET (or POST, as handled by the connector)

### Endpoint
Typically routed to `/elfinder/connector` (see endpoints.md)

### Parameters
No direct parameters. Configuration is read from the application config.

### Request Example
(No explicit request body; the connector handles requests per elFinder protocol)

### Response
#### Success Response (200)
Returns `Symfony\Component\HttpFoundation\Response` — the connector response produced by the Connector.

#### Response Example
(Response content depends on the connector operation; not specified in source)

### Behavior
1. Reads `elfinder.roots` from config. If non-empty, uses them verbatim.
2. If empty, builds roots automatically:
   - For each directory in `elfinder.dir` (default `['storage']`), creates a `LocalFileSystem` root with:
     - `driver` = `LocalFileSystem`
     - `path` = `$this->app->publicPath($dir)`
     - `URL` = `UrlGenerator::to($dir)`
     - `accessControl` = `elfinder.access` value
   - For each disk in `elfinder.disks`, resolves the Flysystem disk. If it's an `Illuminate\Filesystem\FilesystemAdapter`, creates a root with:
     - `driver` = `Flysystem`
     - `filesystem` = `$disk->getDriver()`
     - `alias` = the disk key
     - `accessControl` = `elfinder.access` value
     - If no `URL` key, adds a `URLCallback` closure: `fn ($path) => $disk->url($path)`
3. If `session.store` is bound, wraps it in `new LaravelSession($this->app->make('session.store'))`; otherwise `$session = null`.
4. Merges `elfinder.root_options` into every root (root wins on conflicts).
5. Merges `elfinder.options` with `['roots' => $roots, 'session' => $session]` (options + roots/session; literal keys win).
6. Runs `new Connector(new \elFinder($opts))`, calls `->run()`, and returns `$connector->getResponse()`.
```

--------------------------------

### boot(Router $router)

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

Registers the elfinder view namespace, defines the ELFINDER_IMG_PARENT_URL constant, and registers the route group for the elfinder package.

```APIDOC
## boot(Router $router)

### Description
Registers the elfinder view namespace, defines the ELFINDER_IMG_PARENT_URL constant, and registers the route group for the elfinder package.

### Method
boot

### Signature
```php
public function boot(Router $router)
```

### Parameters
- **$router** (Illuminate\Routing\Router) - Required - Injected router used to register the route group.

### Returns
void

### Behavior
1. Loads views from `__DIR__.'/../resources/views'` under the `elfinder::` namespace and publishes them under the `views` tag.
2. Defines the constant `ELFINDER_IMG_PARENT_URL` (if not already defined) as `$this->app['url']->asset('packages/barryvdh/elfinder')`.
3. Reads the route group config `elfinder.route` (default `['prefix' => 'elfinder', 'middleware' => ['web', 'auth']]`), forces `namespace` = `Barryvdh\Elfinder`, and registers the eight routes via `$router->group(...)`.
```

--------------------------------

### provides()

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

Returns the list of bindings provided by this service provider.

```APIDOC
## provides()

### Description
Returns the list of bindings provided by this service provider.

### Method
provides

### Signature
```php
public function provides()
```

### Parameters
None

### Returns
array - `array('command.elfinder.publish')`
```

--------------------------------

### Flysystem root defaults and merge

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/types.md

Defines default root options for Flysystem disks, then merges with user-provided root. If no 'URL' is set, a 'URLCallback' is added to generate URLs via the disk's url method.

```php
$defaults = [
    'driver'        => 'Flysystem',
    'filesystem'    => $disk->getDriver(),
    'alias'         => $key,
    'accessControl' => $this->app->config->get('elfinder.access') // filter callback (OPTIONAL)
];
$root = array_merge($defaults, $root);
if (!isset($root['URL'])) {
    $root['URLCallback'] = function($path) use ($disk) {
        return $disk->url($path);
    };
}
```

--------------------------------

### version(): string

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

Computes and memoizes a version hash based on the versions and references of the studio-42/elfinder and barryvdh/laravel-elfinder packages. Returns the first 8 characters of the SHA1 hash of the joined package metadata.

```APIDOC
## version(): string

### Description
Computes and memoizes a version hash based on the versions and references of the studio-42/elfinder and barryvdh/laravel-elfinder packages. Returns the first 8 characters of the SHA1 hash of the joined package metadata.

### Method
version

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
- **none** - No parameters.

### Request Example
```php
\Barryvdh\Elfinder\AssetHelper::version()
```

### Response
#### Success Response (200)
- **string** - First 8 characters of the SHA1 hash of the joined package versions and references.

#### Response Example
```
ab12cd34
```
```

--------------------------------

### GET /elfinder/ckeditor

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/endpoints.md

Renders a popup browser for CKEditor 4.x integration. Uses the CKEditorFuncNum query parameter to call back into the editor.

```APIDOC
## GET /elfinder/ckeditor

### Description
Renders a popup browser for CKEditor 4.x integration.

### Method
GET

### Endpoint
/elfinder/ckeditor

### Parameters
#### Query Parameters
- **CKEditorFuncNum** (string) - Required - The function number used by CKEditor to call back with the selected file URL.

### Response
#### Success Response (200)
Returns an HTML page for the CKEditor popup.

#### Response Example
(HTML content of the CKEditor popup view)

```

--------------------------------

### LocalFileSystem root array

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/types.md

Builds the root array for LocalFileSystem driver with required 'driver', 'path', 'URL' and optional 'accessControl' fields. The 'accessControl' defaults to the 'elfinder.access' config value.

```php
$roots[] = [
    'driver'        => 'LocalFileSystem', // driver for accessing file system (REQUIRED)
    'path'          => $this->app->publicPath($dir), // path to files (REQUIRED)
    'URL'           => $this->app->make(UrlGenerator::class)->to($dir), // URL to files (REQUIRED)
    'accessControl' => $this->app->config->get('elfinder.access') // filter callback (OPTIONAL)
];
```

--------------------------------

### PublishCommand constructor signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Constructor signature for PublishCommand, accepting a filesystem helper and the public path.

```php
public function __construct($files, $publishPath)
```

--------------------------------

### Detect publish command failures via output buffer

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/errors.md

Shows that $command->run() returns 0 even on failure; use output()->fetch() to check for error lines. The command never throws and returns null on all paths.

```php
$exitCode = $command->run($input, $output); // 0 even when assets were not published

// --- instead, detect via the output buffer: ---
(output()->fetch()) // contains the error lines when a step failed
```

--------------------------------

### register() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

The register() method is defined without parameters and returns void. It merges the package config, publishes the config file, registers a singleton command, and registers the artisan command.

```php
public function register()
```

--------------------------------

### Register command.elfinder.publish singleton

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Registers the PublishCommand as a singleton in the service provider, using the application's public path.

```php
$this->app->singleton('command.elfinder.publish', function ($app) {
    $publicPath = $app['path.public'];
    return new Console\PublishCommand($app['files'], $publicPath);
});
```

--------------------------------

### version() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

The exact signature of the version() method, which returns the version hash.

```php
public static function version(): string
```

--------------------------------

### Build elFinder constructor options array

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/types.md

Merges the configured elFinder options with the roots and session. The `roots` key is required and contains the root items built above (or from `elfinder.roots` when configured). The `session` key is optional and set to `null` when `session.store` is not bound. Other elFinder options are merged from the `elfinder.options` config.

```php
$opts = $this->app->config->get('elfinder.options', array());
$opts = array_merge($opts, ['roots' => $roots, 'session' => $session]);
```

--------------------------------

### new Connector(\elFinder $elFinder)

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Connector.md

Constructor inherited from \elFinderConnector. Stores the elFinder instance for later use by the connector.

```APIDOC
## Constructor: new Connector(\elFinder $elFinder)

### Description
Creates a new Connector instance, inheriting the upstream constructor that stores the elFinder instance.

### Parameters
- **$elFinder** (\elFinder) - Required - Fully configured elFinder instance (created with the options array built by `ElfinderController::showConnector()`).

### Returns
No return value (constructor).
```

--------------------------------

### Generate URLs to the provided routes

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Shows how to generate URLs for the elfinder.connector, elfinder.tinymce5, and elfinder.popup routes using the route() helper.

```php
use Illuminate\Support\Facades\Route;

$url = route('elfinder.connector');     // e.g. http://localhost/elfinder/connector
$tiny = route('elfinder.tinymce5');     // e.g. http://localhost/elfinder/tinymce5
$popup = route('elfinder.popup', ['input_id' => 'feature_image']);
```

--------------------------------

### Create Glide server route

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/readme.md

Defines a route that creates a Glide server for the 'public' disk, using a cache path. The route handles image requests and returns the image response.

```php
Route::get('glide/{path}', function($path){
    $server = \League\Glide\ServerFactory::create([
        'source' => app('filesystem')->disk('public')->getDriver(),
        'cache' => storage_path('glide'),
    ]);
    return $server->getImageResponse($path, Input::query());
})->where('path', '.+');
```

--------------------------------

### Method: set($key, $data)

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Writes a value to the session store and returns the instance for chaining.

```APIDOC
## Method: set($key, $data)

### Description
Writes a value to the session store and returns the instance for chaining.

### Method
set

### Signature
```php
public function set($key, $data)
```

### Parameters
- **$key** (string) - Required - Session key to write
- **$data** (mixed) - Required - Value to store

### Returns
- **$this** (LaravelSession) - The current instance for fluent chaining.
```

--------------------------------

### Multiple local directories plus disks configuration

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/configuration.md

Configuration for elFinder with multiple local directories and additional disks. Sets 'dir' to an array of local paths, defines a custom disk 's3-files' with alias and URL, and configures the route prefix and middleware.

```php
// config/elfinder.php
return [
    'dir'   => ['storage', 'uploads'],
    'disks' => [
        'local',
        's3-files' => [
            'alias' => 'Amazon S3',
            'URL'   => 'https://cdn.example.test',
        ],
    ],
    'route' => [
        'prefix'     => 'file-manager',
        'middleware' => ['web', 'auth'],
    ],
];
```

--------------------------------

### Using LaravelSession manually

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Shows how to create a LaravelSession instance and use its methods to persist, read, close, and remove session data.

```php
use Barryvdh\Elfinder\Session\LaravelSession;

$session = new LaravelSession(app('session.store'));

$session->set('elfinder.lastDir', '/storage');   // persist a value elFinder will read back
$dir = $session->get('elfinder.lastDir', '/');    // default '/'
$session->close();                                 // save the store
$session->remove('elfinder.lastDir');
```

--------------------------------

### Elfinder::checkAccess()

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Elfinder.md

Static method that determines access permissions for files and directories based on the attribute being tested and whether the basename starts with a dot. Returns false for read/write on dot-files, true for locked/hidden on dot-files, and null otherwise to defer to elFinder.

```APIDOC
## Elfinder::checkAccess()

### Description
Determines access permissions for a file or directory based on the attribute being tested and whether the basename starts with a dot. Dot-files are denied read and write access, but are marked as locked and hidden. For other paths, returns null to let elFinder decide.

### Method
Static method

### Signature
```php
public static function checkAccess($attr, $path, $data, $volume)
```

### Parameters
- **$attr** (string) - Required - The attribute elFinder is testing; one of `read`, `write`, `locked`, `hidden`.
- **$path** (string) - Required - Absolute filesystem path of the file or directory being checked.
- **$data** (mixed) - Required - Additional data passed by elFinder (unused).
- **$volume** (mixed) - Required - The elFinder volume instance (unused).

### Return Value
- **bool|null** - Returns `false` if the basename starts with `.` and the attribute is `read` or `write`; returns `true` if the basename starts with `.` and the attribute is `locked` or `hidden`; returns `null` for all other paths.

### Usage Example
```php
use Barryvdh\Elfinder\Elfinder;

$readable = Elfinder::checkAccess('read', '/var/www/public/storage/.hidden.txt', null, null); // false
$visible  = Elfinder::checkAccess('read', '/var/www/public/storage/readme.txt', null, null);  // null (defer)
```

### Notes
- The method accepts any values for `$data` and `$volume`; they are declared but never used.
- Behavior is derived solely from `$attr` and `basename($path)`.
- There are no other members (properties, constants, or methods) in this class.
```

--------------------------------

### Catch HTTP 200 command error with error array

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/errors.md

Use for command-level failures that return HTTP 200 with an error array. The error may be a string, array, or object with cnv/errs sub-keys. The example throws a RuntimeException with the error messages joined.

```php
$response = $connector->getResponse();
$payload = json_decode($response->getContent(), true);

if (isset($payload['error'])) {
    // $payload['error'] is the elFinder error; the HTTP status is still 200.
    throw new \RuntimeException(implode(', ', (array) $payload['error']));
}
```

--------------------------------

### provides() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

The provides() method signature as defined in the ElfinderServiceProvider. It returns an array of bindings provided by this provider.

```php
public function provides()
```

--------------------------------

### Configure elFinder disks

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/readme.md

Add local or custom disks to elFinder via the 'disks' config. Provide extra options like URL and alias. If no URL is given, it is generated from the disk.

```php
'disks' => [
    'local',
    'my-disk' => [
        'URL' => url('to/disk'),
        'alias' => 'Local storage',
    ]
],
```

--------------------------------

### PublishCommand class definition

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Defines the artisan command 'elfinder:publish' with its name, description, and properties for the filesystem and publish path.

```php
class PublishCommand extends Command {

    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'elfinder:publish';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Publish the elFinder assets';

    /** @var Filesystem $fs */
    protected $files;

    protected $publishPath;
```

--------------------------------

### Constructor: __construct(Session $store)

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Creates a new LaravelSession instance with the provided Laravel session store.

```APIDOC
## Constructor: __construct(Session $store)

### Description
Creates a new LaravelSession instance with the provided Laravel session store.

### Method
Constructor

### Signature
```php
public function __construct(protected Session $store)
```

### Parameters
- **$store** (Illuminate\Contracts\Session\Session) - Required - The Laravel session store (e.g. the `session.store` container binding)

### Returns
No return value (constructor).
```

--------------------------------

### asset(string $dir, string $filename): string

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

Builds a versioned asset URL by combining the directory and filename, stripping leading slashes from the filename, and appending a version query parameter. Returns an absolute URL using Laravel's URL facade.

```APIDOC
## asset(string $dir, string $filename): string

### Description
Builds a versioned asset URL by combining the directory and filename, stripping leading slashes from the filename, and appending a version query parameter. Returns an absolute URL using Laravel's URL facade.

### Method
asset

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
- **$dir** (string) - Required - Publish directory relative to the public path, e.g. `packages/barryvdh/elfinder`
- **$filename** (string) - Required - Asset filename relative to `$dir`; a leading `/` is stripped with `ltrim($filename, '/')`

### Request Example
```php
\Barryvdh\Elfinder\AssetHelper::asset('packages/barryvdh/elfinder', 'js/elfinder.min.js')
```

### Response
#### Success Response (200)
- **string** - Absolute asset URL with a `v` query string equal to the current version hash.

#### Response Example
```
https://example.com/packages/barryvdh/elfinder/js/elfinder.min.js?v=ab12cd34
```
```

--------------------------------

### Shipped config array from config/elfinder.php

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/types.md

Returns the default configuration array for the elFinder package. The `dir` key is set to `['storage']`, `disks` is empty, `route` uses a prefix of `elfinder` with `web` and `auth` middleware, `access` points to the `checkAccess` method, and `roots`, `options`, and `root_options` are initialized to null or empty arrays.

```php
return array(
    'dir'          => ['storage'],
    'disks'        => [],
    'route'        => ['prefix' => 'elfinder', 'middleware' => ['web', 'auth']],
    'access'       => 'Barryvdh\Elfinder\Elfinder::checkAccess',
    'roots'        => null,
    'options'      => array(),
    'root_options' => array(),
);
```

--------------------------------

### showTinyMCE5 method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Returns the elfinder::tinymce5 view for TinyMCE 5.x. The client posts a fileSelected message to window.parent via postMessage.

```php
public function showTinyMCE5()
```

--------------------------------

### asset() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/AssetHelper.md

The exact signature of the asset() method, which builds a versioned asset URL.

```php
public static function asset(string $dir, string $filename): string
```

--------------------------------

### showPopup($input_id)

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Renders the elfinder::standalonepopup view for a standalone popup. The popup writes the selected file path into the HTML input with the given ID.

```APIDOC
## showPopup($input_id)

### Description
Returns the `elfinder::standalonepopup` view with the standard variables plus `input_id`. Used with the published `standalonepopup.min.js` and a colorbox (`/elfinder/popup/{input_id}`).

### Method
GET

### Endpoint
`/elfinder/popup/{input_id}`

### Parameters
#### Path Parameters
- **input_id** (string) - Required - The id of the HTML input the popup writes the selected file path into.

### Response
#### Success Response (200)
- **view** (Illuminate\View\View) - The `elfinder::standalonepopup` view.

#### Response Example
Not provided in source.
```

--------------------------------

### getPath() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Returns the absolute path to the package's resources/assets folder. Used internally to locate asset files for publishing.

```php
protected function getPath(){
    return __DIR__ .'/../../resources/assets';
}
```

--------------------------------

### Publish the config file

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

Command to publish the Elfinder config file using the vendor:publish Artisan command with the provider and tag specified.

```bash
php artisan vendor:publish --provider='Barryvdh\Elfinder\ElfinderServiceProvider' --tag=config
```

--------------------------------

### showFilePicker method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Returns the elfinder::filepicker view with standard variables plus input_id, type, and mimeTypes. Reads the type query parameter via Request::input('type') and computes mimeTypes as a comma-separated list of single-quoted values.

```php
public function showFilePicker($input_id)
```

--------------------------------

### Replacing with a closure for custom rules

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Elfinder.md

Shows how to replace the default access filter with a closure that denies write access to the whole volume while keeping read access.

```php
// config/elfinder.php
'access' => function ($attr, $path, $data, $volume) {
    // Deny write access to the whole volume, keep read access.
    if ($attr === 'write') {
        return false;
    }
    // Let the default behavior apply otherwise.
    return null;
},
```

--------------------------------

### showTinyMCE5()

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Renders the elfinder::tinymce5 view for TinyMCE 5.x integration. The client posts a fileSelected message to window.parent via postMessage.

```APIDOC
## showTinyMCE5()

### Description
Returns the `elfinder::tinymce5` view for TinyMCE 5.x integration. The client posts a `fileSelected` message to `window.parent` via `postMessage`.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
None.

### Response
#### Success Response (200)
- **view** (Illuminate\View\View) - The `elfinder::tinymce5` view.

#### Response Example
Not provided in source.
```

--------------------------------

### Publish the views

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

Command to publish the Elfinder views using the vendor:publish Artisan command with the provider and tag specified.

```bash
php artisan vendor:publish --provider='Barryvdh\Elfinder\ElfinderServiceProvider' --tag=views
```

--------------------------------

### showPopup method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Returns the elfinder::standalonepopup view with the standard variables plus input_id. Used with the published standalonepopup.min.js and a colorbox at /elfinder/popup/{input_id}.

```php
public function showPopup($input_id)
```

--------------------------------

### getViewVars() method signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Protected method that returns an array with keys 'dir', 'locale', and 'csrf'. 'dir' is 'packages/barryvdh/elfinder', 'locale' is app.locale with '-' replaced by '_' (false if the corresponding i18n file does not exist), and 'csrf' is always true.

```php
protected function getViewVars()
```

--------------------------------

### Full custom roots, per-root access and connector options

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/configuration.md

Configuration for elFinder with custom roots, per-root access control, and connector options. Includes a root with LocalFileSystem driver, accessControl callback, upload restrictions, and global options for root_options and options.

```php
return [
    'roots' => [
        [
            'driver'        => 'LocalFileSystem',
            'path'          => public_path('files'),
            'URL'           => url('files'),
            'accessControl'  => function ($attr, $path, $data, $volume) {
                return $attr === 'write' ? false : null;
            },
            'uploadDeny'    => ['exe', 'sh'],
            'uploadAllow'   => ['image'],
            'uploadOrder'   => ['deny', 'allow'],
        ],
    ],
    'access'       => null, // not used when roots are explicit (per-root accessControl applies)
    'root_options' => [
        'checkSubfolders' => false,
        'tmbSize'        => 64,
    ],
    'options' => [
        'bind' => [
            'upload.pre' => 'Some\Handler::onUpload',
        ],
    ],
];
```

--------------------------------

### getResponse() method implementation

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Connector.md

Returns the response stored by the last output() call. Returns null if output() has not been called.

```php
public function getResponse(){
    return $this->response;
}
```

--------------------------------

### Invoke elfinder:publish command

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Runs the artisan command to publish the elFinder assets.

```bash
php artisan elfinder:publish
```

--------------------------------

### Wiring LaravelSession as elFinder session option

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Shows how ElfinderController::showConnector() creates a LaravelSession from the session.store binding and passes it to elFinder.

```php
if ($this->app->bound('session.store')) {
    $sessionStore = $this->app->make('session.store');
    $session = new LaravelSession($sessionStore);
} else {
    $session = null;
}

$opts = array_merge(config('elfinder.options'), ['roots' => $roots, 'session' => $session]);
$connector = new Connector(new \elFinder($opts));
$connector->run();
return $connector->getResponse();
```

--------------------------------

### Composer post-update-cmd script

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/PublishCommand.md

Automatically runs the publish command after composer updates by adding it to the post-update-cmd scripts in composer.json.

```json
{
    "scripts": {
        "post-update-cmd": [
            "php artisan elfinder:publish"
        ]
    }
}
```

--------------------------------

### showFilePicker($input_id)

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderController.md

Renders the elfinder::filepicker view for a file picker. Accepts an optional type query parameter to filter MIME types.

```APIDOC
## showFilePicker($input_id)

### Description
Returns the `elfinder::filepicker` view with the standard variables plus `input_id`, `type`, and `mimeTypes`. The `type` query parameter is used to filter MIME types via elFinder's `onlyMimes` client option.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
#### Path Parameters
- **input_id** (string) - Required - Target input id.

#### Query Parameters
- **type** (string) - Optional - Comma-separated MIME filter, e.g. `image`.

### Response
#### Success Response (200)
- **view** (Illuminate\View\View) - The `elfinder::filepicker` view.

#### Response Example
Not provided in source.
```

--------------------------------

### Retrieve the registered command binding

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/ElfinderServiceProvider.md

Retrieves the registered command binding for the Elfinder publish command using the app() helper.

```php
$command = app('command.elfinder.publish'); // instance of Barryvdh\Elfinder\Console\PublishCommand
```

--------------------------------

### Chaining LaravelSession methods

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Demonstrates fluent chaining of set() and close() methods, which return $this.

```php
(new LaravelSession(app('session.store')))->set('a', 1)->set('b', 2)->close();
```

--------------------------------

### LaravelSession constructor signature

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/LaravelSession.md

Exact constructor signature with a promoted protected property $store.

```php
public function __construct(protected Session $store)
```

--------------------------------

### Create input field for file selection

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/readme.md

Create an input field with a unique ID that will be populated with the selected file path. The ID is used by the popup selector to update the value.

```html
<label for="feature_image">Feature Image</label>
<input type="text" id="feature_image" name="feature_image" value="">
```

--------------------------------

### Composer auto-discovery configuration

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/index.md

JSON configuration in composer.json that enables Laravel's package auto-discovery for the ElfinderServiceProvider.

```json
"extra": {
    "laravel": {
        "providers": ["Barryvdh\\Elfinder\\ElfinderServiceProvider"]
    }
}
```

--------------------------------

### checkAccess() method implementation

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/api-reference/Elfinder.md

Full implementation of checkAccess(). Returns false for dot-files when attribute is read or write, true for locked/hidden, and null otherwise to defer to elFinder.

```php
public static function checkAccess($attr, $path, $data, $volume) {
    return strpos(basename($path), '.') === 0       // if file/folder begins with '.' (dot)
        ? !($attr == 'read' || $attr == 'write')    // set read+write to false, other (locked+hidden) set to true
        :  null;                                    // else elFinder decide it itself
}
```

--------------------------------

### Manual provider registration in config/app.php

Source: https://github.com/barryvdh/laravel-elfinder/blob/master/_autodocs/index.md

PHP array for manually registering the ElfinderServiceProvider in Laravel's config/app.php when auto-discovery is disabled.

```php
// config/app.php
'providers' => [
    Barryvdh\Elfinder\ElfinderServiceProvider::class,
],
```
Tokens:
Raw