[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> tokens_api.php (summary)

Tokens API This implements temporary storage of strings. DB schema: id, type, owner, timestamp, value

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 289 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 13 functions

  token_exists()
  token_ensure_exists()
  token_get()
  token_get_value()
  token_set()
  token_touch()
  token_delete()
  token_delete_by_owner()
  token_create()
  token_update()
  token_delete_by_type()
  token_purge_expired()
  token_purge_expired_once()

Functions
Functions that are not part of a class:

token_exists( $p_token_id )   X-Ref
Check if a token exists.

param: integer Token ID
return: boolean True if token exists

token_ensure_exists( $p_token_id )   X-Ref
Make sure a token exists.

param: integer Token ID
return: boolean True if token exists

token_get( $p_type, $p_user_id = null )   X-Ref
Get a token's information

param: integer Token type
param: integer User ID
return: array Token row

token_get_value( $p_type, $p_user_id = null )   X-Ref
Get a token's value or null if not found

param: integer Token type
param: integer User ID (null for current user)
return: array Token row

token_set( $p_type, $p_value, $p_expiry = TOKEN_EXPIRY, $p_user_id = null )   X-Ref
Create or update a token's value and expiration

param: integer Token type
param: string Token value
param: integer Token expiration in seconds
param: integer User ID
return: integer Token ID

token_touch( $p_token_id, $p_expiry = TOKEN_EXPIRY )   X-Ref
Touch a token to update its expiration time.

param: integer Token ID
param: integer Token expiration in seconds
return: always true

token_delete( $p_type, $p_user_id = null )   X-Ref
Delete a token.

param: integer Token type
param: integer User ID or null for current logged in user.
return: always true

token_delete_by_owner( $p_user_id = null )   X-Ref
Delete all tokens owned by a specified user.

param: integer User ID or null for current logged in user.
return: always true

token_create( $p_type, $p_value, $p_expiry = TOKEN_EXPIRY, $p_user_id = null )   X-Ref
Create a token.

param: integer Token type
param: string Token value
param: integer Token expiration in seconds
param: integer User ID
return: integer Token ID

token_update( $p_token_id, $p_value, $p_expiry = TOKEN_EXPIRY )   X-Ref
Update a token

param: integer Token ID
param: string Token value
param: integer Token expiration in seconds
return: always true.

token_delete_by_type( $p_token_type )   X-Ref
Delete all tokens of a specified type.

param: integer Token Type
return: always true.

token_purge_expired( $p_token_type = null )   X-Ref
Purge all expired tokens.

param: integer Token type
return: always true.

token_purge_expired_once()   X-Ref
Purge all expired tokens only once per session.




Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7