PHP Luminova: Base Class for Application Configuration Classes

The base configuration service as the foundation of your application's configuration classes, which are essential for the framework depending on the components utilized in your application. To create a new configuration class, you need to extend and define necessary properties and method as you need.

Class Declaration

• Class namespace: \Luminova\Base\BaseConfig
• This class is an Abstract class
• This class implements: \Luminova\Interface\LazyInterface

Usages

Bellow is an example how you can extend the BaseConfig class.

// app/Config/Config.php
<?php 
namespace App\Config;

use \luminova\Base\BaseConfig;

class Config extends BaseConfig 
{
    public const MY_VAR = 'var';
}

Now you can import your configuration class anywhere you would like to use it or register in service to make it available anywhere.

Properties

File extensions based on MIME types. Where the key is the MIME type and the value is the extension.

protected static array $extensions = [
    'image/jpeg' => 'jpg',
    'image/png' => 'png',
    // ...
];

Note: Only define this property in App\Config\Files class.

Methods

getEnv

An alternative to the global helper function env, the getEnv method allows you to retrieve an environment variable with a specific return type.

final public static getEnv(string $key, mixed $default = null, string|null $return = null): mixed

Parameters:

Return Value:

mixed - Returns the environment variable cast to the specified type, or default if not found.

Supported Return Types:

• bool.
• int.
• float.
• double.
• nullable.
• string.

getNonce

Generate or retrieve a nonce with an optional prefix.

final public static getNonce(int $length = 16, string $prefix = ''): string

Parameters:

Return Value:

string Return a cached generated nonce value.

removeCsp

Remove a directive from the Content-Security-Policy (CSP).

public removeCsp(string $directive): self

Parameters:

Return Value:

self - Returns the instance of configuration class.

clearCsp

Clear all directives from the Content-Security-Policy (CSP).

public clearCsp(): self

Return Value:

self - Returns the instance of configuration class.

getCsp

Build and return the Content-Security-Policy (CSP) as a string.

public getCsp(): string

Return Value:

string - Returns the CSP policy string in the correct format.

getCspMetaTag

Generate the <meta> tag for embedding the CSP in HTML documents.

public getCspMetaTag(string $id = ''): string

Parameters:

Return Value:

string - Returns the <meta> tag with the CSP as the content.

sendCspHeader

Send the Content-Security-Policy (CSP) as an HTTP header.

public sendCspHeader(): void

getExtension

Get the file extension based on the MIME type.

This function returns the appropriate file extension for a given MIME type. It first checks if the MIME type exists in the developer defined static $extensions array, and if not, it uses a match expression to determine the extension.

public static getExtension(string $mimeType): string 

Parameters:

Return Value:

string - Return the corresponding file extension (without the dot), or 'bin' if the MIME type is not recognized.

Example:

<?php
use App\Config\Files;

$file = 'path/to/file.png';

Files::getExtension(get_mime($file));