Configuration

All configuration is defined in Yaml files. The core configuration is stored in the /etc/config/ folder. Your application's configuration is stored in the /app/ folder, or in specified subfolders.

Basic setup

The basic app configuration setup is as below. Place these yaml files in the etc/config/ directory of your project. The configuration comes with four configuration files which are necessary. Security (security.yaml), Runtime (runtime.yaml) will be preset for you and you don't need to change anything here if there's no need.

app.yaml

app:

# App name

name: Foo Bar App

# App mode (either develop or production)

mode: develop

# Enable/disable debug mode

debug: true

# Allow cross-origin requests (returns 200 response for OPTIONS Request if no Route is matched)

allow_cors: true

# Default application timezone

timezone: Europe/Amsterdam

routing:

# Base url used in route matching. This is also useful on subdomains

baseurl: foo.bar.com

graphql:

# Enable/disable graphql

enabled: true

# Enable/disable introspection for graphql

enable_introspection: true

max_query_complexity: 120

max_query_depth: 10

logging:

# Enable/disable mails for logger

enable_mail: true

# Mail from address

logging_mail_from: log@foo-bar.com

# Mail to address

logging_mail_to: log@foo-bar.com

database.yaml

For more on the actual working of this, see the Database component.

connection:

driver: mysql

engine: InnoDB

host: localhost

username: root

password: ''

database: foo_bar

port: 3306

prefix: 4593g_

security.yaml

For more on the actual working of this, see the Security component.

enable_firewalls: true

firewalls:

main:

# limit login attempts, defaults to 5 per minute. Set to 0 to disable throttling

login_throttling:

max_attempts: 5

role_hierarchy:

ROLE_GUEST:

ROLE_USER:

ROLE_CLIENT: ['ROLE_USERS_LIST']

ROLE_ADMIN: ['ROLE_USERS_LIST']

ROLE_SUPER_ADMIN: ['ROLE_ADMIN']

access_decision_manager:

strategy: Swift\Security\Authorization\Strategy\AffirmativeDecisionStrategy

allow_if_all_abstain: false

graphql_access_control:

- { name: SecurityUser, fields: [ lastname ], roles: [ ROLE_USER, ROLE_FOO ] }

- { name: SecurityUsersCredential, fields: [ ], roles: [ ROLE_USER, ROLE_FOO ] }

rate_limit:

enabled: true

enable_default: true

default_limit: 10

default_period: 60

default_strategy: sliding_window

rates:

- { name: foo_bar, strategy: sliding_window, limit: 30, period: 60 }

runtime.yaml

For more on the actual working of this, see the Runtime component.

runtime:

enabled: true

coroutines:

enabled: true

run_in_background: true

cron:

enabled: true

run_in_background: true

file_watcher:

enabled: true

watch: [services.yaml, app, etc/config]

extensions: [php, yaml]

ignore: [tests]

websocket:

port: 8000

Configuration scopes

To organize configuration, this is split in into different categories called 'scopes'.

By default, there are three of those:

• app (etc/config/app.yaml)
• database (etc/config/database.yaml)
• security (etc/config/security.yaml)

All three scopes have their own drivers, but they're all available through the generic Configuration Swift\Configuration\ConfigurationInterface.

Defining custom configuration

It is highly likely that you might have the need for custom/additional configuration. This is easily possible. Swift checks the app directory for a config.yaml file. If it is present use it import app configuration files. See the example below.

app/config.yaml

imports:

- { resource: app/Foo/config.yaml }

Now let's add some configuration in there.

app/Foo/config.yaml

foo:

bar: example

lorem: ipsum

Reading the configuration

To read the configuration you will have to inject the Swift\Configuration\Configuration class (or Swift\Configuration\ConfigurationInterface $configuration). Simply calling the 'get' method is enough. The first argument is the name of the setting and the second one is the scope. Reading the app configuration uses the 'app' as scope.

// Get foo bar value from the example above

$fooBarConfigurationValue = $this->configuration->get('foo.bar', 'app/Foo');

// Check if app is in debug mode

$isDebug = $this->configuration->get('app.debug', 'app');

// Database username

$databaseUsername = $this->configuration->get('connection.username', 'database');

Writing the configuration

Writing the configuration works in the exact same matter. Note that is not possible to write to non-existing settings. Make sure the setting you're trying to write is defined on beforehand.

// Write to the previous foo.bar example

$this->configuration->set('foo.bar', 'writing example', 'app/Foo');

Writing configuration to the file system

Note that writing the configuration as above will not write the configuration to the file system right away. This is because the configuration is cached in memory. Only when the Kernel is shutting down, the configuration be written to the file system. Therefore, it's important to correctly terminate the application.

Extending the core configuration (Configuration Sub Scopes)

It is possible to extend the core configuration. This is done by creating a new configuration scope. The scope name is the name of the configuration sub scope. The configuration sub scope is a sub scope of the core configuration. This is useful when extending the core functionality. To create a new configuration sub scope, you need to create a new class that implements the Swift\Configuration\ConfigurationSubScopeInterface. See the example below. This way we can inject additional configuration into the existing core configuration.

<?php declare( strict_types=1 );

namespace Swift\GraphQl\Configuration;

class AppConfiguration implements \Swift\Configuration\ConfigurationSubScopeInterface {

public function getScope(): array {

return [ 'app', 'root' ];

}

public function getConfigTreeBuilder( \Symfony\Component\Config\Definition\Builder\NodeBuilder $builder ): \Symfony\Component\Config\Definition\Builder\NodeBuilder {

$builder

->arrayNode('graphql')

->children()

->booleanNode('enabled')->defaultTrue()->end()

->booleanNode('enable_introspection')->defaultTrue()->end()

->end()

->end();

return $builder;

}

public function getDefaultValues(): array {

return [

'graphql' => [

'enabled' => true,

'enable_introspection' => true,

],

];

}

}