vendor/friendsofsymfony/user-bundle/DependencyInjection/FOSUserExtension.php line 53

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 Symfony\Component\Config\Definition\Processor;
  15. use Symfony\Component\Config\FileLocator;
  16. use Symfony\Component\DependencyInjection\Alias;
  17. use Symfony\Component\DependencyInjection\ContainerBuilder;
  18. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  19. use Symfony\Component\DependencyInjection\Reference;
  20. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  22. /**
  23.  * @internal
  24.  * @final
  25.  */
  26. class FOSUserExtension extends Extension
  27. {
  28.     /**
  29.      * @var array
  30.      */
  31.     private static $doctrineDrivers = [
  32.         'orm' => [
  33.             'registry' => 'doctrine',
  34.             'tag' => 'doctrine.event_subscriber',
  35.         ],
  36.         'mongodb' => [
  37.             'registry' => 'doctrine_mongodb',
  38.             'tag' => 'doctrine_mongodb.odm.event_subscriber',
  39.         ],
  40.         'couchdb' => [
  41.             'registry' => 'doctrine_couchdb',
  42.             'tag' => 'doctrine_couchdb.event_subscriber',
  43.             'listener_class' => 'FOS\UserBundle\Doctrine\CouchDB\UserListener',
  44.         ],
  45.     ];
  47.     private $mailerNeeded = false;
  48.     private $sessionNeeded = false;
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function load(array $configs, ContainerBuilder $container)
  54.     {
  55.         $processor = new Processor();
  56.         $configuration = new Configuration();
  58.         $config = $processor->processConfiguration($configuration, $configs);
  60.         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  62.         if ('custom' !== $config['db_driver']) {
  63.             if (isset(self::$doctrineDrivers[$config['db_driver']])) {
  64.                 $loader->load('doctrine.xml');
  65.                 $container->setAlias('fos_user.doctrine_registry', new Alias(self::$doctrineDrivers[$config['db_driver']]['registry'], false));
  66.             } else {
  67.                 $loader->load(sprintf('%s.xml', $config['db_driver']));
  68.             }
  69.             $container->setParameter($this->getAlias().'.backend_type_'.$config['db_driver'], true);
  70.         }
  72.         if (isset(self::$doctrineDrivers[$config['db_driver']])) {
  73.             $definition = $container->getDefinition('fos_user.object_manager');
  74.             $definition->setFactory([new Reference('fos_user.doctrine_registry'), 'getManager']);
  75.         }
  77.         foreach (['validator', 'security', 'util', 'mailer', 'listeners', 'commands'] as $basename) {
  78.             $loader->load(sprintf('%s.xml', $basename));
  79.         }
  81.         if (!$config['use_authentication_listener']) {
  82.             $container->removeDefinition('fos_user.listener.authentication');
  83.         }
  85.         if ($config['use_flash_notifications']) {
  86.             $this->sessionNeeded = true;
  87.             $loader->load('flash_notifications.xml');
  88.         }
  90.         $container->setAlias('fos_user.util.email_canonicalizer', $config['service']['email_canonicalizer']);
  91.         $container->setAlias('fos_user.util.username_canonicalizer', $config['service']['username_canonicalizer']);
  92.         $container->setAlias('fos_user.util.token_generator', $config['service']['token_generator']);
  93.         $container->setAlias('fos_user.user_manager', new Alias($config['service']['user_manager'], true));
  95.         if ($config['use_listener'] && isset(self::$doctrineDrivers[$config['db_driver']])) {
  96.             $listenerDefinition = $container->getDefinition('fos_user.user_listener');
  97.             $listenerDefinition->addTag(self::$doctrineDrivers[$config['db_driver']]['tag']);
  98.             if (isset(self::$doctrineDrivers[$config['db_driver']]['listener_class'])) {
  99.                 $listenerDefinition->setClass(self::$doctrineDrivers[$config['db_driver']]['listener_class']);
  100.             }
  101.         }
  103.         if ($config['use_username_form_type']) {
  104.             $loader->load('username_form_type.xml');
  105.         }
  107.         $this->remapParametersNamespaces($config, $container, [
  108.             '' => [
  109.                 'db_driver' => 'fos_user.storage',
  110.                 'firewall_name' => 'fos_user.firewall_name',
  111.                 'model_manager_name' => 'fos_user.model_manager_name',
  112.                 'user_class' => 'fos_user.model.user.class',
  113.             ],
  114.         ]);
  116.         if (!empty($config['profile'])) {
  117.             $this->loadProfile($config['profile'], $container, $loader);
  118.         }
  120.         if (!empty($config['registration'])) {
  121.             $this->loadRegistration($config['registration'], $container, $loader, $config['from_email']);
  122.         }
  124.         if (!empty($config['change_password'])) {
  125.             $this->loadChangePassword($config['change_password'], $container, $loader);
  126.         }
  128.         if (!empty($config['resetting'])) {
  129.             $this->loadResetting($config['resetting'], $container, $loader, $config['from_email']);
  130.         }
  132.         if (!empty($config['group'])) {
  133.             @trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
  135.             $this->loadGroups($config['group'], $container, $loader, $config['db_driver']);
  136.         }
  138.         if ($this->mailerNeeded) {
  139.             $container->setAlias('fos_user.mailer', $config['service']['mailer']);
  140.         }
  142.         if ($this->sessionNeeded) {
  143.             // Use a private alias rather than a parameter, to avoid leaking it at runtime (the private alias will be removed)
  144.             $container->setAlias('fos_user.session', new Alias('session', false));
  145.         }
  146.     }
  148.     /**
  149.      * {@inheritdoc}
  150.      */
  151.     public function getNamespace()
  152.     {
  153.         return 'http://friendsofsymfony.github.io/schema/dic/user';
  154.     }
  156.     protected function remapParameters(array $config, ContainerBuilder $container, array $map)
  157.     {
  158.         foreach ($map as $name => $paramName) {
  159.             if (array_key_exists($name, $config)) {
  160.                 $container->setParameter($paramName, $config[$name]);
  161.             }
  162.         }
  163.     }
  165.     protected function remapParametersNamespaces(array $config, ContainerBuilder $container, array $namespaces)
  166.     {
  167.         foreach ($namespaces as $ns => $map) {
  168.             if ($ns) {
  169.                 if (!array_key_exists($ns, $config)) {
  170.                     continue;
  171.                 }
  172.                 $namespaceConfig = $config[$ns];
  173.             } else {
  174.                 $namespaceConfig = $config;
  175.             }
  176.             if (is_array($map)) {
  177.                 $this->remapParameters($namespaceConfig, $container, $map);
  178.             } else {
  179.                 foreach ($namespaceConfig as $name => $value) {
  180.                     $container->setParameter(sprintf($map, $name), $value);
  181.                 }
  182.             }
  183.         }
  184.     }
  186.     private function loadProfile(array $config, ContainerBuilder $container, XmlFileLoader $loader)
  187.     {
  188.         $loader->load('profile.xml');
  190.         $this->remapParametersNamespaces($config, $container, [
  191.             'form' => 'fos_user.profile.form.%s',
  192.         ]);
  193.     }
  195.     private function loadRegistration(array $config, ContainerBuilder $container, XmlFileLoader $loader, array $fromEmail)
  196.     {
  197.         $loader->load('registration.xml');
  198.         $this->sessionNeeded = true;
  200.         if ($config['confirmation']['enabled']) {
  201.             $this->mailerNeeded = true;
  202.             $loader->load('email_confirmation.xml');
  203.         }
  205.         if (isset($config['confirmation']['from_email'])) {
  206.             // overwrite the global one
  207.             $fromEmail = $config['confirmation']['from_email'];
  208.             unset($config['confirmation']['from_email']);
  209.         }
  210.         $container->setParameter('fos_user.registration.confirmation.from_email', [$fromEmail['address'] => $fromEmail['sender_name']]);
  212.         $this->remapParametersNamespaces($config, $container, [
  213.             'confirmation' => 'fos_user.registration.confirmation.%s',
  214.             'form' => 'fos_user.registration.form.%s',
  215.         ]);
  216.     }
  218.     private function loadChangePassword(array $config, ContainerBuilder $container, XmlFileLoader $loader)
  219.     {
  220.         $loader->load('change_password.xml');
  222.         $this->remapParametersNamespaces($config, $container, [
  223.             'form' => 'fos_user.change_password.form.%s',
  224.         ]);
  225.     }
  227.     private function loadResetting(array $config, ContainerBuilder $container, XmlFileLoader $loader, array $fromEmail)
  228.     {
  229.         $this->mailerNeeded = true;
  230.         $loader->load('resetting.xml');
  232.         if (isset($config['email']['from_email'])) {
  233.             // overwrite the global one
  234.             $fromEmail = $config['email']['from_email'];
  235.             unset($config['email']['from_email']);
  236.         }
  237.         $container->setParameter('fos_user.resetting.email.from_email', [$fromEmail['address'] => $fromEmail['sender_name']]);
  239.         $this->remapParametersNamespaces($config, $container, [
  240.             '' => [
  241.                 'retry_ttl' => 'fos_user.resetting.retry_ttl',
  242.                 'token_ttl' => 'fos_user.resetting.token_ttl',
  243.             ],
  244.             'email' => 'fos_user.resetting.email.%s',
  245.             'form' => 'fos_user.resetting.form.%s',
  246.         ]);
  247.     }
  249.     /**
  250.      * @param string $dbDriver
  251.      */
  252.     private function loadGroups(array $config, ContainerBuilder $container, XmlFileLoader $loader, $dbDriver)
  253.     {
  254.         $loader->load('group.xml');
  255.         if ('custom' !== $dbDriver) {
  256.             if (isset(self::$doctrineDrivers[$dbDriver])) {
  257.                 $loader->load('doctrine_group.xml');
  258.             } else {
  259.                 $loader->load(sprintf('%s_group.xml', $dbDriver));
  260.             }
  261.         }
  263.         $container->setAlias('fos_user.group_manager', new Alias($config['group_manager'], true));
  264.         $container->setAlias('FOS\UserBundle\Model\GroupManagerInterface', new Alias('fos_user.group_manager', false));
  266.         $this->remapParametersNamespaces($config, $container, [
  267.             '' => [
  268.                 'group_class' => 'fos_user.model.group.class',
  269.             ],
  270.             'form' => 'fos_user.group.form.%s',
  271.         ]);
  272.     }
  273. }