GemsTracker library API
Back to top  

Utility functions for token string functions

package Gems
subpackage Tracker
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.2
inherited_from \Gems_Registry_TargetAbstract

 Methods

Returns a callable if a method is called as a variable

__get(string $name) : Callable
Inherited

Parameters

$name

string

Returns

Callable

Should be called after answering the request to allow the Target to check if all required registry values have been set correctly.

checkRegistryRequestsAnswers() : boolean

Returns

booleanFalse if required values are missing.

Creates a new token with a new random token Id

createToken(array $tokenData, integer $userId) : string

Parameters

$tokenData

array

$userId

integer

Id of the user who takes the action (for logging)

Returns

stringThe new token Id

Removes all unacceptable characters from the input token and inserts any fixed characters left out

filter(string $token) : string

Parameters

$token

string

Returns

stringReformatted token

getCaseSensitive() 

getCaseSensitive() : boolean

Returns

booleanTrue if case sensitive

Display format describing token format

getFormat() : string

Returns

string

The characters that should not occur in a token

getFrom() : string
see

Returns

string

getLength() 

getLength() : integer

Returns

integerThe length a token is allowed to have.

The number of days after completion a token can be used to look up other not completed tokens

getReuse() : integer

Returns

integer

The characters that replace characters that should not occur in a token

getTo() : string
see

Returns

string

True if after completion a token can be used to look up other not completed tokens

hasReuse() : boolean

Returns

boolean

Generates a random token and checks for uniqueness

createTokenId() : string

Returns

stringA non-existing token

 Properties

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

$project

$project : \Gems_Project_ProjectSettings

Default

 

$tokenCaseSensitive

$tokenCaseSensitive 

Default

 

$tokenDisplayFormat

$tokenDisplayFormat 

Default

 

$tokenFormat

$tokenFormat 

Default

 

$tokenFrom

$tokenFrom 

Default

 

$tokenReuse

$tokenReuse 

Default

 

$tokenTo

$tokenTo 

Default