GqlToken

Type
Class
Namespace
craft\models
Inherits
craft\models\GqlToken » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
3.4.0

GraphQL token class

View source (opens new window)

# Public Properties

Property Description
accessToken string (opens new window) – The access token
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
dateCreated DateTime (opens new window), null (opens new window) – Date created
enabled boolean (opens new window) – Is the token enabled
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
expiryDate DateTime (opens new window), null (opens new window) – Date expires
firstErrors (opens new window) array (opens new window) – The first errors.
id integer (opens new window), null (opens new window) – ID
isExpired boolean (opens new window)
isPublic boolean (opens new window)
isTemporary boolean (opens new window) – Whether this is a temporary token
isValid boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
lastUsed DateTime (opens new window), null (opens new window) – Date last used
name string (opens new window) – Token name
scenario (opens new window) string (opens new window) – The scenario that this model is in.
schema craft\models\GqlSchema, null (opens new window)
schemaId integer (opens new window), null (opens new window) – ID of the associated schema.
scope array (opens new window), mixed
uid string (opens new window)
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# accessToken

Type
string (opens new window)
Default value
null

The access token

View source (opens new window)

# dateCreated

Type
DateTime (opens new window), null (opens new window)
Default value
null

Date created

View source (opens new window)

# enabled

Type
boolean (opens new window)
Default value
true

Is the token enabled

View source (opens new window)

# expiryDate

Type
DateTime (opens new window), null (opens new window)
Default value
null

Date expires

View source (opens new window)

# id

Type
integer (opens new window), null (opens new window)
Default value
null

ID

View source (opens new window)

# isExpired

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.4.5

View source (opens new window)

# isPublic

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isTemporary

Type
boolean (opens new window)
Default value
false

Whether this is a temporary token

View source (opens new window)

# isValid

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.4.13

View source (opens new window)

# lastUsed

Type
DateTime (opens new window), null (opens new window)
Default value
null

Date last used

View source (opens new window)

# name

Type
string (opens new window)
Default value
null

Token name

View source (opens new window)

# schema

Type
craft\models\GqlSchema, null (opens new window)
Default value
null

View source (opens new window)

# schemaId

Type
integer (opens new window), null (opens new window)
Default value
null
Since
3.4.0

ID of the associated schema.

View source (opens new window)

# scope

Type
array (opens new window), mixed
Default value
null
Access
Read-only

View source (opens new window)

# uid

Type
string (opens new window)
Default value
null

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct()
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__toString() Use the translated group name as the string representation.
__unset() (opens new window) Sets an object property to null.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() (opens new window) Returns the attribute labels.
attributes() (opens new window) Returns the list of attribute names.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getError() Returns the first error of the specified attribute.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getIsExpired() Returns whether the token has expired.
getIsPublic() Returns whether this is the public token.
getIsValid() Returns whether the token is enabled, hasn't expired, and has a schema assigned to it.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getScenario() (opens new window) Returns the scenario that this model is used in.
getSchema() Return the schema for this token.
getScope() Return the schema's scope for this token.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasErrors() Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
load() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) Returns a list of scenarios and the corresponding active attributes.
setAttributes() (opens new window) Sets the attribute values in a massive way.
setScenario() (opens new window) Sets the scenario for the model.
setSchema() Sets the schema for this token.
toArray() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.

# __construct()

View source (opens new window)

Arguments

  • $config

# __toString()

Use the translated group name as the string representation.

View source (opens new window)

Returns

string (opens new window)

# datetimeAttributes()

Returns the names of any attributes that should hold DateTime (opens new window) values.

View source (opens new window)

Returns

string (opens new window)[]

# getIsExpired()

Since
3.4.5

Returns whether the token has expired.

View source (opens new window)

Returns

boolean (opens new window)

# getIsPublic()

Returns whether this is the public token.

View source (opens new window)

Returns

boolean (opens new window)

# getIsValid()

Since
3.4.13

Returns whether the token is enabled, hasn't expired, and has a schema assigned to it.

View source (opens new window)

Returns

boolean (opens new window)

# getSchema()

Return the schema for this token.

View source (opens new window)

Returns

craft\models\GqlSchema, null (opens new window)

# getScope()

Return the schema's scope for this token.

View source (opens new window)

Returns

array (opens new window), mixed

# setSchema()

Since
3.5.0

Sets the schema for this token.

View source (opens new window)

Arguments

# Protected Methods

Method Description
defineRules() Returns the validation rules for attributes.
extractFieldsFor() (opens new window) Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window) Extracts the root field names from nested fields.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).

# defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

# Constants

Constant Description
PUBLIC_TOKEN The public access token value.
SCENARIO_DEFAULT The name of the default scenario.