signup/includes/token_help.inc

<?php
// $Id: token_help.inc,v 1.1 2008/11/15 02:03:50 dww Exp $


/**
 * @file
 * Code for building help text for token.module support on various forms.
 */

/**
 * Private function to generate HTML for showing the available tokens.
 *
 * @param $form
 *   Reference to the form array to include the help fieldset in.
 * @param $element_name
 *   Name of the form element to use for the help fieldset.
 */
function _signup_token_help(&$form, $element_name) {
  $form[$element_name] = array(
    '#type' => 'fieldset',
    '#title' => t('Replacement tokens'),
    '#description' => t("Since these tokens will be used in plain text e-mail, it is better to use the '-raw' versions of any tokens that provide them."),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form[$element_name]['help_text'] = array(
    '#value' => _signup_build_token_help(),
  );
}

/**
 * Private function to generate HTML for showing the available tokens
 *
 * @return The themed representation of the available tokens.
 */
function _signup_build_token_help() {
  static $help_html = '';
  if (empty($help_html)) {
    $help_html = theme('token_help', array('signup', 'node', 'global'));
  }
  return $help_html;
}
1	<?php
2	// $Id: token_help.inc,v 1.1 2008/11/15 02:03:50 dww Exp $
3
4
5	/**
6	* @file
7	* Code for building help text for token.module support on various forms.
8	*/
9
10	/**
11	* Private function to generate HTML for showing the available tokens.
12	*
13	* @param $form
14	* Reference to the form array to include the help fieldset in.
15	* @param $element_name
16	* Name of the form element to use for the help fieldset.
17	*/
18	function _signup_token_help(&$form, $element_name) {
19	$form[$element_name] = array(
20	'#type' => 'fieldset',
21	'#title' => t('Replacement tokens'),
22	'#description' => t("Since these tokens will be used in plain text e-mail, it is better to use the '-raw' versions of any tokens that provide them."),
23	'#collapsible' => TRUE,
24	'#collapsed' => TRUE,
25	);
26	$form[$element_name]['help_text'] = array(
27	'#value' => _signup_build_token_help(),
28	);
29	}
30
31	/**
32	* Private function to generate HTML for showing the available tokens
33	*
34	* @return The themed representation of the available tokens.
35	*/
36	function _signup_build_token_help() {
37	static $help_html = '';
38	if (empty($help_html)) {
39	$help_html = theme('token_help', array('signup', 'node', 'global'));
40	}
41	return $help_html;
42	}