Completed
Push — master ( 1b817e...6c15b7 )
by Jeroen
39:29
created

DependencyInjection/KunstmaanAdminExtension.php (3 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Kunstmaan\AdminBundle\DependencyInjection;
4
5
use FOS\UserBundle\Form\Type\ResettingFormType;
6
use InvalidArgumentException;
7
use Symfony\Component\Config\FileLocator;
8
use Symfony\Component\DependencyInjection\ContainerBuilder;
9
use Symfony\Component\DependencyInjection\Definition;
10
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
11
use Symfony\Component\DependencyInjection\Loader;
12
use Symfony\Component\DependencyInjection\Reference;
13
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
14
15
/**
16
 * This is the class that loads and manages your bundle configuration
17
 *
18
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
19
 */
20
class KunstmaanAdminExtension extends Extension implements PrependExtensionInterface
21
{
22
    /**
23
     * Loads a specific configuration.
24
     *
25
     * @param array            $configs   An array of configuration values
26
     * @param ContainerBuilder $container A ContainerBuilder instance
27
     *
28
     * @throws InvalidArgumentException When provided tag is not defined in this extension
29
     */
30
    public function load(array $configs, ContainerBuilder $container)
31
    {
32
        $container->setParameter('version_checker.url', 'https://bundles.kunstmaan.be/version-check');
33
        $container->setParameter('version_checker.timeframe', 60 * 60 * 24);
34
        $container->setParameter('version_checker.enabled', true);
35
36
        $configuration = new Configuration();
37
        $config = $this->processConfiguration($configuration, $configs);
38
39
        if (array_key_exists('dashboard_route', $config)) {
40
            $container->setParameter('kunstmaan_admin.dashboard_route', $config['dashboard_route']);
41
        }
42
        if (array_key_exists('admin_password', $config)) {
43
            $container->setParameter('kunstmaan_admin.admin_password', $config['admin_password']);
44
        }
45
        $container->setParameter('kunstmaan_admin.admin_locales', $config['admin_locales']);
46
        $container->setParameter('kunstmaan_admin.default_admin_locale', $config['default_admin_locale']);
47
48
        $container->setParameter('kunstmaan_admin.session_security.ip_check', $config['session_security']['ip_check']);
49
        $container->setParameter('kunstmaan_admin.session_security.user_agent_check', $config['session_security']['user_agent_check']);
50
51
        $container->setParameter('kunstmaan_admin.admin_prefix', $this->normalizeUrlSlice($config['admin_prefix']));
52
53
        $container->setParameter('kunstmaan_admin.admin_exception_excludes', $config['admin_exception_excludes']);
54
55
        $container->setParameter('kunstmaan_admin.google_signin.enabled', $config['google_signin']['enabled']);
56
        $container->setParameter('kunstmaan_admin.google_signin.client_id', $config['google_signin']['client_id']);
57
        $container->setParameter('kunstmaan_admin.google_signin.client_secret', $config['google_signin']['client_secret']);
58
        $container->setParameter('kunstmaan_admin.google_signin.hosted_domains', $config['google_signin']['hosted_domains']);
59
60
        $container->setParameter('kunstmaan_admin.password_restrictions.min_digits', $config['password_restrictions']['min_digits']);
61
        $container->setParameter('kunstmaan_admin.password_restrictions.min_uppercase', $config['password_restrictions']['min_uppercase']);
62
        $container->setParameter('kunstmaan_admin.password_restrictions.min_special_characters', $config['password_restrictions']['min_special_characters']);
63
        $container->setParameter('kunstmaan_admin.password_restrictions.min_length', $config['password_restrictions']['min_length']);
64
        $container->setParameter('kunstmaan_admin.password_restrictions.max_length', $config['password_restrictions']['max_length']);
65
        $container->setParameter('kunstmaan_admin.enable_toolbar_helper', $config['enable_toolbar_helper']);
66
        $container->setParameter('kunstmaan_admin.toolbar_firewall_names', !empty($config['provider_keys']) ? $config['provider_keys'] : $config['toolbar_firewall_names']);
67
        $container->setParameter('kunstmaan_admin.admin_firewall_name', $config['admin_firewall_name']);
68
69
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
70
        $loader->load('services.yml');
71
        $loader->load('commands.yml');
72
73
        if (!empty($config['enable_console_exception_listener']) && $config['enable_console_exception_listener']) {
74
            $loader->load('console_listener.yml');
75
        }
76
77
        if (0 !== count($config['menu_items'])) {
78
            $this->addSimpleMenuAdaptor($container, $config['menu_items']);
79
        }
80
    }
81
82
    public function prepend(ContainerBuilder $container)
83
    {
84
        $knpMenuConfig['twig'] = true; // set to false to disable the Twig extension and the TwigRenderer
0 ignored issues
show
Coding Style Comprehensibility introduced by
$knpMenuConfig was never initialized. Although not strictly required by PHP, it is generally a good practice to add $knpMenuConfig = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
85
        $knpMenuConfig['templating'] = false; // if true, enables the helper for PHP templates
86
        $knpMenuConfig['default_renderer'] = 'twig'; // The renderer to use, list is also available by default
87
        $container->prependExtensionConfig('knp_menu', $knpMenuConfig);
88
89
        $fosUserConfig['db_driver'] = 'orm'; // other valid values are 'mongodb', 'couchdb'
0 ignored issues
show
Coding Style Comprehensibility introduced by
$fosUserConfig was never initialized. Although not strictly required by PHP, it is generally a good practice to add $fosUserConfig = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
90
        $fosUserConfig['firewall_name'] = 'main';
91
        $fosUserConfig['user_class'] = 'Kunstmaan\AdminBundle\Entity\User';
92
        $fosUserConfig['group']['group_class'] = 'Kunstmaan\AdminBundle\Entity\Group';
93
        $fosUserConfig['resetting']['token_ttl'] = 86400;
94
        // Use this node only if you don't want the global email address for the resetting email
95
        $fosUserConfig['resetting']['email']['from_email']['address'] = '[email protected]';
96
        $fosUserConfig['resetting']['email']['from_email']['sender_name'] = 'admin';
97
        $fosUserConfig['resetting']['email']['template'] = 'FOSUserBundle:Resetting:email.txt.twig';
98
        $fosUserConfig['resetting']['form']['type'] = ResettingFormType::class;
99
        $fosUserConfig['resetting']['form']['name'] = 'fos_user_resetting_form';
100
        $fosUserConfig['resetting']['form']['validation_groups'] = ['ResetPassword'];
101
        $container->prependExtensionConfig('fos_user', $fosUserConfig);
102
103
        $monologConfig['handlers']['main']['type'] = 'rotating_file';
0 ignored issues
show
Coding Style Comprehensibility introduced by
$monologConfig was never initialized. Although not strictly required by PHP, it is generally a good practice to add $monologConfig = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
104
        $monologConfig['handlers']['main']['path'] = sprintf('%s/%s', $container->getParameter('kernel.logs_dir'), $container->getParameter('kernel.environment'));
105
        $monologConfig['handlers']['main']['level'] = 'debug';
106
        $container->prependExtensionConfig('monolog', $monologConfig);
107
108
        $twigConfig['paths'][] = ['value' => dirname(__DIR__).'/Resources/views', 'namespace' => 'FOSUser'];
109
        $container->prependExtensionConfig('twig', $twigConfig);
110
111
        $configs = $container->getExtensionConfig($this->getAlias());
112
        $this->processConfiguration(new Configuration(), $configs);
113
    }
114
115
    /**
116
     * {@inheritdoc}
117
     */
118
    public function getNamespace()
119
    {
120
        return 'http://bundles.kunstmaan.be/schema/dic/admin';
121
    }
122
123
    /**
124
     * {@inheritdoc}
125
     */
126
    public function getXsdValidationBasePath()
127
    {
128
        return __DIR__.'/../Resources/config/schema';
129
    }
130
131
    private function addSimpleMenuAdaptor(ContainerBuilder $container, array $menuItems)
132
    {
133
        $definition = new Definition('Kunstmaan\AdminBundle\Helper\Menu\SimpleMenuAdaptor', [
134
            new Reference('security.authorization_checker'),
135
            $menuItems,
136
        ]);
137
        $definition->addTag('kunstmaan_admin.menu.adaptor');
138
139
        $container->setDefinition('kunstmaan_admin.menu.adaptor.simple', $definition);
140
    }
141
142
    /**
143
     * @param string $urlSlice
144
     *
145
     * @return string
146
     */
147
    protected function normalizeUrlSlice($urlSlice)
148
    {
149
        /* Get rid of exotic characters that would break the url */
150
        $urlSlice = filter_var($urlSlice, FILTER_SANITIZE_URL);
151
152
        /* Remove leading and trailing slashes */
153
        $urlSlice = trim($urlSlice, '/');
154
155
        /* Make sure our $urlSlice is literally used in our regex */
156
        $urlSlice = preg_quote($urlSlice);
157
158
        return $urlSlice;
159
    }
160
}
161