Frontend | Backend | Api

Users\Models\Frontend\User

User

Method Description Returns
getGroups() Get the groups this user('s person) belongs to Collection
isFrontendUser() Check whether the user is a frontend user bool
isBackendUser() Check whether the user is a backend user bool
isAdmin() Check whether the user is an admin. Doesn't check if he is an admin for the current site. Also returns true if the user is a developer or a superadmin. bool
isSuperAdmin() Check whether the user is a superadmin. Also returns true if the user is a developer. bool
isDeveloper() Check whether the user is a developer. bool
getFullName() Get the full name for the user. Fetches the full name from the person. string
isActive() Is user active? bool
getStatusLabels() Gets all available statuses with their labels array
getStatusDisplay() Gets status display label string
getUserOauthClientGroupedByApp() Get User's OAuth authorisations by application array
getCurrentActivity() Get collection of active access tokens Collection
getId() int
getType() string
getStatus() string
getUsername() string
getCreated() Date the record was created. DateTime
getModified() Last modification date for the record. DateTime
getPerson() Person
getGlobalUser() GlobalUser
getSettings() Collection (Setting)
getConfirmPassword() string
getApiKeys() Collection (ApiKey)
getLoginTokens() Collection (LoginToken)
getRefreshTokens() Collection (RefreshToken)
getAccessTokens() Collection (AccessToken)
getUserAuthenticators() Collection (UserAuthenticator)
getUserOauthClients() Collection (UserOauthClient)
getCustomFieldValues() Collection (UserCustomFieldValue)
getCustomFieldValue(CustomField $customField) Get the value for a custom field CustomFieldValue
getCustomFieldValueByName(string $customFieldName) Get the value for a custom field by the custom field name CustomFieldValue
getCustomFieldContent(string $customFieldName) Get the content for the custom field identified by the specified name Content
getCustomFieldContentOrDefault(string $customFieldName) Get the content (or default content) for the custom field identified by the specified name Content
getCustomFieldBoolean(string $customFieldName, ?bool|null $default) Get the (default) content of the custom field as boolean value bool
getCustomFieldText(string $customFieldName, ?string|null $default) Get the (default) content of the custom field as text string
getCustomFieldImage(string $customFieldName) Get the (default) image contained in the custom field Image
getCustomFieldFile(string $customFieldName) Get the (default) file contained in the custom field File
getCustomFields() Get the custom fields for this entity array
hasCustomField(string $customFieldName) Check if the entity has a custom field with the specified name bool
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
isVersionedModel() Check whether a model is versioned bool
isLoggedIn() Check if the user is logged in bool