Move config from XML to PHP

sonata-project · Sep 29, 2021 · f4ab958 · f4ab958
1 parent f93d53f
commit f4ab958
Show file tree

Hide file tree

Showing 9 changed files with 269 additions and 143 deletions.
diff --git a/src/DependencyInjection/SonataSeoExtension.php b/src/DependencyInjection/SonataSeoExtension.php
@@ -35,15 +35,15 @@ public function load(array $configs, ContainerBuilder $container)
 
         $bundles = $container->getParameter('kernel.bundles');
 
-        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader = new Loader\PhpFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
 
         if (isset($bundles['SonataBlockBundle'], $bundles['KnpMenuBundle'])) {
-            $loader->load('blocks.xml');
+            $loader->load('blocks.php');
         }
 
-        $loader->load('event.xml');
-        $loader->load('services.xml');
-        $loader->load('commands.xml');
+        $loader->load('event.php');
+        $loader->load('services.php');
+        $loader->load('commands.php');
 
         $this->configureSeoPage($config['page'], $container);
         $this->configureSitemap($config['sitemap'], $container);

diff --git a/src/Resources/config/blocks.php b/src/Resources/config/blocks.php
@@ -0,0 +1,156 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Sonata\SeoBundle\Block\Breadcrumb\HomepageBreadcrumbBlockService;
+use Sonata\SeoBundle\Block\Social\EmailShareButtonBlockService;
+use Sonata\SeoBundle\Block\Social\FacebookLikeBoxBlockService;
+use Sonata\SeoBundle\Block\Social\FacebookLikeButtonBlockService;
+use Sonata\SeoBundle\Block\Social\FacebookSendButtonBlockService;
+use Sonata\SeoBundle\Block\Social\FacebookShareButtonBlockService;
+use Sonata\SeoBundle\Block\Social\PinterestPinButtonBlockService;
+use Sonata\SeoBundle\Block\Social\TwitterEmbedTweetBlockService;
+use Sonata\SeoBundle\Block\Social\TwitterFollowButtonBlockService;
+use Sonata\SeoBundle\Block\Social\TwitterHashtagButtonBlockService;
+use Sonata\SeoBundle\Block\Social\TwitterMentionButtonBlockService;
+use Sonata\SeoBundle\Block\Social\TwitterShareButtonBlockService;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ReferenceConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // Use "service" function for creating references to services when dropping support for Symfony 4.4
+    // Use "param" function for creating references to parameters when dropping support for Symfony 5.1
+    $containerConfigurator->parameters()
+        ->set('sonata.seo.block.social.container.class', 'Sonata\SeoBundle\Block\Social\SocialBlockContainer')
+        ->set('sonata.seo.block.email.share_button.class', EmailShareButtonBlockService::class)
+        ->set('sonata.seo.block.facebook.like_box.class', FacebookLikeBoxBlockService::class)
+        ->set('sonata.seo.block.facebook.like_button.class', FacebookLikeButtonBlockService::class)
+        ->set('sonata.seo.block.facebook.send_button.class', FacebookSendButtonBlockService::class)
+        ->set('sonata.seo.block.facebook.share_button.class', FacebookShareButtonBlockService::class)
+        ->set('sonata.seo.block.twitter.share_button.class', TwitterShareButtonBlockService::class)
+        ->set('sonata.seo.block.twitter.follow_button.class', TwitterFollowButtonBlockService::class)
+        ->set('sonata.seo.block.twitter.hashtag_button.class', TwitterHashtagButtonBlockService::class)
+        ->set('sonata.seo.block.twitter.mention_button.class', TwitterMentionButtonBlockService::class)
+        ->set('sonata.seo.block.twitter.embed.class', TwitterEmbedTweetBlockService::class)
+        ->set('sonata.seo.block.pinterest.pin_button.class', PinterestPinButtonBlockService::class)
+        ->set('sonata.seo.block.breadcrumb.homepage.class', HomepageBreadcrumbBlockService::class);
+
+    $containerConfigurator->services()
+
+        // Email buttons
+        ->set('sonata.seo.block.email.share_button', '%sonata.seo.block.email.share_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.email.share_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        // Facebook Social Plugins
+        ->set('sonata.seo.block.facebook.like_box', '%sonata.seo.block.facebook.like_box.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.facebook.like_box',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        ->set('sonata.seo.block.facebook.like_button', '%sonata.seo.block.facebook.like_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.facebook.like_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        ->set('sonata.seo.block.facebook.send_button', '%sonata.seo.block.facebook.send_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.facebook.send_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        ->set('sonata.seo.block.facebook.share_button', '%sonata.seo.block.facebook.share_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.facebook.share_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        // Twitter buttons
+        ->set('sonata.seo.block.twitter.share_button', '%sonata.seo.block.twitter.share_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.twitter.share_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        ->set('sonata.seo.block.twitter.follow_button', '%sonata.seo.block.twitter.follow_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.twitter.follow_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        ->set('sonata.seo.block.twitter.hashtag_button', '%sonata.seo.block.twitter.hashtag_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.twitter.hashtag_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        ->set('sonata.seo.block.twitter.mention_button', '%sonata.seo.block.twitter.mention_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.twitter.mention_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        // Twitter embed
+        ->set('sonata.seo.block.twitter.embed', '%sonata.seo.block.twitter.embed.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.twitter.embed',
+                new ReferenceConfigurator('sonata.templating'),
+                (new ReferenceConfigurator('sonata.seo.http.client'))->nullOnInvalid(),
+                (new ReferenceConfigurator('sonata.seo.http.message_factory'))->nullOnInvalid(),
+            ])
+
+        // Pinterest buttons
+        ->set('sonata.seo.block.pinterest.pin_button', '%sonata.seo.block.pinterest.pin_button.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->args([
+                'sonata.seo.block.pinterest.pin_button',
+                new ReferenceConfigurator('sonata.templating'),
+            ])
+
+        // Breadcrumb
+        ->set('sonata.seo.block.breadcrumb.homepage', '%sonata.seo.block.breadcrumb.homepage.class%')
+            ->public()
+            ->tag('sonata.block')
+            ->tag('sonata.breadcrumb')
+            ->args([
+                'homepage',
+                'sonata.seo.block.breadcrumb.homepage',
+                new ReferenceConfigurator('sonata.templating'),
+                new ReferenceConfigurator('knp_menu.menu_provider'),
+                new ReferenceConfigurator('knp_menu.factory'),
+            ]);
+};
diff --git a/src/Resources/config/blocks.xml b/src/Resources/config/blocks.xml
diff --git a/src/Resources/config/commands.php b/src/Resources/config/commands.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Sonata\SeoBundle\Command\SitemapGeneratorCommand;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ReferenceConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // Use "service" function for creating references to services when dropping support for Symfony 4.4
+    // Use "param" function for creating references to parameters when dropping support for Symfony 5.1
+    $containerConfigurator->services()
+
+        ->set(SitemapGeneratorCommand::class)
+            ->tag('console.command')
+            ->args([
+                new ReferenceConfigurator('router'),
+                new ReferenceConfigurator('sonata.seo.sitemap.manager'),
+                new ReferenceConfigurator('filesystem'),
+            ]);
+};
diff --git a/src/Resources/config/commands.xml b/src/Resources/config/commands.xml
diff --git a/src/Resources/config/event.php b/src/Resources/config/event.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Sonata\SeoBundle\Event\BreadcrumbListener;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // Use "service" function for creating references to services when dropping support for Symfony 4.4
+    // Use "param" function for creating references to parameters when dropping support for Symfony 5.1
+    $containerConfigurator->services()
+
+        ->set('sonata.seo.event.breadcrumb', BreadcrumbListener::class)
+            ->tag('kernel.event_listener', [
+                'event' => 'sonata.block.event.breadcrumb',
+                'method' => 'onBlock',
+            ]);
+};
diff --git a/src/Resources/config/event.xml b/src/Resources/config/event.xml