ModelAdmin module

Notification

Notification for showing on Backend for users

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

Admin\Models\Frontend\Notification Admin\Models\Api\Notification Admin\Models\Backend\Notification Also in Admin: Job MenuElement
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.

# getId()
?int
# getStatus()
?string
# getMessage()
?string
# getLinkLabel()
?string
Action label rendered for the link instead of the raw URL, already translated by the notification's creator. Null falls back to a generic label.
# getCreated()
?DateTime
Date the record was created.
# getSeen()
?DateTime
Returns a value when notification was seen by user
# isSeen()
bool
Returns if notifications was seen (not necessary read) by a user
# getRead()
?DateTime
Returns a value when notification was read by user
# isRead()
bool
Returns if notifications was read by a user
# getCreatedBy()
?User
# 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 11

Read-only values on the record.

# id
?int
# status
?string
# message
?string
# linkLabel
?string
Action label rendered for the link instead of the raw URL, already translated by the notification's creator. Null falls back to a generic label.
# created
?DateTime
Date the record was created.
# seen
?DateTime
Returns a value when notification was seen by user
# seen
bool
Returns if notifications was seen (not necessary read) by a user
# read
?DateTime
Returns a value when notification was read by user
# read
bool
Returns if notifications was read by a user
# createdBy
?User

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.

# getId()
?int
# getStatus()
?string
# getMessage()
?string
# getLinkLabel()
?string
Action label rendered for the link instead of the raw URL, already translated by the notification's creator. Null falls back to a generic label.
# getCreated()
?DateTime
Date the record was created.
# getSeen()
?DateTime
Returns a value when notification was seen by user
# isSeen()
bool
Returns if notifications was seen (not necessary read) by a user
# getRead()
?DateTime
Returns a value when notification was read by user
# isRead()
bool
Returns if notifications was read by a user
# getCreatedBy()
?User
# 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
# getCreatedLocalDatetimeString() Admin only
string
Returns created date and time as localized string (as set up in config).
# getCreatedAgoString() Admin only
string
Returns created date and time in "some time ago" format. It could be second, minute, hour, day, week, month, year.