Standardize the array structure for the getAttributes result #23818
Conversation
|
Hi @thomas-kl1. Thank you for your contribution
For more details, please, review the Magento Contributor Assistant documentation |
| * @throws \Exception | ||
| */ | ||
| public function getAttributes($entityType) | ||
| public function getAttributes($entityType): array |
There was a problem hiding this comment.
Unfortunately, we are not allowed to change public method signature according to our Backward Compatible Development Guide
| @@ -48,14 +49,14 @@ public function __construct( | |||
| * @param object $entity | |||
| * @return void | |||
| */ | |||
| public function registerSnapshot($entityType, $entity) | |||
| public function registerSnapshot($entityType, $entity): void | |||
There was a problem hiding this comment.
Unfortunately, we are not allowed to change public method signature according to our Backward Compatible Development Guide
| @@ -65,7 +66,7 @@ public function registerSnapshot($entityType, $entity) | |||
| * @param object $entity | |||
| * @return bool | |||
| */ | |||
| public function isModified($entityType, $entity) | |||
| public function isModified($entityType, $entity): bool | |||
There was a problem hiding this comment.
Unfortunately, we are not allowed to change public method signature according to our Backward Compatible Development Guide
| * @throws \Exception | ||
| */ | ||
| public function getAttributes($entityType) | ||
| public function getAttributes($entityType): array |
There was a problem hiding this comment.
Unfortunately, we are not allowed to change public method signature according to our Backward Compatible Development Guide
| */ | ||
| public function getAttributes($entityType); | ||
| public function getAttributes($entityType): array; |
There was a problem hiding this comment.
Unfortunately, we are not allowed to change public method signature according to our Backward Compatible Development Guide
ghost
assigned
|
Hi @sidolov, thank you for the review.
|
|
Hi @thomas-kl1, thank you for your contribution! |
VladimirZaets
added
the
Auto-Tests: Not Required
The scope of this pull request is to fix two issues in the
\Magento\Framework\Model\EntitySnapshotpackage. It makes more convenient the results ofgetAttributes.Description (*)
The
getAttributesmethod of the\Magento\Framework\Model\EntitySnapshot\AttributeProviderInterfacehas no standardized structure in its available implementations.\Magento\Framework\Model\EntitySnapshot\AttributeProviderdeal with a dictionary where\Magento\Eav\Model\AttributeProviderreturns a simple list of attribute code.I have assumed that the results should be a list of field (as described in the methods description).
Contribution checklist (*)