ModelOrders module

MetadataFieldValue

A model in the Orders module, with 12 members for templates, 9 API properties and 12 members for admin templates.

Orders\Models\Frontend\MetadataFieldValue Orders\Models\Api\MetadataFieldValue Orders\Models\Backend\MetadataFieldValue Also in Orders: MetadataField Order Refund RefundItem
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 12

Take no arguments.

# getValue()
?string
Gets the value according to the metadata field type. Number types are returned as numeric strings.
# getId()
?int
# getTextValue()
?string
# getNumberValue()
?string
# getBooleanValue()
?bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getMetadataField()
?MetadataField
# getOrder()
?BaseOrder
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 9

Read-only values on the record.

# value
?string
Gets the value according to the metadata field type. Number types are returned as numeric strings.
# id
?int
# textValue
?string
# numberValue
?string
# booleanValue
?bool
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# metadataField
?MetadataField
# order
?BaseOrder

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 12

Take no arguments.

# getValue()
?string
Gets the value according to the metadata field type. Number types are returned as numeric strings.
# getId()
?int
# getTextValue()
?string
# getNumberValue()
?string
# getBooleanValue()
?bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getMetadataField()
?MetadataField
# getOrder()
?BaseOrder
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned