☰ Browse the reference

Model·Users module

Author

A model in the Users module, with 30 members for templates, 19 API properties and 34 members for admin templates.

Users\Models\Frontend\AuthorCopy Users\Models\Api\AuthorCopy Users\Models\Backend\AuthorCopy Also in Users: ApiKey AuthorCustomFieldValue Group GroupPrivilege LoginToken Person PersonAddress PersonAddressType PersonCustomFieldValue PrivilegeTarget Setting SettingValue User UserAcl UserCustomFieldValue UserPrivilege

View

Templates30 API & Jobs19 Admin34

What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Filter

Templates view

Properties 21

Take no arguments.

# hasGravatar()

bool

Check if the author has a gravatar

# getGravatarUrl()

string

Get the gravatar url for the author

# getDisplayName()

string

Get the display name for the author

# getId()

?int

# getSlug()

?string

# getText()

?string

# getWebsite()

?string

# getUseGravatar()

bool

# getGravatarEmail()

?string

# getFacebookUrl()

?string

# getTwitterUrl()

?string

# getLinkedinUrl()

?string

# getCreated()

?DateTime

Get the date the record was created.

# getModified()

?DateTime

Get the last modification date for the record.

# getPerson()

?Person

# getImage()

?Image

# getCustomFieldValues()

?Collection<AuthorCustomFieldValue>

# getCustomFields()

array

Get the custom fields for this entity

# 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

Methods 9

Take arguments. The API serialises only getters that need none.

# getCustomFieldValue(CustomField $customField)

?CustomFieldValue

Get the value for a custom field

# getCustomFieldValueByName(string $customFieldName)

?CustomFieldValue

Get the value for a custom field by the custom field name

# getCustomFieldContent(string $customFieldName)

?Content

Get the content for the custom field identified by the specified name

# getCustomFieldContentOrDefault(string $customFieldName)

?Content

Get the (default) content for the custom field identified by the specified name

# getCustomFieldBoolean(string $customFieldName, ?bool $default)

?bool

Get the (default) content of the custom field as boolean value

# getCustomFieldText(string $customFieldName, ?string $default)

?string

Get the (default) content of the custom field as text

# getCustomFieldImage(string $customFieldName)

?Image

Get the (default) image contained in the custom field

# getCustomFieldFile(string $customFieldName)

?File

Get the (default) file contained in the custom field

# hasCustomField(string $customFieldName)

bool

Check if the entity has a custom field with the specified name

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 19

Read-only values on the record.

# gravatar

bool

Check if the author has a gravatar

# gravatarUrl

string

Get the gravatar url for the author

# displayName

string

Get the display name for the author

# id

?int

# slug

?string

# text

?string

# website

?string

# useGravatar

bool

# gravatarEmail

?string

# facebookUrl

?string

# twitterUrl

?string

# linkedinUrl

?string

# created

?DateTime

Get the date the record was created.

# modified

?DateTime

Get the last modification date for the record.

# person

?Person

# image

?Image

# customFieldValues

?Collection<AuthorCustomFieldValue>

# customFieldContent

object

Get a serialized representation of the custom fields associated with the record

# customFields

array

Get the custom fields for this entity

Admin view

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

Properties 25

Take no arguments.

# hasGravatar()

bool

Check if the author has a gravatar

# getGravatarUrl()

string

Get the gravatar url for the author

# getDisplayName()

string

Get the display name for the author

# getId()

?int

# getSlug()

?string

# getText()

?string

# getWebsite()

?string

# getUseGravatar()

bool

# getGravatarEmail()

?string

# getFacebookUrl()

?string

# getTwitterUrl()

?string

# getLinkedinUrl()

?string

# getCreated()

?DateTime

Get the date the record was created.

# getModified()

?DateTime

Get the last modification date for the record.

# getPerson()

?Person

# getImage()

?Image

# getCustomFieldValues()

?Collection<AuthorCustomFieldValue>

# getCustomFields()

array

Get the custom fields for this entity

# 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

# getHateoasLinks() Admin only

array

Get the HATEOAS links for the record

# getEditUrl() Admin only

?string

Get the url for editing the record.

# getDeleteUrl() Admin only

?string

Get the url for deleting the record.

# getManageUrl() Admin only

?string

Get the url for managing records.

Methods 9

Take arguments. The API serialises only getters that need none.

# getCustomFieldValue(CustomField $customField)

?CustomFieldValue

Get the value for a custom field

# getCustomFieldValueByName(string $customFieldName)

?CustomFieldValue

Get the value for a custom field by the custom field name

# getCustomFieldContent(string $customFieldName)

?Content

Get the content for the custom field identified by the specified name

# getCustomFieldContentOrDefault(string $customFieldName)

?Content

Get the (default) content for the custom field identified by the specified name

# getCustomFieldBoolean(string $customFieldName, ?bool $default)

?bool

Get the (default) content of the custom field as boolean value

# getCustomFieldText(string $customFieldName, ?string $default)

?string

Get the (default) content of the custom field as text

# getCustomFieldImage(string $customFieldName)

?Image

Get the (default) image contained in the custom field

# getCustomFieldFile(string $customFieldName)

?File

Get the (default) file contained in the custom field

# hasCustomField(string $customFieldName)

bool

Check if the entity has a custom field with the specified name