feat: upgrade symfony versions to 3.4 up to 5

Author: Douglas Greenshields

Cache/ObjectCache.php

@@ -8,7 +8,7 @@
 /**
 * An object cache for oEmbed instances.
 */
-class ObjectCache implements ObjectCacheInterface
+class ObjectCache
 {
     /**
      * @var CacheInterface
@@ -27,7 +27,8 @@ public function __construct(CacheInterface $cache, OEmbedSerializerInterface $se
     }
 
     /**
-     * {@inheritdoc}
+     * @param string $key
+     * @return OEmbedInterface|null
      **/
     public function get($key)
     {
@@ -40,7 +41,9 @@ public function get($key)
     }
 
     /**
-     * {@inheritdoc}
+     * @param string $key
+     * @param OEmbedInterface $oEmbed
+     * @return void
      **/
     public function set($key, OEmbedInterface $oEmbed)
     {

Cache/ObjectCacheInterface.php

@@ -1,26 +1,38 @@
 <?php
 
-namespace Markup\OEmbedBundle\Command;
+namespace Markup\OEmbedBundle\Console;
 
 use Markup\OEmbedBundle\Exception\OEmbedUnavailableException;
 use Markup\OEmbedBundle\Service\OEmbedService;
-use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
 * A console command to fetch oEmbed instances and output their data.
 */
-class FetchOEmbedCommand extends ContainerAwareCommand
+class FetchOEmbedCommand extends Command
 {
+    protected static $defaultName = 'oembed:fetch';
+
+    /**
+     * @var OEmbedService
+     */
+    private $oEmbedService;
+
+    public function __construct(OEmbedService $oEmbedService)
+    {
+        $this->oEmbedService = $oEmbedService;
+        parent::__construct();
+    }
+
     /**
      * @return void
      */
     protected function configure()
     {
         $this
-            ->setName('oembed:fetch')
             ->setDescription('Makes a query against an oEmbed provider for data about a piece of media')
             ->addArgument('provider', InputArgument::REQUIRED, 'An oEmbed provider name')
             ->addArgument('media_id', InputArgument::REQUIRED, 'The ID of the piece of media being embedded.');
@@ -37,9 +49,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $startTime = microtime(true);
         try {
-            /** @var OEmbedService $oEmbedService */
-            $oEmbedService = $this->getContainer()->get('markup_oembed');
-            $oEmbed = $oEmbedService->fetchOEmbed($provider, $mediaId);
+            $oEmbed = $this->oEmbedService->fetchOEmbed($provider, $mediaId);
         } catch (OEmbedUnavailableException $e) {
             $output->writeln(sprintf('<error>Could not fetch the oEmbed data. Reported error: %s</error>', $e->getMessage()));
 

Command/FetchOEmbedCommand.php renamed to Console/FetchOEmbedCommand.php

@@ -17,8 +17,10 @@ class Configuration implements ConfigurationInterface
      */
     public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
-        $rootNode = $treeBuilder->root('markup_o_embed');
+        $treeBuilder = new TreeBuilder('markup_o_embed');
+        $rootNode = (method_exists(TreeBuilder::class, 'getRootNode'))
+            ? $treeBuilder->getRootNode()
+            : $treeBuilder->root('markup_o_embed');
 
         $rootNode
             ->fixXmlConfig('provider')

DependencyInjection/Configuration.php

@@ -2,10 +2,13 @@
 
 namespace Markup\OEmbedBundle\DependencyInjection;
 
+use Markup\OEmbedBundle\Cache\NullCache;
+use Markup\OEmbedBundle\Provider\SimpleProvider;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
@@ -45,10 +48,28 @@ private function loadProviders(array $config, ContainerBuilder $container)
         if (!isset($config['providers'])) {
             return;
         }
+        $providerLocator = $container->findDefinition('markup_oembed.provider_locator');
         foreach ($config['providers'] as $providerName => $provider) {
-            $definition = new Definition('Markup\OEmbedBundle\Provider\SimpleProvider', array($providerName, $provider['endpoint'], $provider['scheme'], $provider['code_property']));
+            $definition = (new Definition(
+                SimpleProvider::class,
+                [
+                    $providerName,
+                    $provider['endpoint'],
+                    $provider['scheme'],
+                    $provider['code_property'],
+                ]
+            ))->setPublic(false);
 
-            $container->setDefinition(sprintf('markup_oembed.provider.%s', $providerName), $definition);
+            $providerId = sprintf('markup_oembed.provider.%s', $providerName);
+            $container->setDefinition($providerId, $definition);
+            $providerLocator->setArguments([
+                array_merge(
+                    $providerLocator->getArguments()[0],
+                    [
+                        $providerName => new Reference($providerId),
+                    ]
+                )
+            ]);
         }
     }
 
@@ -75,7 +96,7 @@ private function loadCacheServices(array $config, ContainerBuilder $container)
     {
         $cacheServiceId = 'markup_oembed.string_cache';
         if (!isset($config['cache']) || !isset($config['cache']['id'])) {
-            $container->setDefinition($cacheServiceId, new Definition('Markup\OEmbedBundle\Cache\NullCache'));
+            $container->setDefinition($cacheServiceId, new Definition(NullCache::class));
         } else {
             $container->setAlias($cacheServiceId, $config['cache']['id']);
         }

DependencyInjection/MarkupOEmbedExtension.php

@@ -2,38 +2,37 @@ parameters:
     markup_oembed.cache_key_delimiter.default: ':'
 
 services:
-    markup_oembed:
-        class: 'Markup\OEmbedBundle\Service\OEmbedService'
+    Markup\OEmbedBundle\Service\OEmbedService:
         arguments:
-            - '@markup_oembed.client'
-            - '@markup_oembed.provider_factory'
-            - '@markup_oembed.object_cache'
-            - '%markup_oembed.cache_key_delimiter%'
-    markup_oembed.provider_factory:
-        class: Markup\OEmbedBundle\Provider\ProviderFactory
-        arguments:
-            - '@service_container'
-            - 'markup_oembed.provider'
-        public: false
-    markup_oembed.client.guzzle:
-        class: 'Markup\OEmbedBundle\Client\GuzzleClient'
+            $client: '@Markup\OEmbedBundle\Client\GuzzleClient'
+            $providerLocator: '@markup_oembed.provider_locator'
+            $cacheKeyDelimiter: '%markup_oembed.cache_key_delimiter%'
+        autowire: true
+    markup_oembed: '@Markup\OEmbedBundle\Service\OEmbedService'
+    Markup\OEmbedBundle\Client\GuzzleClient:
         public: false
-    markup_oembed.client:
-        alias: markup_oembed.client.guzzle
-    markup_oembed.twig.extension:
-        class: 'Markup\OEmbedBundle\Twig\Extension'
+    Markup\OEmbedBundle\Twig\Extension:
         arguments:
-            - '@markup_oembed'
-            - '%markup_oembed.squash_rendering_errors%'
+            $shouldSquashRenderingErrors: '%markup_oembed.squash_rendering_errors%'
+        autowire: true
         tags:
             - { name: twig.extension }
-    markup_oembed.serializer:
-        class: 'Markup\OEmbedBundle\Serializer\OEmbedSerializer'
+    Markup\OEmbedBundle\Serializer\OEmbedSerializer:
         public: false
 
-    markup_oembed.object_cache:
-        class: 'Markup\OEmbedBundle\Cache\ObjectCache'
+    Markup\OEmbedBundle\Cache\ObjectCache:
         arguments:
             - '@markup_oembed.string_cache'
-            - '@markup_oembed.serializer'
+            - '@Markup\OEmbedBundle\Serializer\OEmbedSerializer'
         public: false
+
+    markup_oembed.provider_locator:
+        class: Symfony\Component\DependencyInjection\ServiceLocator
+        tags: ['container.service_locator']
+        arguments: [[]]
+        public: false
+
+    Markup\OEmbedBundle\Console\:
+        resource: '../../Console/*'
+        autowire: true
+        autoconfigure: true

Provider/ProviderFactory.php

@@ -1,15 +1,17 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Markup\OEmbedBundle\Service;
 
-use Markup\OEmbedBundle\Cache\ObjectCacheInterface;
+use Markup\OEmbedBundle\Cache\ObjectCache;
 use Markup\OEmbedBundle\Client\ClientInterface;
 use Markup\OEmbedBundle\Exception\InvalidOEmbedContentException;
 use Markup\OEmbedBundle\Exception\OEmbedUnavailableException;
-use Markup\OEmbedBundle\Exception\ProviderNotFoundException;
 use Markup\OEmbedBundle\OEmbed\OEmbedInterface;
-use Markup\OEmbedBundle\Provider\ProviderFactory;
+use Markup\OEmbedBundle\Provider\ProviderInterface;
+use Psr\Container\ContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
 
 /**
 * A service for fetching oEmbed stuff from an implementing provider.
@@ -24,12 +26,12 @@ class OEmbedService
     private $client;
 
     /**
-     * @var ProviderFactory
-     **/
-    private $providerFactory;
+     * @var ContainerInterface
+     */
+    private $providerLocator;
 
     /**
-     * @var ObjectCacheInterface
+     * @var ObjectCache
      **/
     private $objectCache;
 
@@ -38,20 +40,14 @@ class OEmbedService
      **/
     private $cacheKeyDelimiter;
 
-    /**
-     * @param ClientInterface      $client
-     * @param ProviderFactory      $providerFactory
-     * @param ObjectCacheInterface $objectCache
-     * @param string               $cacheKeyDelimiter
-     **/
     public function __construct(
         ClientInterface $client,
-        ProviderFactory $providerFactory,
-        ObjectCacheInterface $objectCache,
-        $cacheKeyDelimiter = ':'
+        ContainerInterface $providerLocator,
+        ObjectCache $objectCache,
+        string $cacheKeyDelimiter = ':'
     ) {
         $this->client = $client;
-        $this->providerFactory = $providerFactory;
+        $this->providerLocator = $providerLocator;
         $this->objectCache = $objectCache;
         $this->cacheKeyDelimiter = $cacheKeyDelimiter;
     }
@@ -67,8 +63,9 @@ public function fetchOEmbed(string $provider, string $mediaId, array $parameters
         }
 
         try {
-            $providerObject = $this->providerFactory->fetchProvider($provider);
-        } catch (ProviderNotFoundException $e) {
+            /** @var ProviderInterface $providerObject */
+            $providerObject = $this->providerLocator->get($provider);
+        } catch (NotFoundExceptionInterface $e) {
             throw new OEmbedUnavailableException($e->getMessage(), 0, $e);
         }