Tokens

Type: Class
Namespace: craft\services
Inherits: craft\services\Tokens » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 3.0.0

The Tokens service.

An instance of the service is available via Craft::$app->tokens.

# Public Properties

Property	Description
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	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.
createPreviewToken()	Creates a new token for previewing content, using the config3:previewTokenDuration (opens new window) to determine the duration, if set.
createToken()	Creates a new token and returns it.
deleteExpiredTokens()	Deletes any expired tokens.
deleteTokenById()	Deletes a token by its ID.
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.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getTokenRoute()	Searches for a token, and possibly returns a route for the request.
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 for this component.
incrementTokenUsageCountById()	Increments a token's usage count.
init() (opens new window)	Initializes the object.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
trigger() (opens new window)	Triggers an event.

# `createPreviewToken()`

Since: 3.7.0

Creates a new token for previewing content, using the config3:previewTokenDuration (opens new window) to determine the duration, if set.

View source (opens new window)

Arguments

$route (mixed) – Where matching requests should be routed to.
$usageLimit (integer (opens new window), null (opens new window)) – The maximum number of times this token can be used. Defaults to no limit.
$token (string (opens new window), null (opens new window)) – The token to use, if it was pre-generated. Must be exactly 32 characters.

Returns

string (opens new window), false (opens new window) – The generated token, or false if there was an error.

# `createToken()`

Creates a new token and returns it.

View source (opens new window)

Arguments

$route (mixed) – Where matching requests should be routed to.
$usageLimit (integer (opens new window), null (opens new window)) – The maximum number of times this token can be used. Defaults to no limit.
$expiryDate (DateTime (opens new window), null (opens new window)) – The date that the token expires. Defaults to the 'defaultTokenDuration' config setting.
$token (string (opens new window), null (opens new window)) – The token to use, if it was pre-generated. Must be exactly 32 characters.

Returns

string (opens new window), false (opens new window) – The generated token, or false if there was an error.

Example

// Route to a controller action
Craft::$app->tokens->createToken('action/path');

// Route to a controller action with params
Craft::$app->tokens->createToken(['action/path', [
    'foo' => 'bar'
]]);

// Route to a template
Craft::$app->tokens->createToken(['template' => 'template/path']);