copyright:	Copyright (C) 2002 - 2010 MantisBT Team - mantisbt-dev@lists.sourceforge.net
copyright:	Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
link:	http://www.mantisbt.org
usedby:	collapse_api.php

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.

Tags:

return:

Token ID

Parameters

integer	$p_type	Token type
string	$p_value	Token value
integer	$p_expiry	Token expiration in seconds
integer	$p_user_id	User ID

[ Top ]

token_delete [line 148]

always token_delete(
integer $p_type, [integer $p_user_id = null])

Delete a token.

Tags:

return:

true

Parameters

integer	$p_type	Token type
integer	$p_user_id	User ID or null for current logged in user.

[ Top ]

token_delete_by_owner [line 166]

always token_delete_by_owner(
[integer $p_user_id = null])

Delete all tokens owned by a specified user.

Tags:

return:

true

Parameters

integer

$p_user_id

User ID or null for current logged in user.

[ Top ]

token_delete_by_type [line 234]

always token_delete_by_type(
integer $p_token_type)

Delete all tokens of a specified type.

Tags:

return:

true.

Parameters

integer

$p_token_type

Token Type

[ Top ]

token_ensure_exists [line 53]

boolean token_ensure_exists(
integer $p_token_id)

Make sure a token exists.

Tags:

return:

True if token exists

Parameters

integer

$p_token_id

Token ID

[ Top ]

token_exists [line 36]

boolean token_exists(
integer $p_token_id)

Check if a token exists.

Tags:

return:

True if token exists

Parameters

integer

$p_token_id

Token ID

[ Top ]

token_get [line 68]

array token_get(
integer $p_type, [integer $p_user_id = null])

Get a token's information

Tags:

return:

Token row

Parameters

integer	$p_type	Token type
integer	$p_user_id	User ID

[ Top ]

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

Tags:

return:

Token row

Parameters

integer	$p_type	Token type
integer	$p_user_id	User ID (null for current user)

[ Top ]

token_purge_expired [line 252]

always token_purge_expired(
[integer $p_token_type = null])

Purge all expired tokens.

Tags:

return:

true.

Parameters

integer

$p_token_type

Token type

[ Top ]

token_purge_expired_once [line 274]

void token_purge_expired_once(
)

Purge all expired tokens only once per session.

[ Top ]

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

Tags:

return:

Token ID

Parameters

integer	$p_type	Token type
string	$p_value	Token value
integer	$p_expiry	Token expiration in seconds
integer	$p_user_id	User ID

[ Top ]

token_touch [line 127]

always token_touch(
integer $p_token_id, [integer $p_expiry = TOKEN_EXPIRY])

Touch a token to update its expiration time.

Tags:

return:

true

Parameters

integer	$p_token_id	Token ID
integer	$p_expiry	Token expiration in seconds

[ Top ]

token_update [line 214]

always token_update(
integer $p_token_id, string $p_value, [integer $p_expiry = TOKEN_EXPIRY])

Update a token

Tags:

return:

true.

Parameters

integer	$p_token_id	Token ID
string	$p_value	Token value
integer	$p_expiry	Token expiration in seconds

[ Top ]

Documentation generated on Sun, 12 Dec 2010 23:50:53 +0900 by phpDocumentor 1.4.3