Introduce AsGrid attribute for streamlined grid configuration #349
Conversation
This file contains 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
vasilvestre
changed the title
loic425
reviewed
Oct 22, 2024
vasilvestre
force-pushed
the
feat/attributes/as_grid
branch
from
4ad598f
to
8d8f7d0
Compare
vasilvestre
force-pushed
the
feat/attributes/as_grid
branch
from
2759ae2
to
a36f44a
Compare
loic425
reviewed
Oct 23, 2024
loic425
reviewed
Oct 23, 2024
diimpp
reviewed
Oct 25, 2024
src/Bundle/Tests/DependencyInjection/GridBuilderConfigurationTest.php
Outdated
Show resolved
Hide resolved
lchrusciel
reviewed
Nov 3, 2024
| use Sylius\Component\Grid\Attribute\AsGrid; | ||
|
|
||
| #[AsGrid(resourceClass: Foo::class)] | ||
| final class AttributeFooGrid extends AbstractGrid |
There was a problem hiding this comment.
Is it required to extend AbstractGrid to take advantage of AsGrid attribute?
There was a problem hiding this comment.
Nice catch, I will take a loot. AFAIK an interface should be enough
There was a problem hiding this comment.
So, the AbstractGrid fetches the name in attributes or via code.
If we use GridInterface, getName() and toArray() must be reimplemented.
Comment on lines
+22
to
+44
| public static function getName(): string | ||
| { | ||
| if ($attribute = self::getAttributes()) { | ||
| if (!empty($attribute[0])) { | ||
| return $attribute[0]->newInstance()->name ?? static::class; | ||
| } | ||
| } | ||
|
|
||
| return static::class; | ||
| } | ||
|
|
||
| public function getResourceClass(): string | ||
| { | ||
| if ($attribute = self::getAttributes()) { | ||
| return $attribute[0]->newInstance()->resourceClass; | ||
| } | ||
|
|
||
| throw new \LogicException(sprintf( | ||
| 'You have to implement %s method or use %s attribute.', | ||
| __METHOD__, | ||
| AsGrid::class, | ||
| )); | ||
| } |
There was a problem hiding this comment.
Is this code needed to make AsGrid useful?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
To simplify the configuration of grids and promote code clarity, this PR introduces a new attribute,
AsGrid, which allows developers to define the grid's name and resource class directly within their grid classes, eliminating the need for YAML configuration files.Previously, these properties were defined at usage which could cause code duplication.
By using the
AsGridattribute, developers can now explicitly declare the name and resource class of a grid directly above the class definition. This approach improves code readability, centralizes configuration, and enhances maintainability.Example usage:
This PR includes comprehensive tests and updated documentation to guide developers on using the new attribute.
Future considerations:
In a future PR, we can consider deprecating the YAML-based grid configuration in favor of the attribute-based approach to further streamline the grid creation process and improve consistency.