Class craft\services\Tokens
- Inheritance
- craft\services\Tokens » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/services/Tokens.php
The Tokens service.
An instance of the Tokens service is globally accessible in Craft via Craft::$app->tokens.
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
createToken() |
Creates a new token and returns it. | craft\services\Tokens |
deleteExpiredTokens() |
Deletes any expired tokens. | craft\services\Tokens |
deleteTokenById() |
Deletes a token by its ID. | craft\services\Tokens |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
getTokenRoute() |
Searches for a token, and possibly returns a route for the request. | craft\services\Tokens |
hasEventHandlers() |
Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
incrementTokenUsageCountById() |
Increments a token's usage count. | craft\services\Tokens |
init() |
Initializes the object. | yii\base\BaseObject |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
trigger() |
Triggers an event. | yii\base\Component |
Method Details
createToken()
public method
#
Creates a new token and returns it.
public string, false createToken ( $route, \craft\services\int $usageLimit = null, DateTime $expiryDate = null )$route |
mixed | Where matching requests should be routed to. If you
want them to be routed to a controller action, pass:
['action' => "controller/action", 'params' => ['foo' => 'bar']].
|
$usageLimit |
integer, null | The maximum number of times this token can be used. Defaults to no limit. |
$expiryDate |
DateTime, null | The date that the token expires. Defaults to the 'defaultTokenDuration' config setting. |
| return | string, false | The generated token, or false if there was an error.
|
|---|
deleteExpiredTokens()
public method
#
Deletes any expired tokens.
public boolean deleteExpiredTokens ( )
deleteTokenById()
public method
#
Deletes a token by its ID.
public boolean deleteTokenById ( \craft\services\int $tokenId )$tokenId |
integer |
getTokenRoute()
public method
#
Searches for a token, and possibly returns a route for the request.
public array, false getTokenRoute ( \craft\services\string $token )$token |
string |
incrementTokenUsageCountById()
public method
#
Increments a token's usage count.
public boolean incrementTokenUsageCountById ( \craft\services\int $tokenId )$tokenId |
integer |