README

Multi-driver file storage for PHP 8.3+. Handles upload, retrieval, and streaming of files across local and cloud storage backends, with expiring/download-limited tokens, image size enforcement, and file ownership.

Requirements

PHP 8.3+
MariaDB 10.4+ / MySQL 8.0+
timefrontiers/php-sql-database
timefrontiers/php-database-object
timefrontiers/php-has-errors
timefrontiers/php-pagination
timefrontiers/php-data
timefrontiers/php-validator
gumlet/php-image-resize (bundled — used for max-dimension enforcement on upload)

Optional:

aws/aws-sdk-php ^3.0 — required when using the S3 driver

Installation

composer require timefrontiers/php-file

For S3 support:

composer require aws/aws-sdk-php

Database

Run sql/install.sql against your file database to create the required tables:

file_meta      — primary file record
file_tokens    — expiring / download-limited tokens
file_default   — per-owner default file mappings (e.g. avatar, banner)
folders        — named file containers
folder_files   — folder ↔ file pivot

Migrating from linktude/php-file? See sql/migrate.sql.

Configuration

Call File::configure() once in your application bootstrap, before any File instance is created.

use TimeFrontiers\File\File;

File::configure(
    base: [
        'db_name'       => 'file',                     // database name
        'upload_path'   => '/var/www/storage',         // absolute root for local storage
        'storage_url'   => 'https://cdn.example.com',  // base URL for direct public file access
        'service_url'   => 'https://files.example.com',// base URL for your download endpoint
        'token_secret'  => 'your-hmac-secret',         // used to sign download tokens
        'max_size'      => 1024 * 1024 * 25,           // 25 MB upload limit
        'min_size'      => 0,                          // 0 = no minimum
        'max_width_px'  => 2000,                       // images wider than this are resized down
        'max_height_px' => 2000,
        'min_width_px'  => null,                       // null = no minimum dimension check
        'min_height_px' => null,
    ],
    driver: [
        'name'    => 'local',       // 'local' | 's3' | 'gcs' | 'onedrive' | 'dropbox'
        // S3 options (only read when name = 's3'):
        'bucket'  => '',
        'region'  => 'us-east-1',
        'key'     => '',
        'secret'  => '',
        'endpoint'=> null,          // set for S3-compatible stores (MinIO etc.)
    ]
);

Usage

Upload

use TimeFrontiers\File\File;

$file = new File($conn);
$file->setPath('/User-Files/' . $userCode)   // relative path inside upload_path
     ->privacy('public');                    // 'public' | 'private'

$file->owner    = $userCode;
$file->caption  = 'Profile photo';

$ok = $file->upload($_FILES['avatar'], owner: $userCode, creator: $userCode);

if (!$ok) {
    // $file->getErrors() — HasErrors compatible
}

echo $file->id;        // BIGINT surrogate key
echo $file->code;      // '583...' 15-char human identifier
echo $file->sizeAsText(); // '1.2 MB'

Load an existing file

// by BIGINT id
$file = (new File($conn))->load(42);

// by 15-char code
$file = (new File($conn))->load('583258614696648');

// via QueryBuilder
$files = File::query()
    ->where('owner', $userCode)
    ->where('type_group', 'image')
    ->orderByDesc('_created')
    ->limit(20)
    ->get();

Direct URL (public files only)

echo $file->url();   // https://cdn.example.com/User-Files/123/abc.jpg

Download tokens

Tokens are HMAC-signed, driver-agnostic, and enforce both time expiry and download limits.

// Mint a token — expires in 24 hours, max 5 downloads
$token = $file->createToken(
    expiresAt:    '+24 hours',
    maxDownloads: 5,
    createdBy:    $userCode
);

// Build the full URL to hand to a client
$url = $file->tokenUrl($token);
// → https://files.example.com/download/<token>

On your download endpoint:

// Resolve + validate the token (verifies HMAC, checks expiry and counter)
$file = File::resolveToken($token);

if (!$file) {
    http_response_code(403);
    exit();
}

$file->download($token);       // stream inline  (increments counter)
$file->forceDownload($token);  // force attachment download

Update metadata

$file->caption   = 'Updated caption';
$file->nice_name = 'new-name.jpg';
$file->update();

Lock a file

Locking computes a SHA-512 checksum and prevents further updates.

$file->lock();

echo $file->locked();    // true
echo $file->checksum();  // sha-512 hex string

Delete a file

// Refuses if the file is set as a default anywhere
$file->destroy();

// Force removal even if set as a default
$file->destroy(force: true);

Default files

Map an owner string to one or more named file slots.

use TimeFrontiers\File\FileDefault;

// Single default — replaces any existing default for 'avatar'
FileDefault::set($conn, user: $userCode, setKey: 'avatar', fileId: $file->id);

// Multi default — appends to a gallery list
FileDefault::set($conn, user: $userCode, setKey: 'gallery', fileId: $file->id, multiSet: true);

// Retrieve
$default = FileDefault::get($conn, user: $userCode, setKey: 'avatar');  // FileDefault|false
$gallery = FileDefault::getAll($conn, user: $userCode, setKey: 'gallery'); // FileDefault[]

// Remove one entry
FileDefault::remove($conn, user: $userCode, setKey: 'gallery', fileId: $file->id);

// Clear all defaults for a slot
FileDefault::clearSet($conn, user: $userCode, setKey: 'gallery');

Folders

use TimeFrontiers\File\Folder;
use TimeFrontiers\File\FolderFile;

// Create
$folder          = new Folder($conn);
$folder->name    = 'profile-assets';
$folder->title   = 'Profile Assets';
$folder->owner   = $userCode;
$folder->_author = $userCode;
$folder->create();

// List all folders for an owner
$folders = Folder::forOwner($conn, $userCode);

// Add / remove files
FolderFile::add($conn, folderId: $folder->id, fileId: $file->id);
FolderFile::remove($conn, folderId: $folder->id, fileId: $file->id);

// Files in a folder
$pivots = FolderFile::forFolder($conn, $folder->id);

// Delete folder (removes all pivot rows automatically)
$folder->destroy();

Storage drivers

Driver	Status	Notes
`local`	✅ Full	Default. Files stored under `upload_path`.
`s3`	✅ Full	Requires `aws/aws-sdk-php`. Works with any S3-compatible endpoint.
`gcs`	🔲 Stub	Throws `DriverException` — implementation coming.
`onedrive`	🔲 Stub	Throws `DriverException` — implementation coming.
`dropbox`	🔲 Stub	Throws `DriverException` — implementation coming.

Override the driver for a specific instance:

$file = new File($conn, driver: 's3');

Image constraints

Configured in base[]. Applied automatically on every upload before the file reaches storage.

Key	Effect
`max_width_px`	Images wider than this are resized down (aspect ratio preserved)
`max_height_px`	Images taller than this are resized down
`min_width_px`	Images narrower than this are rejected
`min_height_px`	Images shorter than this are rejected

Set any value to null to disable that constraint. Non-image files pass through all checks untouched.

Note: Full image manipulation (crop, rotate, watermark) is planned for timefrontiers/php-image.

Ownership

All ownership fields are VARCHAR(64) strings — not foreign keys — so they can hold user codes, system constants, or any arbitrary identifier.

Table	Column	Example values
`file_meta`	`owner`	`'08744307265'`, `'SYSTEM'`, `'SYSTEM.HIDDEN'`
`file_default`	`user`	`'08744307265'`, `'SYSTEM'`
`folders`	`owner`	`'08744307265'`, `'SYSTEM'`

License

MIT — see LICENSE.

timefrontiers / php-file

Maintainers

Package info

Statistics

Security