TokensService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\TokensService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 2.1
Tokens service.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be 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. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getTokenRoute() | Searches for a token, and possibly returns a route for the request. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| incrementTokenUsageCountById() | Increments a token's usage count. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| raiseEvent() (opens new window) | Raises an event. |
# createToken()
Creates a new token and returns it.
View source (opens new window)
Arguments
$route(mixed) – Where matching requests should be routed to. If you want them to be routed to a controller action, pass:array('action' => "controller/action", 'params' => array('foo' => 'bar')).$usageLimit(integer (opens new window), null (opens new window)) – The maximum number of times this token can be used. Defaults to no limit.$expiryDate(Craft\DateTime, null (opens new window)) – The date that the token expires. Defaults to the 'defaultTokenDuration' config setting.
Returns
string (opens new window), false (opens new window) – The generated token, or false if there was an error.
Signature
public string, false createToken ( $route, $usageLimit = null, $expiryDate = null )
# deleteExpiredTokens()
Signature
public boolean deleteExpiredTokens ( )
# deleteTokenById()
Deletes a token by its ID.
View source (opens new window)
Arguments
$tokenId(integer (opens new window))
Returns
Signature
public boolean deleteTokenById ( $tokenId )
# getTokenRoute()
Searches for a token, and possibly returns a route for the request.
View source (opens new window)
Arguments
$token(string (opens new window))
Returns
Signature
public array, false getTokenRoute ( $token )
# incrementTokenUsageCountById()
Increments a token's usage count.
View source (opens new window)
Arguments
$tokenId(integer (opens new window))
Returns
Signature
public boolean incrementTokenUsageCountById ( $tokenId )