This document discusses best practices for managing configuration in Symfony projects. It recommends building a configuration tree structure to define the configuration format and validate user input. The Symfony Config Component helps locate, load, and validate configuration to integrate it into the dependency injection container. Tests can validate that configuration is processed correctly.

2. I love my
http://www.flickr.com/photos/slushpup/3055613967/

3. Dennis Benkert
Software Developer
Coding
Consulting
Coaching
Symfony User Groups
Symfony Day Cologne

4. What mom never told you about
Bundle configurations

7. parameters:
global.page_size: 10
gloabl.page_num: 5
global.tracking.key: Correct type?
ASFDIPSADPFIHwer234123QSD
# Various configuration
webservices.timeout: 100
content_check.enabled: true
birthdates.start: 1950 # TODO: Delete after release
logging.registrations: true
# Tracking Bundle Configuration
trackingbundle.user: rebum Only this bundle?!
trackingbundle.api.version: 1_0
trackingbundle.use_ssl: true # Do not touch this!!!
trackingbundle.track_super_users: false
infobundle.god_mode: true # Ticket 123456234
infobundle.level: 42
# Connection data for some service
some_webservice.url: http://example.com
some_webservice.user: api Multiple connections?!
some_webservice.key: Sdfihwef $5sdf” SAFAWEF
some_webservice.ssl: true

8. my_project_tracking:
user: rebum
api_version: 1_0
use_ssl: true # Do not touch this!!!
track_super_users: false
my_project_info:
god_mode: true # Ticket 123456234
level: 42
my_project_ webservice:
connection:
url: http://example.com
user: api
key: Sdfihwef $5sdf” SAFAWEF
ssl: true
parameters:
global.page_size: 10
gloabl.page_num: 5
global.tracking.key: ASFDIPSADPFIHwer234123QSD
# ...

9. Bad configuration
Worse than bad code

10. Bad validation
Even worse

11. Config Component
http://www.flickr.com/photos/capcase/2735500813/

12. Cache Locate
Config
Validate Load

13. Cache Locate
Config
Validate Load

14. Locate & Load
http://www.flickr.com/photos/onthespiral/3406281939/

15. $locator = new FileLocator(
__DIR__.'/../Resources/config'
);
Path(s) of resources

16. Available in path(s)?
$locator->locate('config.xml');

17. // src/YourBundle/DependencyInjection/
// YourBundleExtension.php
Special Loader for DIC
$loader = new LoaderXmlFileLoader(
$container,
new FileLocator('...')
);
Path(s) of resources

18. Load configuration in DIC
$loader->load('services.xml');

19. $loader->load('services.xml');
$loader->load('other_services.xml');

20. Cache Locate
Config
Validate Load

21. Validate
http://www.flickr.com/photos/jeremybrooks/3214838875/

22. your_bundle:
enabled: true

23. // src/YourBundle/DependencyInjection/
// YourBundleExtension.php
public function load($configs, /*...*/)
{
// processing and unprocessed
Matched ...
if (true === $config['enabled']) {
$loader->load('services.xml');
} Processed and validated
}

24. your_bundle:
enabled: true
Validate
Convert
array('enabled' => true);

25. Build a Config Tree
http://www.flickr.com/photos/jlscha/6226656013/

26. // src/YourBundle/DependencyInjection/
// Configuration.php
The config tree
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder
->root('your_bundle');
// tree definition ...
Your root node
return $treeBuilder;
}

27. your_bundle:
enabled: true

28. $rootNode Node type Node name
->children()
->booleanNode('enabled')
->defaultFalse()
->end()
->end() More options
;

29. Scalar
Boolean Array
Node

30. Scalar
Boolean Array
Node

31. ->booleanNode('enabled')->end()

32. your_bundle:
enabled: troo

33. Type validation

34. Scalar
Boolean Array
Node

35. your_bundle:
timeout: 60

36. All scalar types
->scalarNode('timeout')
->defaultValue(3600)
->isRequired()
->cannotBeEmpty()
->end()
Validation options

37. your_bundle:
timeout: sixty seconds

38. ->scalarNode('timeout')
Custom validation
// ... Validation logic
->validate()
->ifTrue(function ($v) {
return !is_int($v);
})
->thenInvalid('No integer')
->end()
->end() Custom error

39. Custom error

40. Scalar
Boolean Array
Node

41. connection:
url: http://example.com
user: api
key: $ome35ecre7Ke$

42. Group of nodes
->arrayNode('connection')
->children() Specific validation
->scalarNode('url')
->isRequired()
->end()
->scalarNode('user')->end()
->scalarNode('key')->end()
->end()
->end()

43. array('connection' =>
array(
'url' => 'http://example.com',
'user' => 'api',
'key' => '$ome35ecre7Ke$'
)
);

44. connections:
default:
url: http://example.com
user: api
key: $ome35ecre7Ke$
fallback:
url: http://back.example.com
user: fallback_api
key: $ome35ecre7Ke$

45. ->arrayNode('connections')
Prototype variations
->useAttributeAsKey('name')
->prototype('array')
->children() Key generation
->scalarNode('url')
->isRequired()
->end()
->scalarNode('user')->end()
->scalarNode('key')->end()
->end() validation
Prototype
->end()
->requiresAtLeastOneElement()
->end()

46. array (
'connections' => array (
'default' => array (
'url' => '...',
'user' => 'api',
'key' => '$ome35ecre7Ke$'
),
'fallback' => array (
'url' => '...',
'user' => 'fallback_api',
'key' => '$ome35ecre7Ke$'
)
));

47. Build upon structure
http://www.flickr.com/photos/victornuno/222145881/

48. // src/YourBundle/DependencyInjection/
// YourBundleExtension.php
public function load(/*...*/)
Load services
{
if (true === $config['enabled']) {
$loader->load('services.xml');
}
}

49. public function load(/*...*/)
{
if (true === $config['enabled']) {
$loader->load('services.xml');
} Split services
if (true === $config['add_extras']) {
$loader->load('extras.xml');
}
}

50. Manipulate DIC
$container->setParameter(
'your_bundle.timeout',
$config['timeout']
);

51. Testing Configuration
http://www.flickr.com/photos/sidelong/246816211/

52. Get DIC
$container =Extension
Register your $this->createContainer();
$container->registerExtension( Extension
Load your
new YourBundleExtension());
$container->loadFromExtension(
Process configuration array());
'your_bundle',
$this->compileContainer($container);

53. $this->assertTrue(
$container->getParameter('enabled')
);

54. /** Custom error
* @expectedException Exception
* @expectedMessage No integer
*/
public function testConfiguration()
{}

55. Let‘s recap
http://www.flickr.com/photos/tine72/5464869042/

56. Configuration
needs structure

57. Configuration
needs validation

58. Configuration
needs conversion

59. Config Component
is awesome