ModelBooks module

BookCustomFieldValue

A model in the Books module, with 14 members for templates, 11 API properties and 13 members for admin templates.

Books\Models\Frontend\BookCustomFieldValue Books\Models\Api\BookCustomFieldValue Books\Models\Backend\BookCustomFieldValue Also in Books: Book Page PageCustomFieldValue Unit UnitCustomFieldValue
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 14

Take no arguments.

# __toString() Templates only
string
Handle string representation for custom field value
# getBook()
?Book
# getName()
string
# getType()
?InputType
# isImage()
bool
Return if the custom field is an image
# getHtml()
string
Get the HTML for this custom field
# getId()
?int
# getContent()
?Content
# getSite()
?Site
# getCustomField()
?CustomField
# getCreated()
?DateTime
Get the date the record was created.
# getModified()
?DateTime
Get the last modification date for the record.
# 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

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 11

Read-only values on the record.

# book
?Book
# name
string
# type
?InputType
# image
bool
Return if the custom field is an image
# html
string
Get the HTML for this custom field
# id
?int
# content
?Content
# site
?Site
# customField
?CustomField
# created
?DateTime
Get the date the record was created.
# modified
?DateTime
Get the last modification date for the record.

Admin view

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

Properties 13

Take no arguments.

# getBook()
?Book
# getName()
string
# getType()
?InputType
# isImage()
bool
Return if the custom field is an image
# getHtml()
string
Get the HTML for this custom field
# getId()
?int
# getContent()
?Content
# getSite()
?Site
# getCustomField()
?CustomField
# getCreated()
?DateTime
Get the date the record was created.
# getModified()
?DateTime
Get the last modification date for the record.
# 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