Core classCommon\Classes

AreasContent

This class allows retrieving content of layout areas in a map-style manner from the API. The keys of the map are the layout area names, whereas the values will be the content for that layout area. By default, this class renders the following fields, but customization is possible through standard property definition.

Common\Classes\AreasContent

Fields 15

#id
int
ID of the content of the layout area
#type
string
Name of the Input Type for the layout area
#category
string
Category of content as defined in the input type
#editor
string
Editor of content as defined in the input type
#text
?string
Text representation of the content
#active
bool
Only returned for text category content. Used for switch input content. Returns true if the switch is set.
#record
?array
Only returned for record category content. Returns properties of the linked record. By default, id and fullPath are returned, but different properties can be specified based on the linked record model.
#records
array
Only returned for record category content. Returns an array containing all linked records. Otherwise, similar to getRecord.
#component
?Component
Only returned for component category content. Returns the component contained in the area. By default, the properties id, name, layout.id and global are passed as componentId, componentName, componentLayout and componentGlobal. Can be adjusted using properties.
#collection
?Component
Only returned for collection category content. Returns an array with the component collection contained in the area. Otherwise, similar to getComponent.
#imageId
?int
Only returned for image category content. Returns the ID of the contained image.
#imagePath
?string
Only returned for image category content. Returns the path of the contained image.
#fileId
?int
Only returned for file category content. Returns the ID of the contained file.
#filePath
?string
Only returned for file category content. Returns the path of the contained file.
#widgetId
?Widget
Only returned for widget category content. Returns the ID of the contained widget.