PhpCode as a new Transformer #1463
Open
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new PhpCode transformer system that allows developers to create custom PHP-based transformers for grid column values. The implementation uses Symfony's tagged service pattern to enable pluggable transformation logic.
Key changes:
- Adds a new
PhpCodetransformer with a resolver pattern for discovering and executing tagged PHP transformer services - Provides an example transformer (
ExamplePhpCodeTransformer) that converts strings to uppercase - Updates configuration and documentation to support the new transformer type
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
src/Grid/Column/Transformer/PhpCode/TaggedPhpCodeTransformerResolver.php |
Implements the resolver to locate transformer services by class name using Symfony's TaggedIterator |
src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerResolverInterface.php |
Defines the contract for resolving PhpCode transformers with service tag constant |
src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerInterface.php |
Defines the contract that custom PHP transformers must implement |
src/Grid/Column/Transformer/PhpCode/ExamplePhpCodeTransformer.php |
Provides a demonstration transformer that converts string values to uppercase |
src/Grid/Column/Transformer/PhpCode.php |
Main transformer class that delegates to tagged services based on configuration |
doc/03_Grid.md |
Adds documentation for the PhpCode transformer with usage examples |
config/grid.yaml |
Registers the PhpCode transformer and example transformer as tagged services |
src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerInterface.php
Outdated
Show resolved
Hide resolved
src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerInterface.php
Outdated
Show resolved
Hide resolved
martineiber
requested changes
Oct 20, 2025
src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerInterface.php
Outdated
Show resolved
Hide resolved
src/Grid/Column/Transformer/PhpCode/TaggedPhpCodeTransformerResolver.php
Outdated
Show resolved
Hide resolved
martineiber
requested changes
Oct 24, 2025
src/Grid/Service/Loader/TaggedIteratorPhpCodeTransformerLoader.php
Outdated
Show resolved
Hide resolved
src/Grid/Service/Loader/TaggedIteratorPhpCodeTransformerLoader.php
Outdated
Show resolved
Hide resolved
martineiber
requested changes
Oct 24, 2025
| } | ||
| } | ||
|
|
||
| throw new InvalidArgumentException( |
There was a problem hiding this comment.
You can use the NotFoundException
https://github.com/pimcore/studio-backend-bundle/blob/1.x/src/Exception/Api/NotFoundException.php
|
|
||
| foreach ($this->resolver->getTransformers() as $executable) { | ||
| $options[] = [ | ||
| 'value' => get_class($executable), |
There was a problem hiding this comment.
and we do not need to return the class_name only the key and name
doc/03_Grid.md
Outdated
| #### PhpCode Transformer | ||
|
|
||
| The `PhpCode` transformer delegates value transformation to a custom PHP class implementing the Pimcore\Bundle\StudioBackendBundle\Grid\Column\PhpCodeTransformerInterface. This allows developers to encapsulate complex transformation logic in reusable services. | ||
| To register a transformer, the service must be tagged with the appropriate Symfony service tag (e.g. studio_backend.grid.php_code_transformer) so it can be discovered by the system. |
There was a problem hiding this comment.
Suggested change
| To register a transformer, the service must be tagged with the appropriate Symfony service tag (e.g. studio_backend.grid.php_code_transformer) so it can be discovered by the system. | |
| To register a transformer, the service must be tagged with the appropriate Symfony service tag (studio_backend.grid.php_code_transformer) so it can be discovered by the system. |
| /** | ||
| * @internal | ||
| */ | ||
| final class PhpCodeTransformerCollectionException extends AbstractApiException |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes in this pull request
Resolves #1155
Additional info