AreasContent (Api)

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.

Property Description Type
id ID of the content of the layout area int
type Name of the Input Type for the layout area string
category Category of content as defined in the input type string
editor Editor of content as defined in the input type string
text Text representation of the content string
active Only returned for text category content. Used for switch input content. Returns true if the switch is set. bool
record 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. array
records Only returned for record category content. Returns an array containing all linked records. Otherwise, similar to getRecord. array
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. Component
collection Only returned for collection category content. Returns an array with the component collection contained in the area. Otherwise, similar to getComponent. Component
imageId Only returned for image category content. Returns the ID of the contained image. int
imagePath Only returned for image category content. Returns the path of the contained image. string
fileId Only returned for file category content. Returns the ID of the contained file. int
filePath Only returned for file category content. Returns the path of the contained file. string
widgetId Only returned for widget category content. Returns the ID of the contained widget. Widget