Model uploads

File fields and their parameters are described in File uploads. This page covers the upload behaviour of the whole model.

Private files

The private field parameter stores a file outside the public directory. To make all file fields of a model private, set the property:

app/Models/Contract.php

protected $privateUploads = true;

In the administration, private files are served through /uploads/{table}/{field}/{filename} only to logged administrators with the read permission of the model. A guest receives 401. On the website use the signed download() link.

Deleting old files

When a file is replaced in the form, or a record is deleted, the original files are deleted from the storage, including files of multiple fields. Keep them with:

app/Models/Invoice.php

protected $delete_files = false;

Resized copies of images in the cache are removed in both cases. To keep the files of all models, set reduce_space to false.

Image compression and maximum size

Uploaded jpg, jpeg and png images are post-processed:

rotated by EXIF orientation,
resized when larger than image_max_width × image_max_height (3840 × 2160 by default, the ratio is kept),
JPEG images are encoded with the image_lossy_compression_quality quality (85 by default),
optimized by shell tools (jpegoptim, optipng, pngquant, …) when image_lossless_compression is enabled.

Every step can be changed per model:

app/Models/Gallery.php

// JPEG quality in percent, false keeps full quality
protected $imageLossyCompression = 70;

// Keep the original dimensions of uploaded images
protected $imageMaximumProportions = false;

// Skip shell optimizers
protected $imageLosslessCompression = false;

The global defaults are described in the configuration.

Uploading files from code

upload($field, $file, $options = []) stores a file into the directory of a model field, runs the same image processing as the administration and returns the file object. The column value is not changed, assign the filename yourself.

app/Http/Controllers/ProfileController.php

public function avatar(Request $request)
{
    $client = client();

    if ( $file = $client->upload('avatar', $request->file('avatar')) ) {
        $client->update(['avatar' => $file->filename]);
    } else {
        return autoAjax()->error($client->getUploadError())->throw();
    }

    return $client->avatar->url;
}

The second argument accepts an UploadedFile, a path to a local file (the source file is copied) or a URL. When the upload fails, upload() returns false and getUploadError() returns the reason.

Option	Description
`filename`	stored name, `'Invoice 2026.pdf'` is stored as `invoice-2026.pdf`
`postfix`	`true` appends a random key (`invoice_x8Kd02LmQa.pdf`), default from `uploads_postfix`
`disk`	filesystem disk name

Filenames are slugged and an existing file is never overwritten (invoice-1.pdf). The filename can be changed by the set{Key}Filename() method of the model.

// Delete all files of the field, or all except the given filenames. The column value is not changed.
$order->deleteFiles('invoice');
$order->deleteFiles('gallery', ['photo-1.jpg']);

// File object of a stored filename
$file = $order->getAdminFile('invoice', 'invoice-2026.pdf');

// Disk and directory of a field
$order->getFieldStorage('invoice');     // Illuminate\Filesystem\FilesystemAdapter
$order->getStorageFilePath('invoice');  // "orders/invoice"

Thumbnail size in the table

Image thumbnails in the table are 50×50 px. Define get{Field}AdminThumbnailDimensions(), with the field key in camel case, to change the size. Use null for one side to keep the ratio.

app/Models/Product.php

public function getCoverImageAdminThumbnailDimensions()
{
    return [120, 80];
}

Editor file manager folder

With a file browser enabled, editor uploads go into the storage folder of the record. setFieldUploader() changes the folder config for a field.

app/Models/Article.php

public function setFieldUploader($data, $field, $rowId)
{
    $data['folder_name'] .= '/'.$field;
    $data['max_size'] = 5000; // KB

    return $data;
}

Getting started

Upgrade guide

Admin interface

Validation

Frontend

Website

Private files

Deleting old files

Image compression and maximum size

Uploading files from code

Thumbnail size in the table

Editor file manager folder

​Private files

​Deleting old files

​Image compression and maximum size

​Uploading files from code

​Thumbnail size in the table

​Editor file manager folder

Private files

Deleting old files

Image compression and maximum size

Uploading files from code

Thumbnail size in the table

Editor file manager folder