-<?php
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys UserBundle package.
+ *
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
namespace Rapsys\UserBundle\DependencyInjection;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Rapsys\UserBundle\RapsysUserBundle;
+
/**
* This is the class that validates and merges configuration from your app/config files.
*
- * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
+ * @link http://symfony.com/doc/current/cookbook/bundles/configuration.html
+ *
+ * {@inheritdoc}
*/
class Configuration implements ConfigurationInterface {
/**
* {@inheritdoc}
*/
- public function getConfigTreeBuilder() {
+ public function getConfigTreeBuilder(): TreeBuilder {
//Set tree builder
- $treeBuilder = new TreeBuilder('rapsys_user');
+ $treeBuilder = new TreeBuilder(RapsysUserBundle::getAlias());
//The bundle default values
$defaults = [
'user' => 'Rapsys\\UserBundle\\Entity\\User'
],
'default' => [
+ 'admin' => 'ROLE_ADMIN',
'civility' => 'Mister',
'group' => [ 'User' ]
],
'route' => [
+ 'confirm' => [
+ 'name' => 'rapsys_user_confirm',
+ 'context' => []
+ ],
+ 'edit' => [
+ 'name' => 'rapsys_user_edit',
+ 'context' => []
+ ],
'index' => [
'name' => 'rapsys_user_index',
'context' => []
'name' => 'rapsys_user_recover',
'context' => []
],
- 'recover_mail' => [
- 'name' => 'rapsys_user_recover_mail',
- 'context' => []
- ],
'register' => [
'name' => 'rapsys_user_register',
'context' => []
]
],
'translate' => [],
- 'locales' => '%kernel.translator.fallbacks%',
'languages' => [
- 'en' => 'English'
+ 'en_gb' => 'English'
],
'contact' => [
- 'name' => 'John Doe',
- 'mail' => 'contact@example.com'
+ 'address' => 'contact@example.com',
+ 'name' => 'John Doe'
+ ],
+ 'context' => [],
+ 'edit' => [
+ 'admin' => ['mail' => true, 'pseudonym' => true],
+ 'field' => [],
+ 'route' => ['index' => 'index_url'],
+ 'view' => [
+ 'name' => '@RapsysUser/form/register.html.twig',
+ 'edit' => 'Rapsys\UserBundle\Form\EditType',
+ 'reset' => 'Rapsys\UserBundle\Form\ResetType',
+ 'context' => []
+ ]
+ ],
+ 'index' => [
+ 'route' => ['index' => 'index_url'],
+ 'view' => [
+ 'name' => '@RapsysUser/form/index.html.twig',
+ 'context' => []
+ ]
],
'login' => [
'route' => ['index' => 'index_url'],
]
],
'recover' => [
- 'route' => ['index' => 'index_url', 'recover_mail' => 'recover_url'],
+ 'route' => ['index' => 'index_url', 'recover' => 'recover_url'],
'view' => [
'name' => '@RapsysUser/form/recover.html.twig',
'form' => 'Rapsys\UserBundle\Form\RecoverType',
'context' => []
]
],
- 'recover_mail' => [
- 'route' => ['index' => 'index_url', 'recover_mail' => 'recover_url'],
- 'view' => [
- 'name' => '@RapsysUser/form/recover_mail.html.twig',
- 'form' => 'Rapsys\UserBundle\Form\RecoverMailType',
- 'context' => []
- ],
- 'mail' => [
- 'subject' => 'Welcome back!',
- 'html' => '@RapsysUser/mail/recover_mail.html.twig',
- 'text' => '@RapsysUser/mail/recover_mail.text.twig',
- 'context' => []
- ]
- ],
'register' => [
- 'route' => ['index' => 'index_url'],
+ 'admin' => [],
+ 'field' => [],
+ 'route' => ['index' => 'index_url', 'confirm' => 'confirm_url'],
'view' => [
- 'form' => 'Rapsys\UserBundle\Form\RegisterType',
'name' => '@RapsysUser/form/register.html.twig',
+ 'form' => 'Rapsys\UserBundle\Form\RegisterType',
'context' => []
],
'mail' => [
]
];
- //Here we define the parameters that are allowed to configure the bundle.
- //TODO: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
- //TODO: see http://symfony.com/doc/current/components/config/definition.html
- //TODO: see fosuser DependencyInjection/Configuration.php
- //XXX: use bin/console config:dump-reference to dump class infos
-
- //Here we define the parameters that are allowed to configure the bundle.
+ /**
+ * Defines parameters allowed to configure the bundle
+ *
+ * @link https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
+ * @link http://symfony.com/doc/current/components/config/definition.html
+ * @link https://github.com/symfony/assetic-bundle/blob/master/DependencyInjection/Configuration.php#L63
+ *
+ * @see php bin/console config:dump-reference rapsys_user to dump default config
+ * @see php bin/console debug:config rapsys_user to dump config
+ */
$treeBuilder
//Parameters
->getRootNode()
->addDefaultsIfNotSet()
->children()
->arrayNode('class')
- ->addDefaultsIfNotSet()
- ->children()
- ->scalarNode('group')->cannotBeEmpty()->defaultValue($defaults['class']['group'])->end()
- ->scalarNode('civility')->cannotBeEmpty()->defaultValue($defaults['class']['civility'])->end()
- ->scalarNode('user')->cannotBeEmpty()->defaultValue($defaults['class']['user'])->end()
- ->end()
+ ->treatNullLike([])
+ ->defaultValue($defaults['class'])
+ ->scalarPrototype()->end()
->end()
->arrayNode('default')
->addDefaultsIfNotSet()
->children()
+ ->scalarNode('admin')->cannotBeEmpty()->defaultValue($defaults['default']['admin'])->end()
->scalarNode('civility')->cannotBeEmpty()->defaultValue($defaults['default']['civility'])->end()
->arrayNode('group')
- ->treatNullLike(array())
+ ->treatNullLike([])
->defaultValue($defaults['default']['group'])
->scalarPrototype()->end()
->end()
->arrayNode('route')
->addDefaultsIfNotSet()
->children()
+ ->arrayNode('confirm')
+ ->addDefaultsIfNotSet()
+ ->children()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['confirm']['name'])->end()
+ ->arrayNode('context')
+ ->treatNullLike([])
+ ->defaultValue($defaults['route']['confirm']['context'])
+ ->scalarPrototype()->end()
+ ->end()
+ ->end()
+ ->end()
->arrayNode('index')
->addDefaultsIfNotSet()
->children()
->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['index']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
+ ->treatNullLike([])
->defaultValue($defaults['route']['index']['context'])
->scalarPrototype()->end()
->end()
->end()
->end()
- ->arrayNode('login')
+ ->arrayNode('edit')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['login']['name'])->end()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['edit']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['route']['login']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['route']['edit']['context'])
->scalarPrototype()->end()
->end()
->end()
->end()
- ->arrayNode('recover')
+ ->arrayNode('login')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['recover']['name'])->end()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['login']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['route']['recover']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['route']['login']['context'])
->scalarPrototype()->end()
->end()
->end()
->end()
- ->arrayNode('recover_mail')
+ ->arrayNode('recover')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['recover_mail']['name'])->end()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['recover']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['route']['recover_mail']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['route']['recover']['context'])
->scalarPrototype()->end()
->end()
->end()
->children()
->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['register']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
+ ->treatNullLike([])
->defaultValue($defaults['route']['register']['context'])
->scalarPrototype()->end()
->end()
->end()
->end()
->arrayNode('translate')
- ->treatNullLike(array())
+ ->treatNullLike([])
->defaultValue($defaults['translate'])
->scalarPrototype()->end()
->end()
- ->scalarNode('locales')->cannotBeEmpty()->defaultValue($defaults['locales'])->end()
+ #TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
->arrayNode('languages')
->treatNullLike([])
->defaultValue($defaults['languages'])
->arrayNode('contact')
->addDefaultsIfNotSet()
->children()
+ ->scalarNode('address')->cannotBeEmpty()->defaultValue($defaults['contact']['address'])->end()
->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['contact']['name'])->end()
- ->scalarNode('mail')->cannotBeEmpty()->defaultValue($defaults['contact']['mail'])->end()
->end()
->end()
- ->arrayNode('login')
+ ->arrayNode('context')
+ ->treatNullLike([])
+ ->defaultValue($defaults['context'])
+ ->variablePrototype()->end()
+ ->end()
+ ->arrayNode('edit')
->addDefaultsIfNotSet()
->children()
+ ->arrayNode('admin')
+ ->treatNullLike([])
+ ->defaultValue($defaults['edit']['admin'])
+ ->variablePrototype()->end()
+ ->end()
+ ->arrayNode('field')
+ ->treatNullLike([])
+ ->defaultValue($defaults['edit']['field'])
+ ->variablePrototype()->end()
+ ->end()
->arrayNode('route')
- ->treatNullLike(array())
- ->defaultValue($defaults['login']['route'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['edit']['route'])
->scalarPrototype()->end()
->end()
->arrayNode('view')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['login']['view']['name'])->end()
- ->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['login']['view']['form'])->end()
+ ->scalarNode('edit')->cannotBeEmpty()->defaultValue($defaults['edit']['view']['edit'])->end()
+ ->scalarNode('reset')->cannotBeEmpty()->defaultValue($defaults['edit']['view']['reset'])->end()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['edit']['view']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['login']['view']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['edit']['view']['context'])
->variablePrototype()->end()
->end()
->end()
->end()
->end()
->end()
- ->arrayNode('recover')
+ ->arrayNode('index')
->addDefaultsIfNotSet()
->children()
->arrayNode('route')
- ->treatNullLike(array())
- ->defaultValue($defaults['recover']['route'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['index']['route'])
->scalarPrototype()->end()
->end()
->arrayNode('view')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['recover']['view']['name'])->end()
- ->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['recover']['view']['form'])->end()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['index']['view']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['recover']['view']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['index']['view']['context'])
->variablePrototype()->end()
->end()
->end()
->end()
- ->arrayNode('mail')
+ ->end()
+ ->end()
+ ->arrayNode('login')
+ ->addDefaultsIfNotSet()
+ ->children()
+ ->arrayNode('route')
+ ->treatNullLike([])
+ ->defaultValue($defaults['login']['route'])
+ ->scalarPrototype()->end()
+ ->end()
+ ->arrayNode('view')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('subject')->cannotBeEmpty()->defaultValue($defaults['recover']['mail']['subject'])->end()
- ->scalarNode('html')->cannotBeEmpty()->defaultValue($defaults['recover']['mail']['html'])->end()
- ->scalarNode('text')->cannotBeEmpty()->defaultValue($defaults['recover']['mail']['text'])->end()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['login']['view']['name'])->end()
+ ->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['login']['view']['form'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['recover']['mail']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['login']['view']['context'])
->variablePrototype()->end()
->end()
->end()
->end()
->end()
->end()
- ->arrayNode('recover_mail')
+ ->arrayNode('recover')
->addDefaultsIfNotSet()
->children()
->arrayNode('route')
- ->treatNullLike(array())
- ->defaultValue($defaults['recover_mail']['route'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['recover']['route'])
->scalarPrototype()->end()
->end()
->arrayNode('view')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['recover_mail']['view']['name'])->end()
- ->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['recover_mail']['view']['form'])->end()
+ ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['recover']['view']['name'])->end()
+ ->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['recover']['view']['form'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['recover_mail']['view']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['recover']['view']['context'])
->variablePrototype()->end()
->end()
->end()
->arrayNode('mail')
->addDefaultsIfNotSet()
->children()
- ->scalarNode('subject')->cannotBeEmpty()->defaultValue($defaults['recover_mail']['mail']['subject'])->end()
- ->scalarNode('html')->cannotBeEmpty()->defaultValue($defaults['recover_mail']['mail']['html'])->end()
- ->scalarNode('text')->cannotBeEmpty()->defaultValue($defaults['recover_mail']['mail']['text'])->end()
+ ->scalarNode('subject')->cannotBeEmpty()->defaultValue($defaults['recover']['mail']['subject'])->end()
+ ->scalarNode('html')->cannotBeEmpty()->defaultValue($defaults['recover']['mail']['html'])->end()
+ ->scalarNode('text')->cannotBeEmpty()->defaultValue($defaults['recover']['mail']['text'])->end()
->arrayNode('context')
- ->treatNullLike(array())
- ->defaultValue($defaults['recover_mail']['mail']['context'])
+ ->treatNullLike([])
+ ->defaultValue($defaults['recover']['mail']['context'])
->variablePrototype()->end()
->end()
->end()
->arrayNode('register')
->addDefaultsIfNotSet()
->children()
+ ->arrayNode('admin')
+ ->treatNullLike([])
+ ->defaultValue($defaults['edit']['admin'])
+ ->variablePrototype()->end()
+ ->end()
+ ->arrayNode('field')
+ ->treatNullLike([])
+ ->defaultValue($defaults['register']['field'])
+ ->variablePrototype()->end()
+ ->end()
->arrayNode('route')
- ->treatNullLike(array())
+ ->treatNullLike([])
->defaultValue($defaults['register']['route'])
->scalarPrototype()->end()
->end()
->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['register']['view']['form'])->end()
->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['register']['view']['name'])->end()
->arrayNode('context')
- ->treatNullLike(array())
+ ->treatNullLike([])
->defaultValue($defaults['register']['view']['context'])
->variablePrototype()->end()
->end()
->scalarNode('html')->cannotBeEmpty()->defaultValue($defaults['register']['mail']['html'])->end()
->scalarNode('text')->cannotBeEmpty()->defaultValue($defaults['register']['mail']['text'])->end()
->arrayNode('context')
- ->treatNullLike(array())
+ ->treatNullLike([])
->defaultValue($defaults['register']['mail']['context'])
->variablePrototype()->end()
->end()
Rapsys Git / userbundle / blobdiff