]> Raphaël G. Git Repositories - userbundle/blobdiff - DependencyInjection/Configuration.php
Add note about normalisation prevention
[userbundle] / DependencyInjection / Configuration.php
index 5ef87180a7fa221d328675c2116c91582f1da3b6..1dc51669a73fef32915335b81eb57f6977e06e31 100644 (file)
-<?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('parameters');
+               $treeBuilder = new TreeBuilder(RapsysUserBundle::getAlias());
 
                //The bundle default values
                $defaults = [
-                       'class' => [
+                       'class' => [
                                'group' => 'Rapsys\\UserBundle\\Entity\\Group',
-                               'title' => 'Rapsys\\UserBundle\\Entity\\Title',
+                               'civility' => 'Rapsys\\UserBundle\\Entity\\Civility',
                                'user' => 'Rapsys\\UserBundle\\Entity\\User'
                        ],
+                       'default' => [
+                               'civility' => 'Mister',
+                               'group' => [ 'User' ]
+                       ],
+                       'route' => [
+                               'confirm' => [
+                                       'name' => 'rapsys_user_confirm',
+                                       'context' => []
+                               ],
+                               'edit' => [
+                                       'name' => 'rapsys_user_edit',
+                                       'context' => []
+                               ],
+                               'index' => [
+                                       'name' => 'rapsys_user_index',
+                                       'context' => []
+                               ],
+                               'login' => [
+                                       'name' => 'rapsys_user_login',
+                                       'context' => []
+                               ],
+                               'recover' => [
+                                       'name' => 'rapsys_user_recover',
+                                       'context' => []
+                               ],
+                               'register' => [
+                                       'name' => 'rapsys_user_register',
+                                       'context' => []
+                               ]
+                       ],
+                       'translate' => [],
+                       'locales' => '%kernel.translator.fallbacks%',
+                       'languages' => [
+                               'en_gb' => 'English'
+                       ],
                        'contact' => [
-                               'name' => 'John Doe',
-                               'mail' => 'contact@example.com',
-                               'home_name' => 'rapsys_user_homepage',
-                               'home_args' => []
+                               'title' => 'John Doe',
+                               'mail' => 'contact@example.com'
                        ],
-                       'login' => [
-                               'template' => '@@RapsysUser/security/login.html.twig',
-                               'context' => []
+                       'context' => [],
+                       'edit' => [
+                               'field' => [],
+                               'route' => ['index' => 'index_url'],
+                               'view' => [
+                                       'name' => '@RapsysUser/form/register.html.twig',
+                                       'edit' => 'Rapsys\UserBundle\Form\RegisterType',
+                                       'reset' => 'Rapsys\UserBundle\Form\LoginType',
+                                       'context' => []
+                               ]
                        ],
-                       'register' => [
-                               'mail_template' => '@@RapsysUser/mail/register.html.twig',
-                               'mail_context' => [
-                                       'title' => 'Title',
-                                       'subtitle' => 'Hi, %%name%%',
-                                       'subject' => 'Welcome to %%title%%',
-                                       'message' => 'Thanks so much for joining us, from now on, you are part of %%title%%.'
-                               ],
-                               'template' => '@@RapsysUser/security/register.html.twig',
-                               'context' => []
+                       'login' => [
+                               'route' => ['index' => 'index_url'],
+                               'view' => [
+                                       'name' => '@RapsysUser/form/login.html.twig',
+                                       'form' => 'Rapsys\UserBundle\Form\LoginType',
+                                       'context' => []
+                               ]
                        ],
                        'recover' => [
-                               'mail_template' => '@@RapsysUser/mail/recover.html.twig',
-                               'mail_context' => [
-                                       'title' => 'Title',
-                                       'subtitle' => 'Hi, %%name%%',
-                                       'subject' => 'Recover account on %%title%%',
-                                       'raw' => 'Thanks so much for joining us, to recover your account you can follow this link: <a href="%%url%%">%%url%%</a>'
+                               'route' => ['index' => 'index_url', 'recover' => 'recover_url'],
+                               'view' => [
+                                       'name' => '@RapsysUser/form/recover.html.twig',
+                                       'form' => 'Rapsys\UserBundle\Form\LoginType',
+                                       'context' => []
                                ],
-                               'url_name' => 'rapsys_user_recover_mail',
-                               'url_args' => [],
-                               'template' => '@@RapsysUser/security/recover.html.twig',
-                               'context' => []
+                               'mail' => [
+                                       'subject' => 'Welcome back!',
+                                       'html' => '@RapsysUser/mail/recover.html.twig',
+                                       'text' => '@RapsysUser/mail/recover.text.twig',
+                                       'context' => []
+                               ]
                        ],
-                       'recover_mail' => [
-                               'mail_template' => '@@RapsysUser/mail/recover.html.twig',
-                               'mail_context' => [
-                                       'title' => 'Title',
-                                       'subtitle' => 'Hi, %%name%%',
-                                       'subject' => 'Account recovered on %%title%%',
-                                       'raw' => 'Your account password has been changed, to recover your account you can follow this link: <a href="%%url%%">%%url%%</a>'
+                       'register' => [
+                               'field' => [],
+                               'route' => ['index' => 'index_url', 'confirm' => 'confirm_url'],
+                               'view' => [
+                                       'name' => '@RapsysUser/form/register.html.twig',
+                                       'form' => 'Rapsys\UserBundle\Form\RegisterType',
+                                       'context' => []
                                ],
-                               'url_name' => 'rapsys_user_recover_mail',
-                               'url_args' => [],
-                               'template' => '@@RapsysUser/security/recover_mail.html.twig',
-                               'context' => []
+                               'mail' => [
+                                       'subject' => 'Welcome!',
+                                       'html' => '@RapsysUser/mail/register.html.twig',
+                                       'text' => '@RapsysUser/mail/register.text.twig',
+                                       'context' => []
+                               ]
                        ]
                ];
 
-               //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('rapsys_user')
+                                       ->arrayNode('class')
+                                               ->treatNullLike([])
+                                               ->defaultValue($defaults['class'])
+                                               ->scalarPrototype()->end()
+                                       ->end()
+                                       ->arrayNode('default')
+                                               ->treatNullLike([])
+                                               ->defaultValue($defaults['default'])
+                                               ->variablePrototype()->end()
+                                       ->end()
+                                       ->arrayNode('route')
                                                ->addDefaultsIfNotSet()
                                                ->children()
-                                                       ->arrayNode('class')
-                                                               ->isRequired()
+                                                       ->arrayNode('confirm')
                                                                ->addDefaultsIfNotSet()
                                                                ->children()
-                                                                       ->scalarNode('group')->isRequired()->defaultValue($defaults['class']['group'])->end()
-                                                                       ->scalarNode('title')->isRequired()->defaultValue($defaults['class']['title'])->end()
-                                                                       ->scalarNode('user')->isRequired()->defaultValue($defaults['class']['user'])->end()
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['confirm']['name'])->end()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['route']['confirm']['context'])
+                                                                               ->scalarPrototype()->end()
+                                                                       ->end()
                                                                ->end()
                                                        ->end()
-                                                       ->arrayNode('contact')
-                                                               ->isRequired()
+                                                       ->arrayNode('index')
                                                                ->addDefaultsIfNotSet()
                                                                ->children()
-                                                                       ->scalarNode('name')->isRequired()->defaultValue($defaults['contact']['name'])->end()
-                                                                       ->scalarNode('mail')->isRequired()->defaultValue($defaults['contact']['mail'])->end()
-                                                                       ->scalarNode('home_name')->isRequired()->defaultValue($defaults['contact']['home_name'])->end()
-                                                                       ->arrayNode('home_args')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike($defaults['contact']['home_args'])
-                                                                               ->defaultValue($defaults['contact']['home_args'])
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['index']['name'])->end()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['route']['index']['context'])
                                                                                ->scalarPrototype()->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()
-                                                       ->arrayNode('login')
-                                                               ->isRequired()
+                                                       ->arrayNode('edit')
                                                                ->addDefaultsIfNotSet()
                                                                ->children()
-                                                                       ->scalarNode('template')->isRequired()->defaultValue($defaults['login']['template'])->end()
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['edit']['name'])->end()
                                                                        ->arrayNode('context')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike(array())
-                                                                               ->defaultValue($defaults['login']['context'])
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['route']['edit']['context'])
                                                                                ->scalarPrototype()->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()
-                                                       ->arrayNode('register')
-                                                               ->isRequired()
+                                                       ->arrayNode('login')
                                                                ->addDefaultsIfNotSet()
                                                                ->children()
-                                                                       ->scalarNode('mail_template')->isRequired()->defaultValue($defaults['register']['mail_template'])->end()
-                                                                       ->arrayNode('mail_context')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike($defaults['register']['mail_context'])
-                                                                               ->defaultValue($defaults['register']['mail_context'])
-                                                                               ->scalarPrototype()->end()
-                                                                       ->end()
-                                                                       ->scalarNode('template')->isRequired()->defaultValue($defaults['register']['template'])->end()
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['login']['name'])->end()
                                                                        ->arrayNode('context')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike($defaults['register']['context'])
-                                                                               ->defaultValue($defaults['register']['context'])
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['route']['login']['context'])
                                                                                ->scalarPrototype()->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()
                                                        ->arrayNode('recover')
-                                                               ->isRequired()
                                                                ->addDefaultsIfNotSet()
                                                                ->children()
-                                                                       ->scalarNode('mail_template')->isRequired()->defaultValue($defaults['recover']['mail_template'])->end()
-                                                                       ->arrayNode('mail_context')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike($defaults['recover']['mail_context'])
-                                                                               ->defaultValue($defaults['recover']['mail_context'])
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['recover']['name'])->end()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['route']['recover']['context'])
                                                                                ->scalarPrototype()->end()
                                                                        ->end()
-                                                                       ->scalarNode('url_name')->isRequired()->defaultValue($defaults['recover']['url_name'])->end()
-                                                                       ->arrayNode('url_args')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike($defaults['recover']['url_args'])
-                                                                               ->defaultValue($defaults['recover']['url_args'])
+                                                               ->end()
+                                                       ->end()
+                                                       ->arrayNode('register')
+                                                               ->addDefaultsIfNotSet()
+                                                               ->children()
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['register']['name'])->end()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['route']['register']['context'])
                                                                                ->scalarPrototype()->end()
                                                                        ->end()
-                                                                       ->scalarNode('template')->isRequired()->defaultValue($defaults['recover']['template'])->end()
+                                                               ->end()
+                                                       ->end()
+                                               ->end()
+                                       ->end()
+                                       ->arrayNode('translate')
+                                               ->treatNullLike([])
+                                               ->defaultValue($defaults['translate'])
+                                               ->scalarPrototype()->end()
+                                       ->end()
+                                       #TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
+                                       ->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'])
+                                               ->scalarPrototype()->end()
+                                       ->end()
+                                       ->arrayNode('contact')
+                                               ->addDefaultsIfNotSet()
+                                               ->children()
+                                                       ->scalarNode('title')->cannotBeEmpty()->defaultValue($defaults['contact']['title'])->end()
+                                                       ->scalarNode('mail')->cannotBeEmpty()->defaultValue($defaults['contact']['mail'])->end()
+                                               ->end()
+                                       ->end()
+                                       ->arrayNode('context')
+                                               ->treatNullLike([])
+                                               ->defaultValue($defaults['context'])
+                                               ->variablePrototype()->end()
+                                       ->end()
+                                       ->arrayNode('edit')
+                                               ->addDefaultsIfNotSet()
+                                               ->children()
+                                                       ->arrayNode('field')
+                                                               ->treatNullLike([])
+                                                               ->defaultValue($defaults['edit']['field'])
+                                                               ->variablePrototype()->end()
+                                                       ->end()
+                                                       ->arrayNode('route')
+                                                               ->treatNullLike([])
+                                                               ->defaultValue($defaults['edit']['route'])
+                                                               ->scalarPrototype()->end()
+                                                       ->end()
+                                                       ->arrayNode('view')
+                                                               ->addDefaultsIfNotSet()
+                                                               ->children()
+                                                                       ->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')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike(array())
-                                                                               ->defaultValue($defaults['recover']['context'])
-                                                                               ->scalarPrototype()->end()
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['edit']['view']['context'])
+                                                                               ->variablePrototype()->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()
-                                                       ->arrayNode('recover_mail')
-                                                               ->isRequired()
+                                               ->end()
+                                       ->end()
+                                       ->arrayNode('login')
+                                               ->addDefaultsIfNotSet()
+                                               ->children()
+                                                       ->arrayNode('route')
+                                                               ->treatNullLike([])
+                                                               ->defaultValue($defaults['login']['route'])
+                                                               ->scalarPrototype()->end()
+                                                       ->end()
+                                                       ->arrayNode('view')
                                                                ->addDefaultsIfNotSet()
                                                                ->children()
-                                                                       ->scalarNode('mail_template')->isRequired()->defaultValue($defaults['recover']['mail_template'])->end()
-                                                                       ->arrayNode('mail_context')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike($defaults['recover']['mail_context'])
-                                                                               ->defaultValue($defaults['recover']['mail_context'])
-                                                                               ->scalarPrototype()->end()
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['login']['view']['name'])->end()
+                                                                       ->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['login']['view']['form'])->end()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['login']['view']['context'])
+                                                                               ->variablePrototype()->end()
                                                                        ->end()
-                                                                       ->scalarNode('url_name')->isRequired()->defaultValue($defaults['recover']['url_name'])->end()
-                                                                       ->arrayNode('url_args')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike($defaults['recover']['url_args'])
-                                                                               ->defaultValue($defaults['recover']['url_args'])
-                                                                               ->scalarPrototype()->end()
+                                                               ->end()
+                                                       ->end()
+                                               ->end()
+                                       ->end()
+                                       ->arrayNode('recover')
+                                               ->addDefaultsIfNotSet()
+                                               ->children()
+                                                       ->arrayNode('route')
+                                                               ->treatNullLike([])
+                                                               ->defaultValue($defaults['recover']['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()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['recover']['view']['context'])
+                                                                               ->variablePrototype()->end()
                                                                        ->end()
-                                                                       ->scalarNode('template')->isRequired()->defaultValue($defaults['recover']['template'])->end()
+                                                               ->end()
+                                                       ->end()
+                                                       ->arrayNode('mail')
+                                                               ->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()
                                                                        ->arrayNode('context')
-                                                                               ->isRequired()
-                                                                               ->treatNullLike(array())
-                                                                               ->defaultValue($defaults['recover']['context'])
-                                                                               ->scalarPrototype()->end()
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['recover']['mail']['context'])
+                                                                               ->variablePrototype()->end()
+                                                                       ->end()
+                                                               ->end()
+                                                       ->end()
+                                               ->end()
+                                       ->end()
+                                       ->arrayNode('register')
+                                               ->addDefaultsIfNotSet()
+                                               ->children()
+                                                       ->arrayNode('field')
+                                                               ->treatNullLike([])
+                                                               ->defaultValue($defaults['register']['field'])
+                                                               ->variablePrototype()->end()
+                                                       ->end()
+                                                       ->arrayNode('route')
+                                                               ->treatNullLike([])
+                                                               ->defaultValue($defaults['register']['route'])
+                                                               ->scalarPrototype()->end()
+                                                       ->end()
+                                                       ->arrayNode('view')
+                                                               ->addDefaultsIfNotSet()
+                                                               ->children()
+                                                                       ->scalarNode('form')->cannotBeEmpty()->defaultValue($defaults['register']['view']['form'])->end()
+                                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['register']['view']['name'])->end()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['register']['view']['context'])
+                                                                               ->variablePrototype()->end()
+                                                                       ->end()
+                                                               ->end()
+                                                       ->end()
+                                                       ->arrayNode('mail')
+                                                               ->addDefaultsIfNotSet()
+                                                               ->children()
+                                                                       ->scalarNode('subject')->cannotBeEmpty()->defaultValue($defaults['register']['mail']['subject'])->end()
+                                                                       ->scalarNode('html')->cannotBeEmpty()->defaultValue($defaults['register']['mail']['html'])->end()
+                                                                       ->scalarNode('text')->cannotBeEmpty()->defaultValue($defaults['register']['mail']['text'])->end()
+                                                                       ->arrayNode('context')
+                                                                               ->treatNullLike([])
+                                                                               ->defaultValue($defaults['register']['mail']['context'])
+                                                                               ->variablePrototype()->end()
                                                                        ->end()
                                                                ->end()
                                                        ->end()