ModelHooks module

Condition

Condition Entity

A model in the Hooks module, with 24 members for templates, 21 API properties and 26 members for admin templates.

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 24

Take no arguments.

# getIf()
?ConditionIf
Return the if part of the condition
# getIfs()
Collection
Return all if's and else if's of the condition
# getElseIfs()
Collection
Return all else if's of the condition
# getElse()
?ConditionElse
Return the else part of the condition
# getChildren()
Collection<BaseAction>
# getType()
string
Get the type of the action, which is the object name without namespace for the action
# getDisplayType()
string
Get Nice Name for Action Class
# getAvailablePreviousActions()
Collection
Get the available previous actions
# getId()
?int
# getName()
?string
# getText()
?string
# getPosition()
?int
# getData()
?array
# getCreated()
?DateTime
# getModified()
?DateTime
# getHook()
?Hook
Get the Hook this Action is assigned to
# getParent()
?BaseAction
# getPublished()
?DateTime
# isPublished()
bool
# isContainedInLoop()
bool
Check whether the action is contained in a loop
# getContainingLoop()
?Loop
Get the loop this action is contained in
# 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 21

Read-only values on the record.

# if
?ConditionIf
Return the if part of the condition
# ifs
Collection
Return all if's and else if's of the condition
# elseIfs
Collection
Return all else if's of the condition
# else
?ConditionElse
Return the else part of the condition
# children
Collection<BaseAction>
# type
string
Get the type of the action, which is the object name without namespace for the action
# displayType
string
Get Nice Name for Action Class
# availablePreviousActions
Collection
Get the available previous actions
# id
?int
# name
?string
# text
?string
# position
?int
# data
?array
# created
?DateTime
# modified
?DateTime
# hook
?Hook
Get the Hook this Action is assigned to
# parent
?BaseAction
# published
?DateTime
# published
bool
# containedInLoop
bool
Check whether the action is contained in a loop
# containingLoop
?Loop
Get the loop this action is contained in

Admin view

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

Properties 26

Take no arguments.

# getIf()
?ConditionIf
Return the if part of the condition
# getIfs()
Collection
Return all if's and else if's of the condition
# getElseIfs()
Collection
Return all else if's of the condition
# getElse()
?ConditionElse
Return the else part of the condition
# getChildren()
Collection<BaseAction>
# getType()
string
Get the type of the action, which is the object name without namespace for the action
# getDisplayType()
string
Get Nice Name for Action Class
# getAvailablePreviousActions()
Collection
Get the available previous actions
# getId()
?int
# getName()
?string
# getText()
?string
# getPosition()
?int
# getData()
?array
# getCreated()
?DateTime
# getModified()
?DateTime
# getHook()
?Hook
Get the Hook this Action is assigned to
# getParent()
?BaseAction
# getPublished()
?DateTime
# isPublished()
bool
# isContainedInLoop()
bool
Check whether the action is contained in a loop
# getContainingLoop()
?Loop
Get the loop this action is contained in
# 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
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.