[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/token/ -> token.module (summary)

(no description)

File Size: 609 lines (23 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 18 functions

  token_help()
  token_theme()
  token_token_values()
  token_token_list()
  token_include()
  token_replace()
  token_replace_multiple()
  _token_replace_tokens()
  token_get_values()
  _token_array_merge()
  token_get_list()
  token_prepare_tokens()
  _token_get_id()
  token_get_date_token_info()
  token_get_date_token_values()
  token_get_invalid_tokens_by_context()
  token_scan()
  token_element_validate_token_context()

Functions
Functions that are not part of a class:

token_help($path, $arg)   X-Ref
Implements hook_help().


token_theme()   X-Ref
Implements hook_theme().


token_token_values($type, $object = NULL)   X-Ref
Sample implementation of hook_token_values().

param: type
param: object
return:

token_token_list($type = 'all')   X-Ref
Sample implementation of hook_token_list(). Documents the individual
tokens handled by your module.

param: type
return:

token_include()   X-Ref
General function to include the files that token relies on for the real work.


token_replace($original, $type = 'global', $object = NULL, $leading = TOKEN_PREFIX, $trailing = TOKEN_SUFFIX, $options = array()   X-Ref
Return the value of $original, with all instances of placeholder
tokens replaced by their proper values. To replace multiple types
at once see token_replace_multiple().

param: original
param: type
param: object
param: leading
param: trailing
param: flush
return: The modified version of $original, with all substitutions

token_replace_multiple($original, $types = array('global' => NULL)   X-Ref
Return the value of $original, with all instances of placeholder
tokens replaced by their proper values. Contrary to token_replace(),
this function supports replacing multiple types.

param: original
param: types
param: leading
param: trailing
param: flush
return: The modified version of $original, with all substitutions

_token_replace_tokens($original, $tokens, $values, $leading, $trailing)   X-Ref
No description

token_get_values($type = 'global', $object = NULL, $flush = FALSE, $options = array()   X-Ref
Return a list of valid substitution tokens and their values for
the specified type.

param: type
param: object
param: flush
return:

_token_array_merge($array1, $array2)   X-Ref
Merge two arrays of token values, checking and warning for duplication.

Because array_merge will combinue elements that have the same key into an
array instead of overriding the existing element, this causes problems since
we need the values to always be a string.

param: $array1
param: $array2
return:

token_get_list($types = 'all')   X-Ref
A helper function that retrieves all currently exposed tokens,
and merges them recursively. This is only necessary when building
the token listing -- during actual value replacement, only tokens
in a particular domain are requested and a normal array_marge() is
sufficient.

param: types
return:

token_prepare_tokens($tokens = array()   X-Ref
A helper function that transforms all the elements of an
array. Used to change the delimiter style from brackets to
percent symbols etc.

param: tokens
param: leading
param: trailing
return:

_token_get_id($type = 'global', $object = NULL)   X-Ref
No description

token_get_date_token_info($description, $token_prefix = '')   X-Ref
Build a list of common date tokens for use in hook_token_list().

param: $description

token_get_date_token_values($timestamp = NULL, $token_prefix = '')   X-Ref
Build a list of common date tokens for use in hook_token_values().

param: $description

token_get_invalid_tokens_by_context($text, $valid_types = array()   X-Ref
Validate an tokens in raw text based on possible contexts.

param: $text
param: $valid_types
param: leading
param: trailing
return:

token_scan($text, $leading = TOKEN_PREFIX, $trailing = TOKEN_SUFFIX)   X-Ref
Build a list of all token-like patterns that appear in the text.

param: $text
param: leading
param: trailing
return:

token_element_validate_token_context(&$element, &$form_state)   X-Ref
Validate a form element that should have tokens in it.

Form elements that want to add this validation should have the #token_types
parameter defined.

For example:



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7