final class AppConfigDefinition extends AbstractConfigDefinition (View source)

Defines application-wide runtime values supplied by the host application.

Properties

protected mixed[] $data from  AbstractConfigDefinition

Methods

set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

create()

Creates an empty application configuration definition.

static string

Returns the configuration module key used by the application configuration resolver.

string
timezone(string|null $timezone)

Sets the default timezone for the application.

baseUrl(string|null $baseUrl)

Sets the public base URL of the application.

secret(string|null $secret)

Stores the application-wide secret consumed by framework security capabilities.

basePath(string $basePath)

Sets the absolute base path of the application.

env(string $environment)

Sets the current application environment name.

debug(bool $debug = true)

Enables or disables debug mode.

appPath(string $appPath)

Sets the absolute application source path.

configPath(string $configPath)

Sets the absolute application configuration path.

publicPath(string $publicPath)

Sets the absolute public web root path.

storagePath(string $storagePath)

Sets the absolute application storage path.

Details

toArray

No description

Return Value

array

fromArrayData

final static AbstractConfigDefinition fromArrayData(array $data)

No description

Parameters

array $data

Return Value

AbstractConfigDefinition

set

protected AbstractConfigDefinition set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

append

protected AbstractConfigDefinition append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

create

Creates an empty application configuration definition.

Return Value

AppConfigDefinition

moduleKey

static string moduleKey()

Returns the configuration module key used by the application configuration resolver.

Return Value

string

timezone

AppConfigDefinition timezone(string|null $timezone)

Sets the default timezone for the application.

Parameters

string|null $timezone

Return Value

AppConfigDefinition

baseUrl

AppConfigDefinition baseUrl(string|null $baseUrl)

Sets the public base URL of the application.

Parameters

string|null $baseUrl

Return Value

AppConfigDefinition

secret

AppConfigDefinition secret(string|null $secret)

Stores the application-wide secret consumed by framework security capabilities.

Parameters

string|null $secret

Return Value

AppConfigDefinition

basePath

AppConfigDefinition basePath(string $basePath)

Sets the absolute base path of the application.

Parameters

string $basePath

Return Value

AppConfigDefinition

env

AppConfigDefinition env(string $environment)

Sets the current application environment name.

Parameters

string $environment

Return Value

AppConfigDefinition

debug

AppConfigDefinition debug(bool $debug = true)

Enables or disables debug mode.

Parameters

bool $debug

Return Value

AppConfigDefinition

appPath

AppConfigDefinition appPath(string $appPath)

Sets the absolute application source path.

Parameters

string $appPath

Return Value

AppConfigDefinition

configPath

AppConfigDefinition configPath(string $configPath)

Sets the absolute application configuration path.

Parameters

string $configPath

Return Value

AppConfigDefinition

publicPath

AppConfigDefinition publicPath(string $publicPath)

Sets the absolute public web root path.

Parameters

string $publicPath

Return Value

AppConfigDefinition

storagePath

AppConfigDefinition storagePath(string $storagePath)

Sets the absolute application storage path.

Parameters

string $storagePath

Return Value

AppConfigDefinition