PHP Luminova: File System Management Utilities

The Luminova FileSystem is a core component of the Luminova framework designed for managing file-related operations. It handles tasks such as retrieving system paths, downloading, reading, and writing files. With its static methods, FileSystem offers convenient and efficient file management within both the framework and your application.

• Class namespace: \Luminova\Storages\FileManager

Helper Function

Using helper functions to access class object and properties.

<?php
echo path('system');
echo factory('files', true)->system;

Outputs

Windows: /system/
Unix:  \\system\\

Properties

system

Path to the system framework codes.

protected string $system

plugins

Path to the system third-party plugins.

protected string $plugins

library

Path to the libraries and third-party modules.

protected string $library

services

Path to the serialized shared services.

protected string $services

controllers

Path to the application controllers.

protected string $controllers

writeable

Path to the writeable files.

protected string $writeable

logs

Path to the error logs.

protected string $logs

caches

Path to the application caches.

protected string $caches

public

Path to the public controller document root.

protected string $public

assets

Path to the public assets directory.

protected string $assets

views

Path to the template views files.

protected string $views

routes

Path to the application routes.

protected string $routes

languages

Path to the languages modules.

protected string $languages

Methods

permission

Check if file has read, write or read+write permission is granted.

public static permission(string $permission = 'rw', string|null $file = null, bool $quiet = false): bool

Parameters:

Return Value:

bool - Returns true if permission is granted otherwise false.

Throws:

• \Luminova\Exceptions\FileException - If permission is not granted and quiet is not passed true.

setPermission

Set permissions for a file or directory.

public static setPermission(string $location, int $permission): bool

Parameters:

Return Value:

bool - True on success, false on failure.

permissions

Converts file permission code to its string representation

public static permissions(int $permission): string

Parameters:

Return Value:

string - Permission string representation.

toUnixPermission

Convert permission string to Unix integer permission.

public static toUnixPermission(string $permission): int|null

Parameters:

Return Value:

int|null - The Unix integer permission, or null if the conversion failed.

write

Write or append contents to a file.

public static write(string $filename, string|resource $content, int $flags, resource $context = null): bool

Parameters:

Return Value:

bool - Return true if content was write successfully, otherwise false.

Throws:

• \Luminova\Exceptions\FileException - If unable to write file.

stream

Write or append contents to a file.

public static stream(string $filename, resource $resource, int $flags, resource $context = null): bool

Parameters:

Return Value:

bool - Return true if the operation was successful, false otherwise.

Throws:

• \Luminova\Exceptions\FileException - If unable to write file or invalid resource.

mkdir

Attempts to create the directory, if it doesn't exist.

public static mkdir(string $path, int $permissions = 0777, bool $recursive = true): bool

Parameters:

Return Value:

bool - Return true if directory already existed or was created successfully, otherwise false.

Throws:

• \Luminova\Exceptions\RuntimeException - If path is not readable.
• \Luminova\Exceptions\FileException - If unable to create directory

copy

Copy files and folders from the source directory to the destination directory.

public static copy(string $origin, string $dest, int& $copied = 0): bool

Parameters:

Return Value:

bool - Return true if the copy operation is successful, false otherwise.

move

Move files and folders from one location to another recursively.

public static move(string $origin, string $dest, int& $moved = 0): bool

Parameters:

Return Value:

bool - Return true if the operation is successful, false otherwise.

size

To calculate the size of a given file or an entire directory.If a directory is specified, it calculates the size of a given path recursively to determine total size of all files within the directory.

public static size(string $path): int 

Parameters:

Return Value:

int - Return the size in bytes.

Throws:

\Luminova\Exceptions\FileException - Throws If the path does not exist.

read

Reads a file in chunks with type-specific handling and customizable delay, for optimized performance.

This method reads large files efficiently by determining the file type based on its MIME type and applying the appropriate reading strategy (text or binary).

For text-based files, it reads while preserving line endings. For binary files, it reads in raw chunks.

public static read(
    $handler, 
    int $filesize, 
    string $mime, 
    int $length = (1 << 21),
    int $delay = 100000
): bool

Parameters:

Return Value:

bool - Return true if the file was successfully read, false otherwise.

Example

<?php 
$filename = 'large-file.pdf';
if ($handler = fopen($filename, 'rb')) {
    $fileSize = filesize($filename);
    $mime = get_mime($filename);

    FileManager::read($handler, $fileSize, $mime);
}

readBinary

Reads binary files in chunks with a customizable delay. This method is suitable for reading PDF, AUDIO, IMAGES and other types of files that preserving lines ending isn't necessary.

public static readBinary($handler, int $length = (1 << 21), int $delay = 100000): bool

Parameters:

Return Value:

bool - Return true if the file was successfully read, false otherwise.

readText

Reads text-based files in chunks with a customizable delay while preserving line endings. This method is suitable for handling TEXT, MD, LOG and other text-based files.

public static readText($handler, int $filesize, int $length = (1 << 21), int $delay = 100000): bool

Parameters:

Return Value:

bool - Return true if the file was successfully read, false otherwise.

isResource

Checks if a variable is a valid resource of the specified type.

public static isResource(mixed $resource, ?string $type = null): bool

Parameters:

Return Value:

bool - Returns true if the variable is a resource and matches the expected resource type, otherwise returns false.

isAccessible

Validate if the provided file path is safe, exists, and is readable.This method checks if the file path is valid, whether it is accessible, and ensures it's readable unless it's a UNC path.

public static isAccessible(string $path): bool

Parameters:

Return Value:

bool - Returns true if the file is accessible and readable.

isPathPermitted

Verify if the file path follows the allowed format and is not a URL or PHP Archive (Phar).This method ensures that the file path does not use a URL scheme or a phar path, restricting access to local files only.

public static isPathPermitted(string $path): bool

Parameters:

Return Value:

bool - Returns true if the path is a valid local file path.

download

Download a file to the user's browser with optional delay between chunks.

public static download(
    string|resource $content, 
    ?string $filename = null, 
    array $headers = [], 
    bool $delete = false,
    int $chunk_size = 8192,
    int $delay = 100000
): bool

Parameters:

Return Value:

bool - Return true on success, false on failure.

Supported Download Content $content

• File path - Download content from path specified.
• Resource - Download content from resource specified.
• String - Download content from string specified.

remove

Deletes files and folders recursively.

public static remove(string $location, bool $delete_base = false, int& $deleted = 0): int

Parameters:

Return Value:

int - Returns count of deleted files.

symbolic

Create a symlink to a target file or directory.

public static symbolic(string $target, string $link): bool

Parameters:

Return Value:

bool - Return true if the link was successfully created false otherwise.