vendor/friendsofsymfony/user-bundle/DependencyInjection/Configuration.php line 34

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSUserBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\UserBundle\DependencyInjection;
  14. use FOS\UserBundle\Form\Type;
  15. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  16. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  17. use Symfony\Component\Config\Definition\ConfigurationInterface;
  19. /**
  20.  * This class contains the configuration information for the bundle.
  21.  *
  22.  * This information is solely responsible for how the different configuration
  23.  * sections are normalized, and merged.
  24.  *
  25.  * @author Christophe Coevoet <[email protected]>
  26.  */
  27. class Configuration implements ConfigurationInterface
  28. {
  29.     /**
  30.      * {@inheritdoc}
  31.      */
  32.     public function getConfigTreeBuilder()
  33.     {
  34.         $treeBuilder = new TreeBuilder();
  35.         $rootNode = $treeBuilder->root('fos_user');
  37.         $supportedDrivers = array('orm', 'mongodb', 'couchdb', 'custom');
  39.         $rootNode
  40.             ->children()
  41.                 ->scalarNode('db_driver')
  42.                     ->validate()
  43.                         ->ifNotInArray($supportedDrivers)
  44.                         ->thenInvalid('The driver %s is not supported. Please choose one of '.json_encode($supportedDrivers))
  45.                     ->end()
  46.                     ->cannotBeOverwritten()
  47.                     ->isRequired()
  48.                     ->cannotBeEmpty()
  49.                 ->end()
  50.                 ->scalarNode('user_class')->isRequired()->cannotBeEmpty()->end()
  51.                 ->scalarNode('firewall_name')->isRequired()->cannotBeEmpty()->end()
  52.                 ->scalarNode('model_manager_name')->defaultNull()->end()
  53.                 ->booleanNode('use_authentication_listener')->defaultTrue()->end()
  54.                 ->booleanNode('use_listener')->defaultTrue()->end()
  55.                 ->booleanNode('use_flash_notifications')->defaultTrue()->end()
  56.                 ->booleanNode('use_username_form_type')->defaultTrue()->end()
  57.                 ->arrayNode('from_email')
  58.                     ->isRequired()
  59.                     ->children()
  60.                         ->scalarNode('address')->isRequired()->cannotBeEmpty()->end()
  61.                         ->scalarNode('sender_name')->isRequired()->cannotBeEmpty()->end()
  62.                     ->end()
  63.                 ->end()
  64.             ->end()
  65.             // Using the custom driver requires changing the manager services
  66.             ->validate()
  67.                 ->ifTrue(function ($v) {
  68.                     return 'custom' === $v['db_driver'] && 'fos_user.user_manager.default' === $v['service']['user_manager'];
  69.                 })
  70.                 ->thenInvalid('You need to specify your own user manager service when using the "custom" driver.')
  71.             ->end()
  72.             ->validate()
  73.                 ->ifTrue(function ($v) {
  74.                     return 'custom' === $v['db_driver'] && !empty($v['group']) && 'fos_user.group_manager.default' === $v['group']['group_manager'];
  75.                 })
  76.                 ->thenInvalid('You need to specify your own group manager service when using the "custom" driver.')
  77.             ->end();
  79.         $this->addProfileSection($rootNode);
  80.         $this->addChangePasswordSection($rootNode);
  81.         $this->addRegistrationSection($rootNode);
  82.         $this->addResettingSection($rootNode);
  83.         $this->addServiceSection($rootNode);
  84.         $this->addGroupSection($rootNode);
  86.         return $treeBuilder;
  87.     }
  89.     /**
  90.      * @param ArrayNodeDefinition $node
  91.      */
  92.     private function addProfileSection(ArrayNodeDefinition $node)
  93.     {
  94.         $node
  95.             ->children()
  96.                 ->arrayNode('profile')
  97.                     ->addDefaultsIfNotSet()
  98.                     ->canBeUnset()
  99.                     ->children()
  100.                         ->arrayNode('form')
  101.                             ->addDefaultsIfNotSet()
  102.                             ->fixXmlConfig('validation_group')
  103.                             ->children()
  104.                                 ->scalarNode('type')->defaultValue(Type\ProfileFormType::class)->end()
  105.                                 ->scalarNode('name')->defaultValue('fos_user_profile_form')->end()
  106.                                 ->arrayNode('validation_groups')
  107.                                     ->prototype('scalar')->end()
  108.                                     ->defaultValue(array('Profile', 'Default'))
  109.                                 ->end()
  110.                             ->end()
  111.                         ->end()
  112.                     ->end()
  113.                 ->end()
  114.             ->end();
  115.     }
  117.     /**
  118.      * @param ArrayNodeDefinition $node
  119.      */
  120.     private function addRegistrationSection(ArrayNodeDefinition $node)
  121.     {
  122.         $node
  123.             ->children()
  124.                 ->arrayNode('registration')
  125.                     ->addDefaultsIfNotSet()
  126.                     ->canBeUnset()
  127.                     ->children()
  128.                         ->arrayNode('confirmation')
  129.                             ->addDefaultsIfNotSet()
  130.                             ->children()
  131.                                 ->booleanNode('enabled')->defaultFalse()->end()
  132.                                 ->scalarNode('template')->defaultValue('@FOSUser/Registration/email.txt.twig')->end()
  133.                                 ->arrayNode('from_email')
  134.                                     ->canBeUnset()
  135.                                     ->children()
  136.                                         ->scalarNode('address')->isRequired()->cannotBeEmpty()->end()
  137.                                         ->scalarNode('sender_name')->isRequired()->cannotBeEmpty()->end()
  138.                                     ->end()
  139.                                 ->end()
  140.                             ->end()
  141.                         ->end()
  142.                         ->arrayNode('form')
  143.                             ->addDefaultsIfNotSet()
  144.                             ->children()
  145.                                 ->scalarNode('type')->defaultValue(Type\RegistrationFormType::class)->end()
  146.                                 ->scalarNode('name')->defaultValue('fos_user_registration_form')->end()
  147.                                 ->arrayNode('validation_groups')
  148.                                     ->prototype('scalar')->end()
  149.                                     ->defaultValue(array('Registration', 'Default'))
  150.                                 ->end()
  151.                             ->end()
  152.                         ->end()
  153.                     ->end()
  154.                 ->end()
  155.             ->end();
  156.     }
  158.     /**
  159.      * @param ArrayNodeDefinition $node
  160.      */
  161.     private function addResettingSection(ArrayNodeDefinition $node)
  162.     {
  163.         $node
  164.             ->children()
  165.                 ->arrayNode('resetting')
  166.                     ->addDefaultsIfNotSet()
  167.                     ->canBeUnset()
  168.                     ->children()
  169.                         ->scalarNode('retry_ttl')->defaultValue(7200)->end()
  170.                         ->scalarNode('token_ttl')->defaultValue(86400)->end()
  171.                         ->arrayNode('email')
  172.                             ->addDefaultsIfNotSet()
  173.                             ->children()
  174.                                 ->scalarNode('template')->defaultValue('@FOSUser/Resetting/email.txt.twig')->end()
  175.                                 ->arrayNode('from_email')
  176.                                     ->canBeUnset()
  177.                                     ->children()
  178.                                         ->scalarNode('address')->isRequired()->cannotBeEmpty()->end()
  179.                                         ->scalarNode('sender_name')->isRequired()->cannotBeEmpty()->end()
  180.                                     ->end()
  181.                                 ->end()
  182.                             ->end()
  183.                         ->end()
  184.                         ->arrayNode('form')
  185.                             ->addDefaultsIfNotSet()
  186.                             ->children()
  187.                                 ->scalarNode('type')->defaultValue(Type\ResettingFormType::class)->end()
  188.                                 ->scalarNode('name')->defaultValue('fos_user_resetting_form')->end()
  189.                                 ->arrayNode('validation_groups')
  190.                                     ->prototype('scalar')->end()
  191.                                     ->defaultValue(array('ResetPassword', 'Default'))
  192.                                 ->end()
  193.                             ->end()
  194.                         ->end()
  195.                     ->end()
  196.                 ->end()
  197.             ->end();
  198.     }
  200.     /**
  201.      * @param ArrayNodeDefinition $node
  202.      */
  203.     private function addChangePasswordSection(ArrayNodeDefinition $node)
  204.     {
  205.         $node
  206.             ->children()
  207.                 ->arrayNode('change_password')
  208.                     ->addDefaultsIfNotSet()
  209.                     ->canBeUnset()
  210.                     ->children()
  211.                         ->arrayNode('form')
  212.                             ->addDefaultsIfNotSet()
  213.                             ->children()
  214.                                 ->scalarNode('type')->defaultValue(Type\ChangePasswordFormType::class)->end()
  215.                                 ->scalarNode('name')->defaultValue('fos_user_change_password_form')->end()
  216.                                 ->arrayNode('validation_groups')
  217.                                     ->prototype('scalar')->end()
  218.                                     ->defaultValue(array('ChangePassword', 'Default'))
  219.                                 ->end()
  220.                             ->end()
  221.                         ->end()
  222.                     ->end()
  223.                 ->end()
  224.             ->end();
  225.     }
  227.     /**
  228.      * @param ArrayNodeDefinition $node
  229.      */
  230.     private function addServiceSection(ArrayNodeDefinition $node)
  231.     {
  232.         $node
  233.             ->addDefaultsIfNotSet()
  234.             ->children()
  235.                 ->arrayNode('service')
  236.                     ->addDefaultsIfNotSet()
  237.                         ->children()
  238.                             ->scalarNode('mailer')->defaultValue('fos_user.mailer.default')->end()
  239.                             ->scalarNode('email_canonicalizer')->defaultValue('fos_user.util.canonicalizer.default')->end()
  240.                             ->scalarNode('token_generator')->defaultValue('fos_user.util.token_generator.default')->end()
  241.                             ->scalarNode('username_canonicalizer')->defaultValue('fos_user.util.canonicalizer.default')->end()
  242.                             ->scalarNode('user_manager')->defaultValue('fos_user.user_manager.default')->end()
  243.                         ->end()
  244.                     ->end()
  245.                 ->end()
  246.             ->end();
  247.     }
  249.     /**
  250.      * @param ArrayNodeDefinition $node
  251.      */
  252.     private function addGroupSection(ArrayNodeDefinition $node)
  253.     {
  254.         $node
  255.             ->children()
  256.                 ->arrayNode('group')
  257.                     ->canBeUnset()
  258.                     ->children()
  259.                         ->scalarNode('group_class')->isRequired()->cannotBeEmpty()->end()
  260.                         ->scalarNode('group_manager')->defaultValue('fos_user.group_manager.default')->end()
  261.                         ->arrayNode('form')
  262.                             ->addDefaultsIfNotSet()
  263.                             ->fixXmlConfig('validation_group')
  264.                             ->children()
  265.                                 ->scalarNode('type')->defaultValue(Type\GroupFormType::class)->end()
  266.                                 ->scalarNode('name')->defaultValue('fos_user_group_form')->end()
  267.                                 ->arrayNode('validation_groups')
  268.                                     ->prototype('scalar')->end()
  269.                                     ->defaultValue(array('Registration', 'Default'))
  270.                                 ->end()
  271.                             ->end()
  272.                         ->end()
  273.                     ->end()
  274.                 ->end()
  275.             ->end();
  276.     }
  277. }