TokensService

Type
Class
Namespace
Craft
Inherits
Craft\TokensService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
2.1

Tokens service.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()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()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
getTokenRoute()Searches for a token, and possibly returns a route for the request.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
incrementTokenUsageCountById()Increments a token's usage count.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
raiseEvent()Raises an event.

createToken()

Creates a new token and returns it.

View source

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, null) – The maximum number of times this token can be used. Defaults to no limit.
  • $expiryDate (Craft\DateTime, null) – The date that the token expires. Defaults to the 'defaultTokenDuration' config setting.

Returns

string, false – The generated token, or false if there was an error.

Signature

public string, false createToken ( $route, $usageLimit = null, $expiryDate = null )

deleteExpiredTokens()

Deletes any expired tokens.

View source

Returns

boolean

Signature

public boolean deleteExpiredTokens ( )

deleteTokenById()

Deletes a token by its ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteTokenById ( $tokenId )

getTokenRoute()

Searches for a token, and possibly returns a route for the request.

View source

Arguments

Returns

array, false

Signature

public array, false getTokenRoute ( $token )

incrementTokenUsageCountById()

Increments a token's usage count.

View source

Arguments

Returns

boolean

Signature

public boolean incrementTokenUsageCountById ( $tokenId )