PHP Luminova: Luminova Framework Class

The Luminova class is the central utility hub for the Luminova framework. It provides framework-level constants and static helper methods to simplify common tasks, access the application kernel, and retrieve metadata about the framework.

All methods are static, so there’s no need to instantiate the class.

Usage Examples

Get Framework Version

use Luminova\Luminova;

echo Luminova::version(); // e.g., 3.8.1

Access the Application Kernel

$kernel = Luminova::kernel();
// Use $kernel to access modules and services

Get Base Class Name

$base = Luminova::getClassBaseName('\App\Controllers\HomeController'); 
// Returns: HomeController

Trim System Path

$path = Luminova::trimSystemPath('/var/www/project/app/Controllers/Http/Home.php');
// Returns: app/Controllers/Http/Home.php

Class Definition

• Full namespace: \Luminova\Luminova
• This class is a Final class

Constants

Methods

version

Get the framework version name or code.

final public static version(bool $integer = false): string|int

Parameters:

Return Value:

string|int - Return version name or code.

kernel

Get the application kernel instance.

Returns the kernel responsible for bootstrapping the applicationand providing access to core modules during the application lifecycle.

• By default, a shared kernel instance is returned.
• If $notShared is true, or the kernel is configured not to be shared, a new kernel instance is created and returned.

public static kernel(bool $notShared = false): Luminova\Interface\ServiceKernelInterface

Parameters:

Return Value:

\Luminova\Interface\ServiceKernelInterface - Kernel instance used to bootstrap the application.

For more information see Application Service Kernel documentation.

getBase

Returns the base public controller directory.

This strips the controller script name from SCRIPT_NAME and normalizesthe path using forward slashes.

public static getBase(): string

Return Value:

string - Return the base path ending with a forward slash (e.g. /, /admin/).

toAbsoluteUrl

Convert a relative path to a full absolute URL.

Automatically removes system-relative parts like public/, and resolves base URLbased on the current environment (development vs production).

public static toAbsoluteUrl(string $path): string

Parameters:

Return Value:

string - Return fully qualified URL.

getUriSegments

Get the request url segments as relative.

Resolves the request URI as a relative path, without query string or base path.

public static getUriSegments(): string

Return Value:

string - Return the normalized URI segment path (e.g., /products/view/10)

getSegments

Get the URI segments as an array.

Splits the request URI into individual segments.Automatically removes the "public" prefix if it appears at the start of the URI.

public static getSegments(): array<int,string>

Return Value:

array<int,string> - Return an array of URI segments.

Examples:

• URI /public/foo/bar → Returns ['foo', 'bar']
• URI /public → Returns ['']
• URI /products/view/10 → Returns ['products', 'view', '10']
• URI / → Returns ['']

getCacheId

Generate a unique URL based cache key for the current request.

This method creates a normalized identifier for caching based on:

• The HTTP request method (GET, POST, etc.).
• The request URI (path and optionally query parameters).
• Stripping file extensions for static cache formats if configured.
• Replacing special URL characters with dashes for safe storage.

The resulting string is hashed with MD5 to produce a fixed-length cache ID.

public static getCacheId(?string $salt = null, ?bool $uriQuery = null): string

Parameters:

Return Value:

string - Return a unique MD5 hash representing the cache ID for this request.

isApiPrefix

Determine whether the current request targets the API.

A request is considered an API call if the first URI segment matches the configured API prefix (e.g, /api, public/api, a custom prefix from env(app.api.prefix)), or when enabled and request is an XMLHttpRequest.

public static isApiPrefix(?bool $ajaxAsApi = null): bool

Parameters:

Return Value:

bool - Returns true if the request matches the API prefix or qualifies as an AJAX request when enabled.

isCommand

Determines if the application is running in CLI (Command-Line Interface) mode.

public static isCommand(): bool

Return Value:

bool - Return true if running via CLI; false if it's a web request.

isCallable

Check if the given input can be called as a function or method.

This method detects standard callables, closures, function names, and array-style class/method pairs. If $strict is true, it will also verify that the class in an array callable exists.

public static isCallable(mixed $input, bool $strict = false): bool

Parameters:

Return Value:

bool - Return true if the input is callable, false otherwise.

trimSystemPath

Trim a file path to start from a known system directory.

This method removes any leading path segments before the first recognizedsystem directory (e.g., app, system). It's useful for hiding sensitiveserver directories when displaying errors, logs, or debugging information.

The returned path will always start from the first matched system directory.If no system directory is found in the path, the original path is returned.

public static trimSystemPath(string $path): string

Parameters:

Return Value:

string - Return the trimmed path starting from a known system directory, or the original path if no match is found.

permission

Check if file has read or write permission is granted.

public static permission(string $permission = 'rw', ?string $file = null, bool $throw = 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.

isPropertyExists

Check whether a class or object has a property, with optional static-only filtering.

Uses ReflectionClass when $staticOnly is true to determine if a property is declared as static.For general use, it falls back to property_exists() for better performance.

public static isPropertyExists(class-string|object $objectOrClass, string $property, bool $staticOnly = false): bool

Parameters:

Return Value:

bool - Returns true if the property exists (and is static if required), false otherwise.

getClassBaseName

Get the base class name(s) from fully qualified class name(s).

Accepts:

• A single fully qualified class name (FQCN), e.g. App\Controllers\HomeController
• A comma-separated string of FQCNs, e.g. App\Models\User, App\Services\Log
• An array of FQCNs

Returns the base class name(s) while preserving the input format:

• Single string input → returns a single string
• Comma-separated string → returns a comma-separated string
• Array → returns an array of base names

public static getClassBaseName(array|string $class): array|string

Parameters:

Return Value:

string - Return base class name(s), format matches the input.

Examples:

Luminova::getClassBaseName('\App\Controllers\HomeController'); 
// Returns: 'HomeController'

Luminova::getClassBaseName('App\Models\User, App\Services\Log'); 
// Returns: 'User, Log'

Luminova::getClassBaseName(['App\Models\User', 'App\Services\Log']); 
// Returns: ['User', 'Log']