Add confirm and edit route

Add global context
Add edit context
Use full locale
Remove recover_mail
Add strict types
Improve documentation
New tree layout
Cleanup

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
index efc8a686f5638f5645aa0addad429f1a42498425..b22d973cfb6d1fdd227c10b8d1f1fc0ff3f0d182 100644 (file)
--- a/DependencyInjection/Configuration.php
+++ b/DependencyInjection/Configuration.php
@@ -1,4 +1,13 @@
-<?php
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys PackBundle 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;
 
@@ -8,13 +17,15 @@ use Symfony\Component\Config\Definition\ConfigurationInterface;
 /**
  * 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');
 
@@ -30,6 +41,14 @@ class Configuration implements ConfigurationInterface {
                                'group' => [ 'User' ]
                        ],
                        'route' => [
+                               'confirm' => [
+                                       'name' => 'rapsys_user_confirm',
+                                       'context' => []
+                               ],
+                               'edit' => [
+                                       'name' => 'rapsys_user_edit',
+                                       'context' => []
+                               ],
                                'index' => [
                                        'name' => 'rapsys_user_index',
                                        'context' => []
@@ -42,10 +61,6 @@ class Configuration implements ConfigurationInterface {
                                        'name' => 'rapsys_user_recover',
                                        'context' => []
                                ],
-                               'recover_mail' => [
-                                       'name' => 'rapsys_user_recover_mail',
-                                       'context' => []
-                               ],
                                'register' => [
                                        'name' => 'rapsys_user_register',
                                        'context' => []
@@ -54,12 +69,21 @@ class Configuration implements ConfigurationInterface {
                        'translate' => [],
                        'locales' => '%kernel.translator.fallbacks%',
                        'languages' => [
-                               'en-gb' => 'English'
+                               'en_gb' => 'English'
                        ],
                        'contact' => [
                                'title' => 'John Doe',
                                'mail' => 'contact@example.com'
                        ],
+                       'context' => [],
+                       'edit' => [
+                               'route' => ['index' => 'index_url'],
+                               'view' => [
+                                       'form' => 'Rapsys\UserBundle\Form\RegisterType',
+                                       'name' => '@RapsysUser/form/register.html.twig',
+                                       'context' => []
+                               ]
+                       ],
                        'login' => [
                                'route' => ['index' => 'index_url'],
                                'view' => [
@@ -69,7 +93,7 @@ class Configuration implements ConfigurationInterface {
                                ]
                        ],
                        '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',
@@ -82,22 +106,8 @@ class Configuration implements ConfigurationInterface {
                                        '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'],
+                               'route' => ['index' => 'index_url', 'confirm' => 'confirm_url'],
                                'view' => [
                                        'form' => 'Rapsys\UserBundle\Form\RegisterType',
                                        'name' => '@RapsysUser/form/register.html.twig',
@@ -112,13 +122,16 @@ class Configuration implements ConfigurationInterface {
                        ]
                ];
 
-               //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()
@@ -137,7 +150,7 @@ class Configuration implements ConfigurationInterface {
                                                ->children()
                                                        ->scalarNode('civility')->cannotBeEmpty()->defaultValue($defaults['default']['civility'])->end()
                                                        ->arrayNode('group')
-                                                               ->treatNullLike(array())
+                                                               ->treatNullLike([])
                                                                ->defaultValue($defaults['default']['group'])
                                                                ->scalarPrototype()->end()
                                                        ->end()
@@ -146,46 +159,57 @@ class Configuration implements ConfigurationInterface {
                                        ->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()
@@ -195,7 +219,7 @@ class Configuration implements ConfigurationInterface {
                                                                ->children()
                                                                        ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['route']['register']['name'])->end()
                                                                        ->arrayNode('context')
-                                                                               ->treatNullLike(array())
+                                                                               ->treatNullLike([])
                                                                                ->defaultValue($defaults['route']['register']['context'])
                                                                                ->scalarPrototype()->end()
                                                                        ->end()
@@ -204,7 +228,7 @@ class Configuration implements ConfigurationInterface {
                                                ->end()
                                        ->end()
                                        ->arrayNode('translate')
-                                               ->treatNullLike(array())
+                                               ->treatNullLike([])
                                                ->defaultValue($defaults['translate'])
                                                ->scalarPrototype()->end()
                                        ->end()
@@ -221,79 +245,71 @@ class Configuration implements ConfigurationInterface {
                                                        ->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('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('form')->cannotBeEmpty()->defaultValue($defaults['edit']['view']['form'])->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('login')
                                                ->addDefaultsIfNotSet()
                                                ->children()
                                                        ->arrayNode('route')
-                                                               ->treatNullLike(array())
-                                                               ->defaultValue($defaults['recover']['route'])
+                                                               ->treatNullLike([])
+                                                               ->defaultValue($defaults['login']['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(array())
-                                                                               ->defaultValue($defaults['recover']['view']['context'])
-                                                                               ->variablePrototype()->end()
-                                                                       ->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()
+                                                                       ->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()
@@ -301,12 +317,12 @@ class Configuration implements ConfigurationInterface {
                                                        ->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()
@@ -317,7 +333,7 @@ class Configuration implements ConfigurationInterface {
                                                ->addDefaultsIfNotSet()
                                                ->children()
                                                        ->arrayNode('route')
-                                                               ->treatNullLike(array())
+                                                               ->treatNullLike([])
                                                                ->defaultValue($defaults['register']['route'])
                                                                ->scalarPrototype()->end()
                                                        ->end()
@@ -327,7 +343,7 @@ class Configuration implements ConfigurationInterface {
                                                                        ->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()
@@ -340,7 +356,7 @@ class Configuration implements ConfigurationInterface {
                                                                        ->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()