Livewire Filemanager

https://github.com/livewire-filemanager/filemanager
Admin
A simple, friendly, and practical Livewire-powered file manager for Laravel applications, offering...
Tokens:72,608
Snippets:603
Trust Score:5.6
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### List Folders Response

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Example JSON response for listing folders.

```json
{
    "data": [
        {
            "id": 1,
            "name": "Documents",
            "parent_id": null,
            "created_at": "2024-01-01T00:00:00Z",
            "updated_at": "2024-01-01T00:00:00Z"
        }
    ]
}
```

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

### Install via Composer

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Install the package using Composer.

```bash
composer require livewire-filemanager/filemanager
```

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

### Error Response Example

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Example JSON error response for validation failures.

```json
{
    "message": "Validation error",
    "errors": {
        "name": ["The name field is required."]
    }
}
```

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

### List Folders Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

GET request to list all folders.

```http
GET /folders
```

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

### GET /files

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Retrieves a list of files. Supports filtering by folder, searching by name, and pagination.

```APIDOC
## GET /files

### Description
Retrieves a list of files.

### Method
GET

### Endpoint
/files

### Parameters
#### Query Parameters
- **folder_id** (integer) - Optional - Filter files by folder
- **search** (string) - Optional - Search files by name
- **page** (integer) - Optional - Page number for pagination
- **per_page** (integer) - Optional - Items per page (default: 20)
```

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

### Publish views

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Run this Artisan command to publish the package views for customization.

```bash
php artisan vendor:publish --tag=livewire-filemanager-views
```

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

### List Files Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

GET request to list files with optional query parameters: folder_id, search, page, per_page (default 20).

```http
GET /files
```

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

### POST /folders

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Creates a new folder. Requires a name and optionally a parent_id to nest the folder.

```APIDOC
## POST /folders

### Description
Creates a new folder.

### Method
POST

### Endpoint
/folders

### Parameters
#### Request Body
- **name** (string) - Required - Folder name
- **parent_id** (integer) - Optional - Parent folder ID

### Request Example
```json
{
    "name": "New Folder",
    "parent_id": 1
}
```
```

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

### Base URL

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Base URL for all API endpoints.

```http
https://your-domain.com/api/filemanager/v1
```

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

### GET /folders

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Retrieves a list of all folders. Returns an array of folder objects with id, name, parent_id, and timestamps.

```APIDOC
## GET /folders

### Description
Retrieves a list of all folders.

### Method
GET

### Endpoint
/folders

### Response
#### Success Response (200)
- **data** (array) - List of folder objects
  - **id** (integer) - Folder ID
  - **name** (string) - Folder name
  - **parent_id** (integer|null) - Parent folder ID
  - **created_at** (string) - Creation timestamp
  - **updated_at** (string) - Last update timestamp

#### Response Example
```json
{
    "data": [
        {
            "id": 1,
            "name": "Documents",
            "parent_id": null,
            "created_at": "2024-01-01T00:00:00Z",
            "updated_at": "2024-01-01T00:00:00Z"
        }
    ]
}
```
```

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

### New publishing tags

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

New vendor:publish commands using the livewire-filemanager tags. Use these when re-publishing assets.

```bash
php artisan vendor:publish --tag=livewire-filemanager-config
php artisan vendor:publish --tag=livewire-filemanager-views
php artisan vendor:publish --tag=livewire-filemanager-migrations
```

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

### POST /files/bulk

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Uploads multiple files at once. Files are sent as an array under the key 'files[]'.

```APIDOC
## POST /files/bulk

### Description
Uploads multiple files in a single request.

### Method
POST

### Endpoint
/files/bulk

### Parameters
#### Request Body (multipart/form-data)
- **files[]** (binary) - Required - Array of files to upload
- **folder_id** (integer) - Optional - Folder ID to place the files in

### Request Example
```
{
    "files[]": <binary>,
    "folder_id": 1
}
```
```

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

### Run test suite

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Command to run the test suite after upgrading. Verify configuration, views, translations, API, and ACL as listed in the testing section.

```bash
composer test
```

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

### Old publishing tags

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Old vendor:publish commands using the livewire-fileuploader tags. Replace these with the new tags.

```bash
php artisan vendor:publish --tag=livewire-fileuploader-config
php artisan vendor:publish --tag=livewire-fileuploader-views
php artisan vendor:publish --tag=livewire-fileuploader-migrations
```

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

### Create Folder Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

POST request to create a new folder with name and optional parent_id.

```http
POST /folders
Content-Type: application/json

{
    "name": "New Folder",
    "parent_id": 1
}
```

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

### Publish Spatie medialibrary config

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Publishes the Spatie medialibrary configuration file if not already done. Required for ACL setup.

```bash
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-config"
```

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

### Start queue worker for thumbnail generation

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Runs the Laravel queue worker to process queued jobs, such as thumbnail generation. Ensure this is running if thumbnails are not appearing.

```bash
php artisan queue:work
```

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

### buildFolderPath usage example

Source: https://github.com/livewire-filemanager/filemanager

Shows how to call buildFolderPath with a folder ID, returning a path like 'projects/invoices' depending on the folder's depth.

```php
echo buildFolderPath(42); // 'projects/invoices' or 'invoices' or 'projects' ... depending on depth
```

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

### Customize with CSS variables

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Define CSS variables to customize the package's primary and secondary colors.

```css
:root {
    --filemanager-primary: #3B82F6;
    --filemanager-secondary: #6B7280;
}
```

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

### trimString usage example

Source: https://github.com/livewire-filemanager/filemanager

Example call to trimString with a long file name and max length 30, showing the output: first 22 characters plus '....' and the last 4 characters.

```php
echo trimString('a-very-long-file-name-that-overflows.pdf', 30);
// a-very-long-file-name-t....pdf  (first 22 chars + "...." + last 4)
```

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

### Directory Structure

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Shows the package's directory layout, including config, database, resources, src, and tests directories.

```text
filemanager/
├── config/
│   └── livewire-filemanager.stub      # Configuration template
├── database/
│   └── migrations/                     # Database migrations
├── resources/
│   ├── lang/                          # Language files (11 languages)
│   └── views/                         # Blade templates
│       ├── components/                # UI components
│       ├── livewire/                  # Livewire component views
│       └── partials/                  # Shared partials
├── src/
│   ├── Http/
│   │   ├── Controllers/
│   │   │   ├── Api/                   # API controllers
│   │   │   └── Files/                 # File access controller
│   │   └── Middleware/                # Custom middleware
│   ├── Livewire/                      # Livewire components
│   ├── Models/                        # Eloquent models
│   ├── Policies/                      # Authorization policies
│   ├── Traits/                        # Reusable traits
│   └── FilemanagerServiceProvider.php # Service provider
└── tests/                             # Test suite
```

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

### Publish Migrations

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Publish the filemanager and Spatie Media Library migrations. The second command is only needed if Spatie migrations are not already published.

```bash
# Publish filemanager migrations
php artisan vendor:publish --tag=livewire-filemanager-migrations

# Publish Spatie Media Library migrations (if not already done)
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-migrations"
```

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

### curl usage examples for listing and download

Source: https://github.com/livewire-filemanager/filemanager

List files with search and download a binary. Use -G with -d folder_id=5 for folder filter, --data-urlencode "search=invoice" for search, and -OJ for binary download. All require Authorization: Bearer <token>.

```bash
# All files in a folder
curl -G https://app.test/api/filemanager/v1/files \
  -H "Authorization: Bearer <token>" \
  -d folder_id=5

# Search across all files
curl -G https://app.test/api/filemanager/v1/files \
  -H "Authorization: Bearer <token>" \
  --data-urlencode "search=invoice"

# Binary download of a file
curl -OJ https://app.test/api/filemanager/v1/files/12 \
  -H "Authorization: Bearer <token>"
```

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

### Livewire directives

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Blade directives for styles and scripts. No changes needed for directives.

```blade
@filemanagerStyles
@filemanagerScripts
```

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

### POST /files

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Uploads a single file. The file is sent as multipart/form-data along with an optional folder_id.

```APIDOC
## POST /files

### Description
Uploads a single file.

### Method
POST

### Endpoint
/files

### Parameters
#### Request Body (multipart/form-data)
- **file** (binary) - Required - The file to upload
- **folder_id** (integer) - Optional - Folder ID to place the file in

### Request Example
```
{
    "file": <binary>,
    "folder_id": 1
}
```
```

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

### Manually rename config file

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Rename the configuration file from livewire-fileuploader.php to livewire-filemanager.php.

```bash
mv config/livewire-fileuploader.php config/livewire-filemanager.php
```

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

### Clear config cache

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Command to clear the configuration cache after moving the config file.

```bash
php artisan config:clear
```

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

### Update package

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Command to update the package to the latest version to resolve 'Class not found' errors for the migration command.

```bash
composer update livewire-filemanager/filemanager
```

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

### GET /folders/{folder}

Source: https://github.com/livewire-filemanager/filemanager

Retrieves a single folder by its identifier. Returns the folder resource.

```APIDOC
## [GET] /folders/{folder}

### Description
Retrieves a single folder by its identifier. Returns the folder resource.

### Method
GET

### Endpoint
/folders/{folder}

### Parameters
#### Path Parameters
- **folder** (Folder) - Required - The folder model instance.

### Response
#### Success Response (200)
- **FolderResource** - The folder resource.
```

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

### GET /folders/{folder}

Source: https://github.com/livewire-filemanager/filemanager

Retrieves a single folder with its children and media loaded.

```APIDOC
## [GET] /folders/{folder}

### Description
Retrieves a single folder with its children and media loaded.

### Method
GET

### Endpoint
/folders/{folder}

### Parameters
#### Path Parameters
- **folder** - Required - Folder identifier

### Response
#### Success Response (200)
- Single `FolderResource` with loaded `children` and `media`
```

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

### getMediaFullPath usage example

Source: https://github.com/livewire-filemanager/filemanager

Shows how to call getMediaFullPath() with a Media instance. The output differs based on the public_path configuration: when disabled, the URL excludes the prefix (e.g., https://example.com/projects/invoices/invoice.pdf); when enabled with prefix 'files', the URL includes it (e.g., https://example.com/files/projects/invoices/invoice.pdf).

```php
use LivewireFilemanager\Filemanager\Models\Media;

$url = getMediaFullPath($media);
// https://example.com/projects/invoices/invoice.pdf   (public_path disabled)
// https://example.com/files/projects/invoices/invoice.pdf (public_path enabled, prefix "files")
```

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

### Basic Blade Template with Filemanager

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Add the filemanager component to a Blade template, including the required styles and scripts.

```html
<!DOCTYPE html>
<html>
<head>
    @filemanagerStyles
</head>
<body>
    <x-livewire-filemanager />

    @filemanagerScripts
</body>
</html>
```

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

### Enable ACL in config

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Set 'acl_enabled' to true in the published configuration to enable access control.

```php
'acl_enabled' => true,
```

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

### Configuration Options

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Default configuration file with access control, API settings, and callbacks. Set acl_enabled to true to enable access control. API middleware defaults to ['api', 'auth:sanctum'] and rate_limit to '100,1'. max_file_size is in kilobytes (10240 KB = 10 MB).

```php
return [
    // Access Control
    'acl_enabled' => false,

    // API Configuration
    'api' => [
        'enabled' => true,
        'prefix' => 'filemanager/v1',
        'middleware' => ['api', 'auth:sanctum'],
        'rate_limit' => '100,1',
        'max_file_size' => 10240,
        'allowed_extensions' => ['jpg', 'jpeg', 'png', 'gif', 'pdf', 'doc', 'docx', 'txt', 'zip'],
        'chunk_size' => 1048576,
    ],

    // Callbacks
    'callbacks' => [
        'before_upload' => null,
        'after_upload' => null,
        'before_delete' => null,
        'after_delete' => null,
    ],
];
```

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

### Direct File Access Route

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Define a route to enable direct file access via URL. Place this in routes/web.php.

```php
// routes/web.php
use LivewireFilemanager\Filemanager\Http\Controllers\Files\FileController;

Route::get('{path}', [FileController::class, 'show'])
    ->where('path', '.*')
    ->name('assets.show');
```

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

### Bulk Upload Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

POST request to upload multiple files at once using files[] array and folder_id.

```http
POST /files/bulk
Content-Type: multipart/form-data

{
    "files[]": <binary>,
    "folder_id": 1
}
```

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

### Override translations

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Create a language file in resources/lang/{locale}/filemanager.php and return an array of translation overrides.

```php
// resources/lang/es/filemanager.php
return [
    'upload' => 'Subir archivo',
    'create_folder' => 'Crear carpeta',
    // ... other translations
];
```

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

### Clear application cache

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Command to clear the application cache if custom translations are not loading correctly.

```bash
php artisan cache:clear
```

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

### GET /api/filemanager/v1/files

Source: https://github.com/livewire-filemanager/filemanager

Lists or searches files. Requires Sanctum authentication by default.

```APIDOC
## GET /api/filemanager/v1/files

### Description
List / search files.

### Method
GET

### Endpoint
/api/filemanager/v1/files

### Response
#### Success Response (200)
- No response schema documented.

```

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

### getFileType usage examples

Source: https://github.com/livewire-filemanager/filemanager

Shows expected return values for various inputs: 'application/pdf' returns 'pdf', 'video/mp4' returns 'video', unknown MIME types return 'file', and null returns null.

```php
getFileType('application/pdf');                       // 'pdf'
getFileType('video/mp4');                             // 'video'
getFileType('application/octet-stream');              // 'file'
getFileType(null);                                    // null
```

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

### Rebuild Tailwind assets with npm run build

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Compiles and rebuilds the frontend assets. Run this after ensuring package views are included in the Tailwind config to fix unstyled UI.

```bash
npm run build
```

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

### Clear view cache

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Command to clear the view cache if custom views are not loading correctly.

```bash
php artisan view:clear
```

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

### Media Table Schema

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

SQL schema for the media table used by Spatie Media Library. Includes standard fields like model_type, collection_name, mime_type, disk, size, and custom properties.

```sql
- id (primary key)
- model_type
- model_id
- collection_name
- name
- file_name
- mime_type
- disk
- size
- custom_properties
- generated_conversions
- responsive_images
- manipulations
- created_at
- updated_at
```

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

### Old configuration path

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

The previous configuration key for ACL enabled status. Update any direct references in your application code to the new path.

```php
config('livewire-fileuploader.acl_enabled')
```

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

### Set application locale

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Use App::setLocale to set the application locale, which the package automatically uses for translations.

```php
// Set application locale
App::setLocale('fr');
```

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

### Run automatic migration command

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Use this command to automatically rename configuration, views, and translations from livewire-fileuploader to livewire-filemanager. It shows a summary of all changes made.

```bash
php artisan filemanager:migrate-config
```

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

### Upload File Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

POST request to upload a file with multipart/form-data, including file and folder_id.

```http
POST /files
Content-Type: multipart/form-data

{
    "file": <binary>,
    "folder_id": 1
}
```

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

### Create and navigate folder hierarchy with Folder model

Source: https://github.com/livewire-filemanager/filemanager

Shows basic creation of home and sub folders, checking isHomeFolder(), getting depth, accessing parent, and resolving by path. The findByPath method returns a Folder model or null.

```php
use LivewireFilemanager\Filemanager\Models\Folder;

$root = Folder::create(['name' => 'Projects', 'slug' => 'projects', 'parent_id' => null]);

if ($root->isHomeFolder()) {
    // parent_id is null → this is the home folder
}

$sub = Folder::create(['name' => 'Invoices', 'slug' => 'invoices', 'parent_id' => $root->id]);
echo $sub->getDepth(); // 1
echo $sub->parent->name; // Projects

$resolved = Folder::findByPath('projects/invoices'); // Folder model, or null
```

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

### Component usage

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Blade components for the file manager and modal. No changes needed for component usage.

```blade
<x-livewire-filemanager />
<x-livewire-filemanager-modal />
```

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

### Fix storage permissions

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Sets the storage directory permissions and ownership to allow the web server to write files. Run these commands if uploads fail due to permission issues.

```bash
chmod -R 775 storage
chown -R www-data:www-data storage
```

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

### GET /api/filemanager/v1/folders

Source: https://github.com/livewire-filemanager/filemanager

Lists folders in the file manager. Requires Sanctum authentication by default.

```APIDOC
## GET /api/filemanager/v1/folders

### Description
List folders.

### Method
GET

### Endpoint
/api/filemanager/v1/folders

### Response
#### Success Response (200)
- No response schema documented.

```

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

### GET /files

Source: https://github.com/livewire-filemanager/filemanager

Lists media files with optional search and folder filtering. Returns a collection of MediaResource.

```APIDOC
## [GET] /files

### Description
Lists media files with optional search and folder filtering. Returns a collection of MediaResource.

### Method
GET

### Endpoint
/files

### Parameters
#### Query Parameters
- **search** (string) - Optional - Filter by name or file_name containing the search term.
- **folder_id** (integer) - Optional - Filter by folder ID; if neither search nor folder_id is provided, defaults to the home folder.

### Response
#### Success Response (200)
- **data** (array) - Collection of MediaResource objects.

### Request Example
```bash
# All files in a folder
curl -G https://app.test/api/filemanager/v1/files \
  -H "Authorization: Bearer <token>" \
  -d folder_id=5

# Search across all files
curl -G https://app.test/api/filemanager/v1/files \
  -H "Authorization: Bearer <token>" \
  --data-urlencode "search=invoice"
```
```

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

### Run Migrations

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Run migrations to create the folders table and media table if not present.

```bash
php artisan migrate
```

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

### New configuration path

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

The new configuration key for ACL enabled status. The internal code has been updated to use this path automatically.

```php
config('livewire-filemanager.acl_enabled')
```

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

### PUT /folders/{id}

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Updates an existing folder's name. The folder ID is specified in the URL path.

```APIDOC
## PUT /folders/{id}

### Description
Updates an existing folder.

### Method
PUT

### Endpoint
/folders/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Folder ID

#### Request Body
- **name** (string) - Required - New folder name

### Request Example
```json
{
    "name": "Renamed Folder"
}
```
```

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

### GET /api/filemanager/v1/folders/{folder}

Source: https://github.com/livewire-filemanager/filemanager

Shows details of a specific folder. Requires Sanctum authentication by default.

```APIDOC
## GET /api/filemanager/v1/folders/{folder}

### Description
Show folder.

### Method
GET

### Endpoint
/api/filemanager/v1/folders/{folder}

### Parameters
#### Path Parameters
- **folder** - Required - The folder identifier.

### Response
#### Success Response (200)
- No response schema documented.

```

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

### PUT /files/{id}

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Updates a file's name. The file ID is specified in the URL path.

```APIDOC
## PUT /files/{id}

### Description
Updates a file's name.

### Method
PUT

### Endpoint
/files/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - File ID

#### Request Body
- **name** (string) - Required - New file name

### Request Example
```json
{
    "name": "renamed-file.pdf"
}
```
```

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

### POST /folders/{folder}/upload

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Uploads a file directly to a specific folder. The folder ID is specified in the URL path.

```APIDOC
## POST /folders/{folder}/upload

### Description
Uploads a file to a specific folder.

### Method
POST

### Endpoint
/folders/{folder}/upload

### Parameters
#### Path Parameters
- **folder** (integer) - Required - Folder ID

#### Request Body (multipart/form-data)
- **file** (binary) - Required - The file to upload

### Request Example
```
{
    "file": <binary>
}
```
```

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

### Authorization Header

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Include the bearer token in the Authorization header for API authentication using Laravel Sanctum.

```http
Authorization: Bearer YOUR_API_TOKEN
```

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

### GET /api/filemanager/v1/files/{file}

Source: https://github.com/livewire-filemanager/filemanager

Shows or downloads a specific file. Requires Sanctum authentication by default.

```APIDOC
## GET /api/filemanager/v1/files/{file}

### Description
Show / download file.

### Method
GET

### Endpoint
/api/filemanager/v1/files/{file}

### Parameters
#### Path Parameters
- **file** - Required - The file identifier.

### Response
#### Success Response (200)
- No response schema documented.

```

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

### boot() method signature

Source: https://github.com/livewire-filemanager/filemanager

The boot() method registers views and translations under the livewire-filemanager namespace, then chains all registration helpers.

```php
public function boot()
```

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

### GET /files

Source: https://github.com/livewire-filemanager/filemanager

Retrieves a list of files. Can be filtered by folder or search term; defaults to home folder.

```APIDOC
## [GET] /files

### Description
Retrieves a list of files. Can be filtered by folder or search term; defaults to home folder.

### Method
GET

### Endpoint
/files

### Parameters
#### Query Parameters
- **folder_id** (int) - Optional - Filter by folder
- **search** (string) - Optional - `name`/`file_name` LIKE

### Response
#### Success Response (200)
- **data** (array) - List of MediaResource

#### Response Example
```json
{"data": [ MediaResource ... ]}
```
```

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

### Set PHP upload limits in php.ini

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Configures the maximum upload file size and post size in PHP. Adjust these values if file uploads fail silently.

```ini
upload_max_filesize = 20M
post_max_size = 25M
```

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

### Folders Table Schema

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

SQL schema for the folders table. parent_id is a nullable foreign key for hierarchical folders, and user_id is nullable for ACL support.

```sql
- id (primary key)
- name (string)
- parent_id (nullable, foreign key)
- user_id (nullable, for ACL)
- created_at
- updated_at
```

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

### GET /files/{file}

Source: https://github.com/livewire-filemanager/filemanager

Retrieves a single file. Returns the file inline for images and PDFs, or as a download for other types. Returns 404 if the binary is missing.

```APIDOC
## [GET] /files/{file}

### Description
Retrieves a single file. Returns the file inline for images and PDFs, or as a download for other types. Returns 404 if the binary is missing.

### Method
GET

### Endpoint
/files/{file}

### Parameters
#### Path Parameters
- **file** (integer) - Required - The media file ID.

### Response
#### Success Response (200)
- Binary file content (inline or download).

#### Error Response (404)
- **message** (string) - "File not found" when the binary is missing.

### Request Example
```bash
# Binary download of a file
curl -OJ https://app.test/api/filemanager/v1/files/12 \
  -H "Authorization: Bearer <token>"
```

### Response Example
```json
{"message": "File not found"}
```
```

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

### GET /files/{file}

Source: https://github.com/livewire-filemanager/filemanager

Retrieves a file's binary content. Serves inline for certain MIME types, otherwise forces download.

```APIDOC
## [GET] /files/{file}

### Description
Retrieves a file's binary content. Serves inline for certain MIME types, otherwise forces download.

### Method
GET

### Endpoint
/files/{file}

### Parameters
#### Path Parameters
- **file** - Required - File identifier

### Response
#### Success Response (200)
- Raw binary - Inline for `image/jpeg|png|gif|application/pdf`, otherwise forced download

#### Error Response (404)
- **message** (string) - "File not found" when the binary is missing
```

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

### Configure allowed extensions and max file size in livewire-filemanager.php

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Sets the maximum file size in KB and the list of allowed extensions for uploads. Both the API endpoints and Livewire component enforce these values.

```php
// config/livewire-filemanager.php
'api' => [
    'max_file_size' => 10240, // KB
    'allowed_extensions' => ['jpg', 'jpeg', 'png', 'gif', 'pdf', 'doc', 'docx', 'txt', 'zip'],
],
```

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

### Manual route registration variant with ACL note

Source: https://github.com/livewire-filemanager/filemanager

Shown in the ACL context: a non-owner request receives 404, not 403. This is the same manual route registration as the earlier example, repeated for the ACL usage scenario.

```php
// routes/web.php — manual registration variant
Route::get('{path}', [FileController::class, 'show'])
    ->where('path', '.*')
    ->name('assets.show');
```

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

### Delete File Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

DELETE request to remove a file by ID.

```http
DELETE /files/{id}
```

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

### Update File Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

PUT request to rename a file by ID.

```http
PUT /files/{id}
Content-Type: application/json

{
    "name": "renamed-file.pdf"
}
```

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

### Delete Folder Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

DELETE request to remove a folder by ID.

```http
DELETE /folders/{id}
```

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

### Include Component and Assets

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

HTML layout with the filemanager component and required styles/scripts.

```html
<!DOCTYPE html>
<html>
<head>
    @filemanagerStyles
</head>

<body>
    <x-livewire-filemanager />

    @filemanagerScripts
</body>
</html>
```

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

### Apache .htaccess to deny PHP execution in storage

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Place this .htaccess file in storage/app/public/ to block access to any PHP files in the storage directory, preventing script execution.

```apache
<FilesMatch "\.php$">
    Deny from all
</FilesMatch>
```

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

### Example JSON response shape

Source: https://github.com/livewire-filemanager/filemanager

Shows the automatic wrapping of resources in a 'data' key. Single resources are wrapped as an object, collections as an array. The '...' placeholder indicates additional fields.

```json
{
    "data": {
        "id": 2,
        "url": "https://app.test/storage/2/example.pdf",
        "thumbnail_url": null,
        "custom_properties": { "user_id": 1 },
        "...": "..."
    }
}
```

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

### Publish Migrations

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Publish the package's migration file.

```bash
php artisan vendor:publish --tag=livewire-filemanager-migrations
```

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

### Update Folder Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

PUT request to rename a folder by ID.

```http
PUT /folders/{id}
Content-Type: application/json

{
    "name": "Renamed Folder"
}
```

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

### Publish Spatie MediaLibrary Migrations

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Publish the migrations for spatie/medialibrary if not already configured.

```bash
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-migrations"
```

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

### Publish livewire-filemanager config

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Publishes the package configuration file to enable ACL. Run this command to create the livewire-filemanager.php config file, then set acl_enabled to true.

```bash
php artisan vendor:publish --tag=livewire-filemanager-config
```

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

### HTML img tag using public file URL

Source: https://github.com/livewire-filemanager/filemanager

Example of how files are reachable with automatic registration: /files/{folder path}/{file name}. The URL includes the configured prefix.

```html
<img src="/files/projects/banner.png" alt="">
```

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

### DELETE /files/{id}

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Deletes a file by its ID. The file ID is specified in the URL path.

```APIDOC
## DELETE /files/{id}

### Description
Deletes a file.

### Method
DELETE

### Endpoint
/files/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - File ID
```

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

### Enable Public Path in Config

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Configuration to let the package register the route under a prefix.

```php
'public_path' => [
    'enabled' => true,
    'prefix' => 'files',
    'middleware' => ['web'],
],
```

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

### DELETE /folders/{id}

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Deletes a folder by its ID. The folder ID is specified in the URL path.

```APIDOC
## DELETE /folders/{id}

### Description
Deletes a folder.

### Method
DELETE

### Endpoint
/folders/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Folder ID
```

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

### FilemanagerServiceProvider class skeleton

Source: https://github.com/livewire-filemanager/filemanager

Defines the service provider with policy mappings and registration methods. The boot() method registers views, translations, and calls all registration helpers.

```php
class FilemanagerServiceProvider extends ServiceProvider
{
    protected $policies = [
        Media::class => MediaPolicy::class,
        Folder::class => FolderPolicy::class,
    ];

    public function boot() { ... }
    public function register() { ... }
    protected function registerPublishables(): self { ... }
    public function registerLivewireComponents(): self { ... }
    public function registerBladeComponents(): self { ... }
    public function registerBladeDirectives(): self { ... }
    public function registerPolicies(): self { ... }
    protected function registerApiRoutes(): self { ... }
    protected function registerPublicFileRoute(): self { ... }
    protected function registerMiddleware(): self { ... }
    protected function registerCommands(): self { ... }
}
```

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

### index(Request $request) method signature

Source: https://github.com/livewire-filemanager/filemanager

Method signature for listing folders. Accepts query parameters parent_id (optional, defaults to home folder) and search (optional, filters by name LIKE %search%). Returns FolderResource::collection with eager-loaded media and children count.

```php
public function index(Request $request)
```

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

### Import FileController

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Import the FileController class for the route.

```php
use LivewireFilemanager\Filemanager\Http\Controllers\Files\FileController;
```

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

### GET /folders

Source: https://github.com/livewire-filemanager/filemanager

Retrieves a list of folders. Supports filtering by parent folder and searching by name.

```APIDOC
## [GET] /folders

### Description
Retrieves a list of folders. Supports filtering by parent folder and searching by name.

### Method
GET

### Endpoint
/folders

### Parameters
#### Query Parameters
- **parent_id** (int|null) - Optional - Defaults to home folder
- **search** (string) - Optional - `name LIKE %search%`

### Response
#### Success Response (200)
- **data** (array) - List of folder objects

#### Response Example
```json
{ "data": [ { "id": 1, "name": "Documents", "slug": "documents", "parent_id": null,
  "is_home_folder": true, "elements_count": 3, "created_at": "...", "updated_at": "...",
  "children": [], "media": [] } ] }
```
```

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

### Publish Livewire Config

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Publish Livewire's config to adjust upload limits.

```bash
php artisan livewire:publish --config
```

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

### Create folder and upload files with curl

Source: https://github.com/livewire-filemanager/filemanager

Creates a folder via POST and uploads files into it via POST. Requires bearer token and uses multipart form data for uploads.

```bash
# Create a folder
curl -X POST https://app.test/api/filemanager/v1/folders \
  -H "Authorization: Bearer <token>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name": "Reports", "parent_id": 1}'

# Upload files into it
curl -X POST https://app.test/api/filemanager/v1/folders/2/upload \
  -H "Authorization: Bearer <token>" \
  -F "files[]=@report.pdf" \
  -F "files[]=@chart.png"
```

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

### Override Tailwind classes

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Use Tailwind's @apply directive to override the container's background classes.

```css
.livewire-filemanager-container {
    @apply bg-gray-50 dark:bg-gray-900;
}
```

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

### Create media via folder addMedia

Source: https://github.com/livewire-filemanager/filemanager

Shows how media rows are produced by Medialibrary file adders, not through the model's constructor. Adds a file to a folder with a custom user_id property and stores it in the 'medialibrary' collection. The resulting $media is a Media instance; getUrl() and thumbnail conversion URL are demonstrated.

```php
use LivewireFilemanager\Filemanager\Models\Folder;
use Illuminate\Support\Facades\Auth;

$folder = Folder::find($folderId);

$media = $folder
    ->addMedia($file)
    ->withCustomProperties([
        'user_id' => optional(Auth::user())->id,
    ])
    ->toMediaCollection('medialibrary');

// $media is a LivewireFilemanager\Filemanager\Models\Media instance
echo $media->getUrl();
echo $media->hasGeneratedConversion('thumbnail') ? $media->getUrl('thumbnail') : null;
```

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

### Upload to Specific Folder Endpoint

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

POST request to upload a file directly to a specific folder using its ID.

```http
POST /folders/{folder}/upload
Content-Type: multipart/form-data

{
    "file": <binary>
}
```

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

### Folder booted() method signature

Source: https://github.com/livewire-filemanager/filemanager

Declares the booted() static method used to register model events and a global scope. The method body is not shown in the source.

```php
protected static function booted(): void
```

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

### POST /api/filemanager/v1/folders

Source: https://github.com/livewire-filemanager/filemanager

Creates a new folder. Requires Sanctum authentication by default.

```APIDOC
## POST /api/filemanager/v1/folders

### Description
Create folder.

### Method
POST

### Endpoint
/api/filemanager/v1/folders

### Response
#### Success Response (200)
- No response schema documented.

```

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

### Route for Public File Access

Source: https://github.com/livewire-filemanager/filemanager/blob/master/README.md

Define a route to serve files publicly.

```php
Route::get('{path}', [FileController::class, 'show'])->where('path', '.*')->name('assets.show');
```

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

### Resolve folder to serve a file with guards

Source: https://github.com/livewire-filemanager/filemanager

Resolves a folder by path, aborts with 404 if not found, fetches media by file name, and prevents '..' traversal via slug segments by aborting with 400.

```php
use LivewireFilemanager\Filemanager\Models\Folder;
use LivewireFilemanager\Filemanager\Models\Media;

$folder = Folder::findByPath('docs/manuals');
abort_if(! $folder, 404);

$media = $folder->media()
    ->where('file_name', $mediaName)
    ->firstOrFail();

// prevent '..' traversal-style lookups via slug segments
foreach (explode('/', $path) as $segment) {
    if ($segment === '..') {
        abort(400);
    }
}
```

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

### isHomeFolder(): bool

Source: https://github.com/livewire-filemanager/filemanager

Returns `true` when `parent_id` is `null` (the root folder).

```php
public function isHomeFolder(): bool
```

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

### Render media and folder panels manually

Source: https://github.com/livewire-filemanager/filemanager

Render the media panel and folder panel manually to observe selection state. These components are normally rendered inside the package's own views and driven by events.

```blade
<livewire:livewire-filemanager.media-panel />
<livewire:livewire-filemanager.folder-panel />
```

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

### show(Folder $folder)

Source: https://github.com/livewire-filemanager/filemanager

Displays a specific folder with its children and media. Authorizes the view action and returns the folder resource.

```APIDOC
## show(Folder $folder)

### Description
Displays a specific folder with its children and media. Authorizes the view action and returns the folder resource.

### Method
GET

### Endpoint
/folders/{folder}

### Parameters
#### Path Parameters
- **folder** (Folder) - Required - The folder instance.

### Response
#### Success Response (200)
- **FolderResource** - The folder resource with loaded children and media.

#### Error Response (403)
- **AuthorizationException** - Thrown when the policy denies access.

```

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

### Manually move published translations directory

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Move the published translations directory from livewire-fileuploader to livewire-filemanager. Only needed if you have customized translations.

```bash
mv resources/lang/vendor/livewire-fileuploader resources/lang/vendor/livewire-filemanager
```

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

### show method signature

Source: https://github.com/livewire-filemanager/filemanager

Authorizes view, resolves $file->getPath(); returns 404 {"message": "File not found"} if file missing. Reads MIME type with mime_content_type(). For image/jpeg, image/png, image/gif, application/pdf returns response()->file($filePath) (inline); otherwise response()->download($filePath, $file->file_name). Throws AuthorizationException (403) when policy denies.

```php
public function show(Media $file)
```

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

### Manually move published views directory

Source: https://github.com/livewire-filemanager/filemanager/blob/master/UPGRADE.md

Move the published views directory from livewire-fileuploader to livewire-filemanager. Only needed if you have customized views.

```bash
mv resources/views/vendor/livewire-fileuploader resources/views/vendor/livewire-filemanager
```

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

### Catch missing file binary in API consumer (PHP)

Source: https://github.com/livewire-filemanager/filemanager

Handles HTTP 404 with message 'File not found' when the media row exists but the binary is gone. Uses Laravel's HTTP client and catches RequestException to inspect the response status and JSON message.

```php
try {
    $binary = Http::withToken($token)->get("/api/filemanager/v1/files/{$id}");
} catch (Illuminate\Http\Client\RequestException $e) {
    if ($e->response->status() === 404 && $e->response->json('message') === 'File not found') {
        // media row exists but binary is gone
    }
}
```

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

### Manual route registration for FileController in routes/web.php

Source: https://github.com/livewire-filemanager/filemanager

Registers a catch-all route that maps any path to FileController::show, named 'assets.show'. Use this manual approach instead of the automatic config-based registration.

```php
use LivewireFilemanager\Filemanager\Http\Controllers\Files\FileController;

Route::get('{path}', [FileController::class, 'show'])
    ->where('path', '.*')
    ->name('assets.show');
```

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

### registerMediaConversions(?Media $media = null): void

Source: https://github.com/livewire-filemanager/filemanager

Spatie Medialibrary conversion hook: registers a `thumbnail` conversion (webp, width 100) for the `medialibrary` collection. `InvalidManipulation` is thrown by the underlying library when an unsupported manipulation/format is configured.

```php
/**
 * Some media conversions for all models
 *
 * @throws InvalidManipulation
 */
public function registerMediaConversions(?Media $media = null): void
{
    $this->addMediaConversion('thumbnail')->format('webp')->width(100)->performOnCollections('medialibrary');
}
```

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

### store(StoreFolderRequest $request)

Source: https://github.com/livewire-filemanager/filemanager

Creates a new folder with the provided name and optional parent. Returns the created folder resource with HTTP 201.

```APIDOC
## store(StoreFolderRequest $request)

### Description
Creates a new folder with the provided name and optional parent. Returns the created folder resource with HTTP 201.

### Method
POST

### Endpoint
/folders

### Parameters
#### Request Body
- **name** (string) - Required - The folder name.
- **parent_id** (nullable) - Optional - The parent folder ID, must exist and respect max-depth.

### Response
#### Success Response (201)
- **FolderResource** - The created folder resource.

```

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

### POST /folders

Source: https://github.com/livewire-filemanager/filemanager

Creates a new folder. Requires a name and optionally a parent folder, with depth validation.

```APIDOC
## [POST] /folders

### Description
Creates a new folder. Requires a name and optionally a parent folder, with depth validation.

### Method
POST

### Endpoint
/folders

### Parameters
#### Request Body
- **name** (string) - Required - Max 255, unique slug per parent
- **parent_id** (nullable) - Optional - Must exist in folders, depth-checked against `folders.max_depth`

### Response
#### Success Response (201)
- Single `FolderResource` (see resources)
```

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

### GET /folders

Source: https://github.com/livewire-filemanager/filemanager

Lists folders, optionally filtered by parent folder and search term. Returns a collection of folder resources eager-loaded with media and child counts.

```APIDOC
## [GET] /folders

### Description
Lists folders, optionally filtered by parent folder and search term. Returns a collection of folder resources eager-loaded with media and child counts.

### Method
GET

### Endpoint
/folders

### Parameters
#### Query Parameters
- **parent_id** (int|null) - Optional - Filter to folders whose `parent_id` equals this value. Empty/absent falls back to the home folder (`parent_id IS NULL`). If no home folder exists, returns an empty collection.
- **search** (string) - Optional - `WHERE name LIKE %search%`

### Response
#### Success Response (200)
- **FolderResource::collection** - Collection of folder resources eager-loaded with `media` and `withCount('children')`.
```

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

### Nginx configuration to deny PHP execution in storage

Source: https://github.com/livewire-filemanager/filemanager/blob/master/docs.md

Add this location block to your Nginx server configuration to deny all requests to PHP files under the /storage/ path.

```nginx
location ~* /storage/.*\.php$ {
    deny all;
}
```

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

### Publish configuration file with artisan vendor:publish

Source: https://github.com/livewire-filemanager/filemanager

Publishes a real copy of the configuration to config/livewire-filemanager.php. The package merges the stub config by default, so publishing is only needed to customize options.

```bash
php artisan vendor:publish --tag=livewire-filemanager-config
# → config/livewire-filemanager.php
```
Tokens:
Raw