Drupal e-Commerce API

Version 1.2.2.4 (checked in on 2010-04-21 at 23:21:12 by drumm)

api-constant-page.tpl.php Theme implementation to display a constant overview.

Available variables:

• $documentation: Documentation from the comment header of the constant.
• $branch: Object with information about the branch.
• $constant: Object with information about the constant.
• $defined: HTML reference to file that defines this class.
• $is_admin: True or false.
• $logged_in: True or false.

Available variables in the $branch object:

• $branch->project: The machine name of the branch.
• $branch->title: A proper title for the branch.
• $branch->directories: The local included directories.
• $branch->excluded_directories: The local excluded directories.

Available variables in the $constant object.

• $constant->title: Display name.
• $constant->object_type: For this template it will be 'constant'.
• $constant->branch_id: An identifier for the branch.
• $constant->file_name: The path to the file in the source.
• $constant->summary: A one-line summary of the object.
• $constant->code: Escaped source code.
• $constant->see: HTML index of additional references.

See also

api_preprocess_api_constant_page()