ModelUsers module

PrivilegeTarget

A model in the Users module, with 11 members for templates, 8 API properties and 11 members for admin templates.

Users\Models\Frontend\PrivilegeTarget Users\Models\Api\PrivilegeTarget Users\Models\Backend\PrivilegeTarget Also in Users: ApiKey Author AuthorCustomFieldValue Group GroupPrivilege LoginToken Person PersonAddress PersonAddressType PersonCustomFieldValue Setting SettingValue User UserAcl UserCustomFieldValue UserPrivilege
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 11

Take no arguments.

# hasPermissions()
bool
Check if the PrivilegeTarget has any assigned permissions
# getId()
?int
# getModule()
?string
# getEntity()
?string
# getRecordId()
?int
# getDefaultMode()
?int
# getUserPrivileges()
?Collection<UserPrivilege>
# getGroupPrivileges()
?Collection<GroupPrivilege>
# 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 8

Read-only values on the record.

# permissions
bool
Check if the PrivilegeTarget has any assigned permissions
# id
?int
# module
?string
# entity
?string
# recordId
?int
# defaultMode
?int
# userPrivileges
?Collection<UserPrivilege>
# groupPrivileges
?Collection<GroupPrivilege>

Admin view

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

Properties 11

Take no arguments.

# hasPermissions()
bool
Check if the PrivilegeTarget has any assigned permissions
# getId()
?int
# getModule()
?string
# getEntity()
?string
# getRecordId()
?int
# getDefaultMode()
?int
# getUserPrivileges()
?Collection<UserPrivilege>
# getGroupPrivileges()
?Collection<GroupPrivilege>
# 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