GqlToken ​
- Type
- Class
- Namespace
- craft\models
- Inherits
- craft\models\GqlToken » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
- Uses traits
- craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Since
- 3.4.0
GraphQL token class
Public Properties ​
| Property | Description |
|---|---|
| accessToken | string – The access token |
| activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
| attributes | array – Attribute values (name => value). |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| dateCreated | DateTime, null – Date created |
| enabled | boolean – Is the token enabled |
| errors | array – Errors for all attributes or the specified attribute. |
| expiryDate | DateTime, null – Date expires |
| firstErrors | array – The first errors. |
| id | integer, null – ID |
| isExpired | boolean |
| isPublic | boolean – Whether this is the public token |
| isTemporary | boolean – Whether this is a temporary token |
| isValid | boolean |
| iterator | ArrayIterator – An iterator for traversing the items in the list. |
| lastUsed | DateTime, null – Date last used |
| name | string – Token name |
| scenario | string – The scenario that this model is in. |
| schema | craft\models\GqlSchema, null |
| schemaId | integer, null – ID of the associated schema. |
| scope | array, mixed |
| uid | string |
| validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
accessToken ​
- Type
- string
- Default value
null
The access token
dateCreated ​
Date created
enabled ​
- Type
- boolean
- Default value
true
Is the token enabled
expiryDate ​
Date expires
id ​
ID
isExpired ​
- Type
- boolean
- Default value
null- Access
- Read-only
- Since
- 3.4.5
isPublic ​
- Type
- boolean
- Default value
null
Whether this is the public token
isTemporary ​
- Type
- boolean
- Default value
false
Whether this is a temporary token
isValid ​
- Type
- boolean
- Default value
null- Access
- Read-only
- Since
- 3.4.13
lastUsed ​
Date last used
name ​
- Type
- string
- Default value
null
Token name
schema ​
- Type
- craft\models\GqlSchema, null
- Default value
null
schemaId ​
ID of the associated schema.
scope ​
- Type
- array,
mixed - Default value
null- Access
- Read-only
uid ​
- Type
- string
- Default value
null
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __toString() | Use the translated group name as the string representation. |
| __unset() | Sets a component property to be null. |
| activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. |
| addError() | Adds a new error to the specified attribute. |
| addErrors() | Adds a list of errors. |
| addModelErrors() | Adds errors from another model, with a given attribute name prefix. |
| afterValidate() | This method is invoked after validation ends. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| attributeHints() | Returns the attribute hints. |
| attributeLabels() | Returns the attribute labels. |
| attributes() | Returns the list of attribute names. |
| beforeValidate() | This method is invoked before validation starts. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| clearErrors() | Removes errors for all attributes or a single attribute. |
| createValidators() | Creates validator objects based on the validation rules specified in rules(). |
| datetimeAttributes() | Returns the names of any attributes that should hold DateTime values. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). |
| fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
| formName() | Returns the form name that this model class should use. |
| generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. |
| getActiveValidators() | Returns the validators applicable to the current scenario. |
| getAttributeHint() | Returns the text hint for the specified attribute. |
| getAttributeLabel() | Returns the text label for the specified attribute. |
| getAttributes() | Returns attribute values. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getError() | Returns the first error of the specified attribute. |
| getErrorSummary() | Returns the errors for all attributes as a one-dimensional array. |
| getErrors() | Returns the errors for all attributes or a single attribute. |
| getFirstError() | Returns the first error of the specified attribute. |
| getFirstErrors() | 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() | Returns an iterator for traversing the attributes in the model. |
| getScenario() | 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() | Returns all the validators declared in rules(). |
| hasErrors() | Returns a value indicating whether there is any validation error. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| instance() | Returns static class instance, which can be used to obtain meta information. |
| isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. |
| isAttributeRequired() | Returns a value indicating whether the attribute is required. |
| isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. |
| load() | Populates the model with input data. |
| loadMultiple() | Populates a set of models with the data from end user. |
| off() | Detaches an existing event handler from this component. |
| offsetExists() | Returns whether there is an element at the specified offset. |
| offsetGet() | Returns the element at the specified offset. |
| offsetSet() | Sets the element at the specified offset. |
| offsetUnset() | Sets the element value at the specified offset to null. |
| on() | Attaches an event handler to an event. |
| onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. |
| rules() | Returns the validation rules for attributes. |
| safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. |
| scenarios() | Returns a list of scenarios and the corresponding active attributes. |
| setAttributes() | Sets the attribute values in a massive way. |
| setScenario() | Sets the scenario for the model. |
| setSchema() | Sets the schema for this token. |
| toArray() | Converts the model into an array. |
| trigger() | Triggers an event. |
| validate() | Performs the data validation. |
| validateMultiple() | Validates multiple models. |
__construct() ​
Arguments ​
$config
__toString() ​
Use the translated group name as the string representation.
Returns ​
datetimeAttributes() ​
Returns the names of any attributes that should hold DateTime values.
Returns ​
string[]
getIsExpired() ​
- Since
- 3.4.5
Returns whether the token has expired.
Returns ​
getIsPublic() ​
Returns whether this is the public token.
Returns ​
getIsValid() ​
- Since
- 3.4.13
Returns whether the token is enabled, hasn't expired, and has a schema assigned to it.
Returns ​
getSchema() ​
Return the schema for this token.
Returns ​
getScope() ​
Return the schema's scope for this token.
Returns ​
array, mixed
setSchema() ​
- Since
- 3.5.0
Sets the schema for this token.
Arguments ​
$schema(craft\models\GqlSchema)
Protected Methods ​
| Method | Description |
|---|---|
| defineRules() | Returns the validation rules for attributes. |
| extractFieldsFor() | 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() | Extracts the root field names from nested fields. |
| resolveFields() | Determines which fields can be returned by toArray(). |
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.
Returns ​
Constants ​
| Constant | Description |
|---|---|
PUBLIC_TOKEN | The public access token value. |
SCENARIO_DEFAULT | The name of the default scenario. |