-
Notifications
You must be signed in to change notification settings - Fork 2
NGSTACK-901 implement decorator service for variation path generator #51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hknezevic
wants to merge
3
commits into
1.7
Choose a base branch
from
NGSTACK-901-webp-support
base: 1.7
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+79
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
47 changes: 47 additions & 0 deletions
47
bundle/Core/Imagine/VariationPathGenerator/WebpFormatVariationPathGenerator.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Netgen\Bundle\SiteBundle\Core\Imagine\VariationPathGenerator; | ||
|
||
use eZ\Bundle\EzPublishCoreBundle\Imagine\VariationPathGenerator; | ||
use Liip\ImagineBundle\Imagine\Filter\FilterConfiguration; | ||
|
||
use function pathinfo; | ||
use function preg_replace; | ||
|
||
/** | ||
* Decorates VariationPathGenerator with .webp extension if image variation is configured for this format. | ||
*/ | ||
final class WebpFormatVariationPathGenerator implements VariationPathGenerator | ||
{ | ||
private VariationPathGenerator $innerVariationPathGenerator; | ||
|
||
private FilterConfiguration $filterConfiguration; | ||
|
||
public function __construct( | ||
VariationPathGenerator $innerVariationPathGenerator, | ||
FilterConfiguration $filterConfiguration | ||
) { | ||
$this->innerVariationPathGenerator = $innerVariationPathGenerator; | ||
$this->filterConfiguration = $filterConfiguration; | ||
} | ||
|
||
public function getVariationPath($originalPath, $filter): string | ||
{ | ||
$variationPath = $this->innerVariationPathGenerator->getVariationPath($originalPath, $filter); | ||
$filterConfig = $this->filterConfiguration->get($filter); | ||
|
||
if (!isset($filterConfig['format']) || $filterConfig['format'] !== 'webp') { | ||
return $variationPath; | ||
} | ||
|
||
$info = pathinfo($originalPath); | ||
|
||
if (!is_string($info['extension']) || strlen($info['extension']) === 0) { | ||
return $variationPath . '.webp'; | ||
} | ||
|
||
return preg_replace("/\.{$info['extension']}$/", '.webp', $variationPath); | ||
} | ||
} |
31 changes: 31 additions & 0 deletions
31
bundle/DependencyInjection/Compiler/WebpFormatVariationPathGeneratorDecoratorPass.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Netgen\Bundle\SiteBundle\DependencyInjection\Compiler; | ||
|
||
use Netgen\Bundle\SiteBundle\Core\Imagine\VariationPathGenerator\WebpFormatVariationPathGenerator; | ||
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
use Symfony\Component\DependencyInjection\Reference; | ||
|
||
class WebpFormatVariationPathGeneratorDecoratorPass implements CompilerPassInterface | ||
{ | ||
/** | ||
* Decorates default image alias variation path generator to comply with legacy variation URL pattern | ||
*/ | ||
public function process(ContainerBuilder $container): void | ||
{ | ||
if (!$container->has('ezpublish.image_alias.variation_path_generator')) { | ||
return; | ||
} | ||
|
||
$container->register( | ||
'ezpublish.image_alias.webp_variation_path_generator_decorator', | ||
WebpFormatVariationPathGenerator::class, | ||
) | ||
->setDecoratedService('ezpublish.image_alias.variation_path_generator') | ||
->addArgument(new Reference('ezpublish.image_alias.webp_variation_path_generator_decorator.inner')) | ||
->addArgument(new Reference('liip_imagine.filter.configuration')); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need the compiler pass just to register a decorator?
Can't we do this through the service config in YAML files?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Half of my life you force me to write compiler passes, now you want me to add it in the config 😆
I wasn't initially sure if we want to make the decorator service enabled by default, or if we will need to introduce a switch through configuration. @vjeran wants this enabled by default in both legacy admin and symfony/ezplatform, so maybe no need for the compiler pass.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Compiler passes should be used when modifying eixsting services! With this, we're not modifying an existing service, but adding a new one.
Besides, we're already using decorators directly in yaml files.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's leave it like this for consistency sake, as we will be using the compiler pass to actually decorate the existing variation path generator in Ibexa 4.x with our own service. If we are using 4.x in combination with legacy admin, then this is needed to consolidate variation path patterns to match the ones from legacy. The compiler pass in that case will replace ibexa decorator class with our own.