X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/e1e170263366dc7d54027e84a54809e7860603ab..0811e272814cf05d6fc8bc76646a0be99bf79bb9:/DependencyInjection/Configuration.php

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
index 7b965a0..28f6fc2 100644
--- a/DependencyInjection/Configuration.php
+++ b/DependencyInjection/Configuration.php
@@ -1,64 +1,101 @@
-<?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 Rapsys\UserBundle\RapsysUserBundle;
+
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
+ * {@inheritdoc}
+ *
  * 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
  */
 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 = [
 			'class' => [
-				'group' => 'Rapsys\\UserBundle\\Entity\\Group',
 				'civility' => 'Rapsys\\UserBundle\\Entity\\Civility',
+				'group' => 'Rapsys\\UserBundle\\Entity\\Group',
 				'user' => 'Rapsys\\UserBundle\\Entity\\User'
 			],
 			'default' => [
+				'admin' => 'ROLE_ADMIN',
 				'civility' => 'Mister',
+				'languages' => [
+					'en_gb' => 'English'
+				],
+				'locales' => [ 'en_gb' ],
 				'group' => [ 'User' ]
 			],
 			'route' => [
+				'confirm' => [
+					'name' => 'rapsysuser_confirm',
+					'context' => []
+				],
+				'edit' => [
+					'name' => 'rapsysuser_edit',
+					'context' => []
+				],
 				'index' => [
-					'name' => 'rapsys_user_index',
+					'name' => 'rapsysuser_index',
 					'context' => []
 				],
 				'login' => [
-					'name' => 'rapsys_user_login',
+					'name' => 'rapsysuser_login',
 					'context' => []
 				],
 				'recover' => [
-					'name' => 'rapsys_user_recover',
-					'context' => []
-				],
-				'recover_mail' => [
-					'name' => 'rapsys_user_recover_mail',
+					'name' => 'rapsysuser_recover',
 					'context' => []
 				],
 				'register' => [
-					'name' => 'rapsys_user_register',
+					'name' => 'rapsysuser_register',
 					'context' => []
 				]
 			],
 			'translate' => [],
-			'locales' => '%kernel.translator.fallbacks%',
-			'languages' => [
-				'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'],
@@ -69,7 +106,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,25 +119,13 @@ 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'],
+				'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' => [
@@ -112,13 +137,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 rapsysuser to dump default config
+		 * @see php bin/console debug:config rapsysuser to dump config
+		 */
 		$treeBuilder
 			//Parameters
 			->getRootNode()
@@ -126,18 +154,35 @@ class Configuration implements ConfigurationInterface {
 				->children()
 					->arrayNode('class')
 						->addDefaultsIfNotSet()
+						#XXX: ignoreExtraKeys(bool $remove = true)
+						->ignoreExtraKeys(false)
 						->children()
-							->scalarNode('group')->cannotBeEmpty()->defaultValue($defaults['class']['group'])->end()
 							->scalarNode('civility')->cannotBeEmpty()->defaultValue($defaults['class']['civility'])->end()
+							->scalarNode('group')->cannotBeEmpty()->defaultValue($defaults['class']['group'])->end()
 							->scalarNode('user')->cannotBeEmpty()->defaultValue($defaults['class']['user'])->end()
 						->end()
 					->end()
 					->arrayNode('default')
 						->addDefaultsIfNotSet()
+						#XXX: ignoreExtraKeys(bool $remove = true)
+						->ignoreExtraKeys(false)
 						->children()
+							->scalarNode('admin')->cannotBeEmpty()->defaultValue($defaults['default']['admin'])->end()
 							->scalarNode('civility')->cannotBeEmpty()->defaultValue($defaults['default']['civility'])->end()
+							#TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
+							->arrayNode('languages')
+								->treatNullLike([])
+								->defaultValue($defaults['default']['languages'])
+								->scalarPrototype()->end()
+							->end()
+							#TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
+							->arrayNode('locales')
+								->treatNullLike([])
+								->defaultValue($defaults['default']['locales'])
+								->scalarPrototype()->end()
+							->end()
 							->arrayNode('group')
-								->treatNullLike(array())
+								->treatNullLike([])
 								->defaultValue($defaults['default']['group'])
 								->scalarPrototype()->end()
 							->end()
@@ -146,46 +191,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 +251,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,96 +260,114 @@ class Configuration implements ConfigurationInterface {
 						->end()
 					->end()
 					->arrayNode('translate')
-						->treatNullLike(array())
-						->defaultValue($defaults['translate'])
-						->scalarPrototype()->end()
-					->end()
-					->scalarNode('locales')->cannotBeEmpty()->defaultValue($defaults['locales'])->end()
-					->arrayNode('languages')
 						->treatNullLike([])
-						->defaultValue($defaults['languages'])
+						->defaultValue($defaults['translate'])
 						->scalarPrototype()->end()
 					->end()
 					->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()
@@ -301,12 +375,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()
@@ -316,8 +390,18 @@ class Configuration implements ConfigurationInterface {
 					->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()
@@ -327,7 +411,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 +424,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()