token_create [line 192]
integer token_create(
integer $p_type, string $p_value, [integer $p_expiry = TOKEN_EXPIRY], [integer $p_user_id = null]
)
|
|
Create a token.
Parameters:
|
integer |
$p_type: |
Token type |
|
string |
$p_value: |
Token value |
|
integer |
$p_expiry: |
Token expiration in seconds |
|
integer |
$p_user_id: |
User ID |
API Tags:
token_delete [line 148]
always token_delete(
integer $p_type, [integer $p_user_id = null]
)
|
|
Delete a token.
Parameters:
|
integer |
$p_type: |
Token type |
|
integer |
$p_user_id: |
User ID or null for current logged in user. |
API Tags:
token_delete_by_owner [line 166]
always token_delete_by_owner(
[integer $p_user_id = null]
)
|
|
Delete all tokens owned by a specified user.
Parameters:
|
integer |
$p_user_id: |
User ID or null for current logged in user. |
API Tags:
token_delete_by_type [line 234]
always token_delete_by_type(
integer $p_token_type
)
|
|
Delete all tokens of a specified type.
Parameters:
|
integer |
$p_token_type: |
Token Type |
API Tags:
token_ensure_exists [line 53]
boolean token_ensure_exists(
integer $p_token_id
)
|
|
Make sure a token exists.
Parameters:
|
integer |
$p_token_id: |
Token ID |
API Tags:
| Return: | True if token exists |
token_exists [line 36]
boolean token_exists(
integer $p_token_id
)
|
|
Check if a token exists.
Parameters:
|
integer |
$p_token_id: |
Token ID |
API Tags:
| Return: | True if token exists |
token_get [line 68]
array token_get(
integer $p_type, [integer $p_user_id = null]
)
|
|
Get a token's information
Parameters:
|
integer |
$p_type: |
Token type |
|
integer |
$p_user_id: |
User ID |
API Tags:
token_get_value [line 93]
array token_get_value(
integer $p_type, [integer $p_user_id = null]
)
|
|
Get a token's value or null if not found
Parameters:
|
integer |
$p_type: |
Token type |
|
integer |
$p_user_id: |
User ID (null for current user) |
API Tags:
token_purge_expired [line 252]
always token_purge_expired(
[integer $p_token_type = null]
)
|
|
Purge all expired tokens.
Parameters:
|
integer |
$p_token_type: |
Token type |
API Tags:
token_purge_expired_once [line 275]
void token_purge_expired_once(
[integer $p_token_type = null]
)
|
|
Purge all expired tokens only once per session.
Parameters:
|
integer |
$p_token_type: |
Token type |
token_set [line 111]
integer token_set(
integer $p_type, string $p_value, [integer $p_expiry = TOKEN_EXPIRY], [integer $p_user_id = null]
)
|
|
Create or update a token's value and expiration
Parameters:
|
integer |
$p_type: |
Token type |
|
string |
$p_value: |
Token value |
|
integer |
$p_expiry: |
Token expiration in seconds |
|
integer |
$p_user_id: |
User ID |
API Tags:
token_touch [line 127]
always token_touch(
integer $p_token_id, [integer $p_expiry = TOKEN_EXPIRY]
)
|
|
Touch a token to update its expiration time.
Parameters:
|
integer |
$p_token_id: |
Token ID |
|
integer |
$p_expiry: |
Token expiration in seconds |
API Tags:
token_update [line 214]
always token_update(
integer $p_token_id, string $p_value, [integer $p_expiry = TOKEN_EXPIRY]
)
|
|
Update a token
Parameters:
|
integer |
$p_token_id: |
Token ID |
|
string |
$p_value: |
Token value |
|
integer |
$p_expiry: |
Token expiration in seconds |
API Tags:
