ModelOAuth module

AuthorizationCode

A model in the OAuth module, with 14 members for templates, 10 API properties and 14 members for admin templates.

OAuth\Models\Frontend\AuthorizationCode OAuth\Models\Api\AuthorizationCode OAuth\Models\Backend\AuthorizationCode Also in OAuth: AccessToken CimdClient Client DcrClient Passkey RefreshToken RegisteredClient RememberMeToken UserAuthenticator UserOauthClient
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 13

Take no arguments.

# getId()
?int
# getRedirectUrl()
?string
# getExpiryDate()
?DateTime
# getScope()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getAccessToken()
?AccessToken
# hasAccessToken()
bool
Is there an Access Token attached to this?
# getApp()
?Client
# getUser()
?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

Methods 1

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

# hasScopeIncluded(string $scope)
bool
Does this record have this scope?

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 10

Read-only values on the record.

# id
?int
# redirectUrl
?string
# expiryDate
?DateTime
# scope
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# accessToken
?AccessToken
# accessToken
bool
Is there an Access Token attached to this?
# app
?Client
# user
?User

Admin view

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

Properties 13

Take no arguments.

# getId()
?int
# getRedirectUrl()
?string
# getExpiryDate()
?DateTime
# getScope()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getAccessToken()
?AccessToken
# hasAccessToken()
bool
Is there an Access Token attached to this?
# getApp()
?Client
# getUser()
?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

Methods 1

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

# hasScopeIncluded(string $scope)
bool
Does this record have this scope?