Summary: Field | Method | Constr Detail: Field | Method | Constr

org.zenmagick.store.services.ZMTokens

\store\services\ZMTokens.php at line 34

Class ZMTokens

ZMObject
    └─ZMTokens

public class ZMTokens
extends ZMObject

Token service.

Author:: DerManoMann
Version:: $Id: ZMTokens.php 2694 2009-12-03 22:32:18Z dermanomann $

Fields inherited from org.zenmagick.core.ZMObject
properties_

Constructor Summary
ZMTokens() Create new instance.

Constructor Summary

ZMTokens()

Create new instance.

Method Summary
void	clear(boolean all) Clear all expired token.
protected string	createToken(int length) Generate a random token.
ZMToken	getNewToken(string resource, int lifetime) Get a new token for the given resource.
ZMToken	getTokenForHash(string hash) Get a token for the given hash.
array	getTokenForResource(string resource) Get all token for a given resource.
static void	instance() Get instance.
void	updateToken(ZMToken token, int lifetime) Update a given token.
ZMToken	validateHash(string resource, string hash, boolean expire) Check if hash is valid in context of the resource.

Methods inherited from org.zenmagick.core.ZMObject
attachMethod, get, getAttachedMethods, getPropertyNames, set, singleton

Constructor Detail

\store\services\ZMTokens.php at line 39

ZMTokens

public ZMTokens()

Create new instance.

Method Detail

\store\services\ZMTokens.php at line 158

clear

public void clear(boolean all)

Clear all expired token.

Parameters:: all - Optional flag to clear all token; default is false.

\store\services\ZMTokens.php at line 64

createToken

protected string createToken(int length)

Generate a random token.

Parameters:: length - Optional length; default is 32.
Returns:: The token.

\store\services\ZMTokens.php at line 83

getNewToken

public ZMToken getNewToken(string resource, int lifetime)

Get a new token for the given resource.

Parameters:: resource - The resource.; lifetime - The lifetime of the new token (in seconds).
Returns:: A token.

\store\services\ZMTokens.php at line 143

getTokenForHash

public ZMToken getTokenForHash(string hash)

Get a token for the given hash.

Parameters:: hash - The hash.
Returns:: A ZMToken or null.

\store\services\ZMTokens.php at line 131

getTokenForResource

public array getTokenForResource(string resource)

Get all token for a given resource.

Parameters:: resource - The resource.
Returns:: A list of ZMToken.

\store\services\ZMTokens.php at line 53

instance

public static void instance()

Get instance.

\store\services\ZMTokens.php at line 99

updateToken

public void updateToken(ZMToken token, int lifetime)

Update a given token.

Parameters:: token - The token.; lifetime - The lifetime of the token (in seconds).

\store\services\ZMTokens.php at line 113

validateHash

public ZMToken validateHash(string resource, string hash, boolean expire)

Check if hash is valid in context of the resource.

Parameters:: resource - The resource.; hash - The hash code.; expire - Optional flag to invalidate a matching token; default is true.
Returns:: A valid token or null.

Frames No frames