/templates/util_global.php

Description

util_global.php

Utility functions for use with all templates. Do not echo output here!

Functions
displayErrors (line 91)

Display error messages for use in footer.tpl

  • since: 1.5.2
  • author: Steve Brown
void displayErrors ()
getIcon (line 28)

Checks for an image icon and returns a complete HTML img tag or a text string with the text icon based on what is found and user prefs.

  • return: String containing icon that can be echo'ed
  • since: 1.5.2
  • author: Steve Brown
string getIcon (string $icon_theme_path, string $icon_name, string $text_icon, [string $alt_text = ''], [integer $w = NULL], [integer $h = NULL])
  • string $icon_theme_path: User's chosen icon set
  • string $icon_name: File name of the desired icon
  • string $text_icon: Text-based icon to display if desired
  • string $alt_text: Optional. Text for alt/title attribute of image
  • integer $w: Optional. Width of requested image.
  • integer $h: Optional. Height of requested image.
getIconPath (line 63)

Gets the path to the specified icon or returns NULL if the image is not found. This has been separated from getIcon to allow the path to be fetched for use w/ third party packages, e.g. dTree.

  • return: String containing path to icon that can be used in an IMG tag, or NULL if the image is not found.
  • since: 1.5.2
  • author: Steve Brown
string getIconPath (string $icon_theme_path, string $icon_name)
  • string $icon_theme_path: User's chosen icon set
  • string $icon_name: File name of the desired icon
humanReadableSize (line 106)

Make the internal show_readable_size() function available to templates.

  • return: human-readable form
  • since: 1.5.2
string humanReadableSize (mixed $size)

Documentation generated on Sat, 07 Oct 2006 16:14:03 +0300 by phpDocumentor 1.3.0RC6