Inheritance diagram for MetadataInterface:
Public Member Functions | |
| getAttributes ($formCode) | |
| getAttributeMetadata ($attributeCode) | |
| getAllAttributesMetadata () | |
| getCustomAttributesMetadata ($dataInterfaceName='') | |
Detailed Description
Interface for getting attributes metadata. Note that this interface should not be used directly, use its children. @api
- Since
- 100.0.2
Definition at line 14 of file MetadataInterface.php.
Member Function Documentation
◆ getAllAttributesMetadata()
| getAllAttributesMetadata | ( | ) |
Get all attribute metadata.
- Returns
- \Magento\Customer\Api\Data\AttributeMetadataInterface[]
- Exceptions
-
Implemented in CachedMetadata.
◆ getAttributeMetadata()
| getAttributeMetadata | ( | $attributeCode | ) |
Retrieve attribute metadata.
- Parameters
-
string $attributeCode
- Returns
- \Magento\Customer\Api\Data\AttributeMetadataInterface
- Exceptions
-
Implemented in CachedMetadata.
◆ getAttributes()
| getAttributes | ( | $formCode | ) |
Retrieve all attributes filtered by form code
- Parameters
-
string $formCode
- Returns
- \Magento\Customer\Api\Data\AttributeMetadataInterface[]
- Exceptions
-
Implemented in AddressMetadata, and CachedMetadata.
◆ getCustomAttributesMetadata()
| getCustomAttributesMetadata | ( | $dataInterfaceName = '' | ) |
Get custom attributes metadata for the given data interface.
- Parameters
-
string $dataInterfaceName
- Returns
- \Magento\Customer\Api\Data\AttributeMetadataInterface[]
- Exceptions
-
Implements MetadataServiceInterface.
Implemented in AddressMetadata, CustomerMetadata, and CachedMetadata.
The documentation for this interface was generated from the following file:
- vendor/magento/module-customer/Api/MetadataInterface.php