vendor/liip/imagine-bundle/DependencyInjection/Compiler/AssetsVersionCompilerPass.php line 37

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the `liip/LiipImagineBundle` project.
  5.  *
  6.  * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE.md
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Liip\ImagineBundle\DependencyInjection\Compiler;
  14. use Symfony\Component\Asset\VersionStrategy\JsonManifestVersionStrategy;
  15. use Symfony\Component\Asset\VersionStrategy\StaticVersionStrategy;
  16. use Symfony\Component\DependencyInjection\ContainerBuilder;
  18. /**
  19.  * Inject the Symfony framework assets version parameter to the
  20.  * LiipImagineBundle twig extension if possible.
  21.  *
  22.  * We extract either:
  23.  *  - the version parameter from the StaticVersionStrategy service
  24.  *  - the json manifest from the JsonManifestVersionStrategy service
  25.  * If anything is not as expected, we log a warning and do nothing.
  26.  *
  27.  * The expectation is for the user to configure the assets version in liip
  28.  * imagine for custom setups.
  29.  *
  30.  * Anything other than StaticVersionStrategy or JsonManifestVersionStrategy needs
  31.  * to be implemented by the user in CacheResolveEvent event listeners.
  32.  */
  33. class AssetsVersionCompilerPass extends AbstractCompilerPass
  34. {
  35.     public function process(ContainerBuilder $container): void
  36.     {
  37.         if (!class_exists(StaticVersionStrategy::class)
  38.             // this application has no asset version configured
  39.             || !$container->has('assets._version__default')
  40.             // we are not using the new LazyFilterRuntime
  41.             || !$container->hasDefinition('liip_imagine.templating.filter_runtime')
  42.         ) {
  43.             return;
  44.         }
  45.         $runtimeDefinition = $container->getDefinition('liip_imagine.templating.filter_runtime');
  46.         if (null !== $runtimeDefinition->getArgument(1)) {
  47.             // the asset version has been set explicitly
  48.             return;
  49.         }
  51.         $versionStrategyDefinition = $container->findDefinition('assets._version__default');
  52.         if (!is_a($versionStrategyDefinition->getClass(), StaticVersionStrategy::class, true)
  53.             && !is_a($versionStrategyDefinition->getClass(), JsonManifestVersionStrategy::class, true)
  54.         ) {
  55.             $this->log($container, 'Symfony assets versioning strategy "'.$versionStrategyDefinition->getClass().'" not automatically supported. Configure liip_imagine.twig.assets_version if you have problems with assets versioning');
  57.             return;
  58.         }
  59.         $version = $versionStrategyDefinition->getArgument(0);
  60.         $format = $versionStrategyDefinition->getArgument(1);
  61.         $format = $container->resolveEnvPlaceholders($format);
  62.         if ($format && !$this->str_ends_with($format, '?%%s')) {
  63.             $this->log($container, 'Can not handle assets versioning with custom format "'.$format.'". asset twig function can likely not be used with the imagine_filter');
  65.             return;
  66.         }
  68.         $runtimeDefinition->setArgument(1, $version);
  70.         if (is_a($versionStrategyDefinition->getClass(), JsonManifestVersionStrategy::class, true)) {
  71.             $jsonManifestString = file_get_contents($version);
  73.             if (!\is_string($jsonManifestString)) {
  74.                 $this->log($container, 'Can not handle assets versioning with "'.$versionStrategyDefinition->getClass().'". The manifest file at "'.$version.' " could not be read');
  76.                 return;
  77.             }
  78.             $jsonManifest = json_decode($jsonManifestString, true);
  79.             if (!\is_array($jsonManifest)) {
  80.                 $this->log($container, 'Can not handle assets versioning with "'.$versionStrategyDefinition->getClass().'". The manifest file at "'.$version.' " does not contain valid JSON');
  82.                 return;
  83.             }
  84.             $runtimeDefinition->setArgument(1, null);
  85.             $runtimeDefinition->setArgument(2, $jsonManifest);
  86.         }
  87.     }
  89.     /**
  90.      * Can be replaced with the built-in method when dropping support for PHP < 8.0
  91.      */
  92.     private function str_ends_with(string $haystack, string $needle): bool
  93.     {
  94.         return mb_substr($haystack, -mb_strlen($needle)) === $needle;
  95.     }
  96. }