App configuration

Startup configuration

All the configuration for the Dominus framework is stored in the startup.php file found in the project root.

Here you can register global middleware, execute your own boot-up logic and overwrite core functionality like the log function.

Check the base class Dominus\System\DominusConfiguration to see the different methods that you can override.

Environment configuration

It is often helpful to have different configuration values based on the environment where your application is running.

Dominus uses .env files to achieve this.

Custom .env loader

Dominus ships with its own .env file loader, but you can always use your own.

To achieve this, simply override the public static function loadDotEnv(): void method from the DominusConfiguration base class and load the .env files there, make sure the loaded environment variables are stored in the $_SERVER global variable.

Retrieving environment configuration values

All the variables listed in the .env file will be loaded into the $_ENV PHP super-global when your application receives a request. However, you may use the env function to retrieve values from these variables in your configuration files:

<?php
echo env('APP_NAMESPACE', 'DefaultNamespace\\');

The second value passed to the env function is the default value. This value will be returned if no environment variable exists for the given key.

Dominus configuration

The default .env file contains some common configuration values that you may want to change, depending on yor needs, below is a list of the default environment variables and what they represent.

General

Key	Default value	Description
APP_ENV	dev	The current running 'mode' of your application.
APP_HANDLE_ERRORS	1	Whether the app will automatically log any app errors and disable the default php error handler. Possible values: 0 or 1
APP_LOG_TO_FILE	1	Whether the app should write logs to file (csv).
APP_LOG_FILE_LOCATION		Path to the directory where the app will write all log csv files. If empty the default path will be used: PROJECT_ROOT/Logs
APP_LOG_FILE_NAME_PATTERN	dominus-log-{date}	The filename pattern used when creating the log files. Possible placeholders: {date}
APP_DISPLAY_LOGS	1	Whether to print logged messages. Only works if APP_ENV is set to dev. Possible values: 0 or 1
APP_DISPLAY_LOG_TYPES	WARNING,ERROR	#Comma separated values. Possible values: INFO, WARNING, ERROR
APP_NAMESPACE	App\	#Namespace under which your modules are created. Trailing \ is required!

Database connections

Add new connections as DB_(CONNECTION_ALIAS)_* Example:

DB_MY_ALIAS_DSN="mysql:host=db;port=3306;dbname=myDatabase"
DB_MY_ALIAS_USERNAME="user"
DB_MY_ALIAS_PASSWORD="pass"

Key	Default value	Description
DB_(CONNECTION_ALIAS)_DSN		DSN used for this connection alias
DB_(CONNECTION_ALIAS)_USERNAME
DB_(CONNECTION_ALIAS)_PASSWORD

Dominus Services

Key	Default value	Description
SERVICES_HTTP_CONNECTION_TIMEOUT	30	Maximum number of seconds that the connection can stay open (execution time)
SERVICES_HTTP_CONNECT_TIMEOUT	30	The number of seconds to wait while trying to connect. Use 0 to wait indefinitely.
SERVICES_HTTP_USERAGENT	Dominus API
SERVICES_HTTP_SSL_VERIFY_HOST	true
SERVICES_HTTP_SSL_VERIFY_PEER	true

Dominus .env loader

Dominus ships with a custom-built .env loader with reduced features to focus on loading the .env files as fast as php allows.

One feature that is implemented is allowing importing of other .env files, this may be useful if you want to have a common .env base and have the sensitive information in its own separate .env.secrets file for example.

Importing other .env files is done by using the @import keyword, followed by a space then the relative path to the .env file you want to import, like so: @import .env.secrets.