ModelOrders module

MetadataField

A model in the Orders module, with 11 members for templates, 8 API properties and 16 members for admin templates.

Orders\Models\Frontend\MetadataField Orders\Models\Api\MetadataField Orders\Models\Backend\MetadataField Also in Orders: MetadataFieldValue 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 11

Take no arguments.

# getValueProperty()
string
Get the property holding the value in MetadataFieldValue
# getId()
?int
# getName()
?string
# getIdentifier()
?string
# getDataType()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getSite()
?Site
# 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 8

Read-only values on the record.

# valueProperty
string
Get the property holding the value in MetadataFieldValue
# id
?int
# name
?string
# identifier
?string
# dataType
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# site
?Site

Admin view

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

Properties 16

Take no arguments.

# getValueProperty()
string
Get the property holding the value in MetadataFieldValue
# getId()
?int
# getName()
?string
# getIdentifier()
?string
# getDataType()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getSite()
?Site
# 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
# getAvailableDataTypes() Admin only
array
Get the available data types
# getEditUrl() Admin only
?string
Get the url for editing the record.
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.
# getManageUrl() Admin only
?string
Get the url for managing records.