PHP Luminova: Base Class for Application Configuration Classes
Base configuration serves as an underlying of your application configuration classes, which may be required by the framework depending on the component used in your application.
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 namespace:
\Luminova\Base\BaseConfig
- This class is an Abstract class
Usages
Bellow is an example how you can extend the BaseConfig
class.
<?php
namespace App\Utils;
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.
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:
Parameter | Type | Description |
---|---|---|
$key | string | The environment variable key to retrieve. |
$default | mixed | The default value to return if the key is not found. |
$return | string|null | The expected return type. Can be one of: |
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
.
removeCsp
Remove a directive from the Content-Security-Policy (CSP).
public removeCsp(string $directive): self
Parameters:
Parameter | Type | Description |
---|---|---|
$directive | string | The CSP directive to remove. |
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:
Parameter | Type | Description |
---|---|---|
$id | string | The CSP element identifier (default: none). |
Return Value:
string
- Returns the <meta>
tag with the CSP as the content.
getCspHeader
Send the Content-Security-Policy (CSP) as an HTTP header.
public getCspHeader(): void