PhpCode as a new Transformer #1463

stunnerparas · 2025-10-20T10:19:11Z

Changes in this pull request

Resolves #1155

Additional info

Copilot

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 PhpCode transformer 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

Copilot · 2025-10-20T12:03:46Z

src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerInterface.php

+{
+    /**
+     * @param mixed $value
+     * @param array $arguments


Remove the @param array $arguments annotation. The array type is already declared in the method signature, making this annotation redundant according to the coding guidelines.

Suggested change

* @param array $arguments

Copilot · 2025-10-20T12:03:47Z

src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerInterface.php

+interface PhpCodeTransformerInterface
+{
+    /**
+     * @param mixed $value


Remove the @param mixed $value annotation. The mixed type is already declared in the method signature, making this annotation redundant according to the coding guidelines.

Suggested change

* @param mixed $value

Copilot · 2025-10-20T12:03:47Z

src/Grid/Column/PhpCodeTransformerInterface.php

+     * @param mixed $value
+     * @param array $arguments
+     *
+     * @return AdvancedValue[]


Remove the @return AdvancedValue[] annotation. The return type array is already declared in the method signature. If more specificity about the array contents is needed, consider using a typed return such as a collection class, otherwise the annotation is redundant.

Suggested change

* @return AdvancedValue[]

Copilot · 2025-10-20T12:03:48Z

src/Grid/Column/Transformer/PhpCode.php

+    public function transform(array $value, array $config): array
+    {
+        $phpClass  =  $config['phpClass'] ?? null;
+        $arguments =  $config['arguments'] ?? [];


Remove extra spaces around the assignment operator. Use single spaces: $phpClass = $config['phpClass'] ?? null; and $arguments = $config['arguments'] ?? [];

Suggested change

$arguments = $config['arguments'] ?? [];

$arguments = $config['arguments'] ?? [];

Copilot · 2025-10-20T12:03:48Z

src/Grid/Column/Transformer/PhpCode.php

+            $results[] = new AdvancedValue(
+                'string',
+                $transformed[0] ?? null,
+                $val->getFieldName()
+            );


Accessing only the first element $transformed[0] from the transformer's result array discards any additional transformed values. Consider documenting why only the first element is used or handling multiple values if the transformer returns more than one.

Suggested change

$results[] = new AdvancedValue(

'string',

$transformed[0] ?? null,

$val->getFieldName()

);

// Handle all transformed values, not just the first

foreach ($transformed as $t) {

$results[] = new AdvancedValue(

'string',

$t,

$val->getFieldName()

);

}

martineiber

Some minor changes.

And the API Endpoint for listing the Tagged Services is still missing.

martineiber · 2025-10-20T12:08:26Z

config/grid.yaml

+  #
+  # Example Transformer
+  #
+  Pimcore\Bundle\StudioBackendBundle\Grid\Column\Transformer\PhpCode\ExamplePhpCodeTransformer:


We do not need a Example Service.

martineiber · 2025-10-20T12:11:40Z

doc/03_Grid.md

+**Available Configurations:**
+
+-   `phpClass`: The fully qualified class name of the transformer to execute. Must implement PhpCodeTransformerInterface.
+-   `arguments`: A key-value map of arguments passed to the transformer. These can be used to customize the transformation logic.


We do not need arguments we just want to call the Service. It should be possible to just implement a Service without adopting the Frontend. If that is needed we can implement a custom Transformer there we can set the "config"

martineiber · 2025-10-20T12:12:04Z

doc/03_Grid.md

+
+#### PhpCode Transformer
+
+The `PhpCode` transformer delegates value transformation to a custom PHP class implementing the PhpCodeTransformerInterface. This allows developers to encapsulate complex transformation logic in reusable services. You can specify the class to use via its fully qualified name (phpClass) and pass custom arguments to control its behavior. This is ideal for advanced use cases where transformation logic depends on external services, dynamic configuration, or custom business rules.


Can you link the Interface?

Yes. if it's registered as a service and tagged appropriately.

martineiber · 2025-10-20T12:13:50Z

src/Grid/Column/Transformer/PhpCode.php

+        $transformer = $this->resolver->resolve($phpClass);
+
+        $results = [];
+        foreach ($value as $val) {


Do not loop over the Values pass it directly to the Service.

martineiber · 2025-10-20T12:15:00Z

src/Grid/Column/Transformer/PhpCode/PhpCodeTransformerInterface.php

+/**
+ * @internal
+ */


Should not be internal.

martineiber · 2025-10-20T12:18:00Z

src/Grid/Column/Transformer/PhpCode/TaggedPhpCodeTransformerResolver.php

+/**
+ * @internal
+ */
+final readonly class TaggedPhpCodeTransformerResolver implements PhpCodeTransformerResolverInterface


Follow this Naming Convention for loading TaggedIerator.
https://github.com/pimcore/studio-backend-bundle/tree/826a6d30eb37976b5f9d9fe0c961d5ffe0edf92d/src/Grid/Service/Loader

And also check if the right Interface is implemented in the Service.
https://github.com/pimcore/studio-backend-bundle/blob/e19035b117c060a5e78b6439dba8dd8be98b7a3e/src/DependencyInjection/CompilerPass/GridColumnCollectorPass.php

…itanceData (#1462)

sonarqubecloud · 2025-10-22T08:13:23Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

stunnerparas and others added 6 commits October 20, 2025 10:17

PhpCode as a new Transformer

264df1f

Apply php-cs-fixer changes

5b03ae2

Updating the docs

08b51a6

Fix ci issue

06723c2

Apply php-cs-fixer changes

e2f68c3

Minor fixees

2b423c6

stunnerparas requested review from Copilot and martineiber October 20, 2025 12:02

Copilot AI reviewed Oct 20, 2025

View reviewed changes

martineiber assigned stunnerparas Oct 20, 2025

martineiber added the Task label Oct 20, 2025

martineiber added this to the next milestone Oct 20, 2025

pimcore deleted a comment from Copilot AI Oct 20, 2025

martineiber requested changes Oct 20, 2025

View reviewed changes

martineiber modified the milestones: 0.10.21, next Oct 21, 2025

martineiber and others added 6 commits October 21, 2025 20:46

[Grid] Inheritance of Classification Store Delivers an array of Inher…

ad7837a

…itanceData (#1462)

Organize the naming convention and minor code adjustment

76f31a4

Added Php code new end point and minor adjustments

b01189c

Conflict fix

ea3883d

Apply php-cs-fixer changes

d7cf7ac

Fix issue

6377a3d

stunnerparas requested a review from martineiber October 22, 2025 08:22

	$arguments = $config['arguments'] ?? [];
	$arguments = $config['arguments'] ?? [];


		#### PhpCode Transformer

		The `PhpCode` transformer delegates value transformation to a custom PHP class implementing the PhpCodeTransformerInterface. This allows developers to encapsulate complex transformation logic in reusable services. You can specify the class to use via its fully qualified name (phpClass) and pass custom arguments to control its behavior. This is ideal for advanced use cases where transformation logic depends on external services, dynamic configuration, or custom business rules.

PhpCode as a new Transformer #1463

Are you sure you want to change the base?

PhpCode as a new Transformer #1463

Uh oh!

Conversation

stunnerparas commented Oct 20, 2025 • edited by martineiber Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes in this pull request

Additional info

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

martineiber left a comment

Choose a reason for hiding this comment

Uh oh!

martineiber Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

martineiber Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

martineiber Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

stunnerparas Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

martineiber Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

martineiber Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

martineiber Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Oct 22, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

stunnerparas commented Oct 20, 2025 •

edited by martineiber

Loading