Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JHTMLImage

Description

Utility class working with images

  • since: 1.5

Located in /joomla/html/html/image.php (line 26)

Class JHTMLImage   (Subpackage HTML)
Method Summary
Method void administrator (string $file, [string $directory = '/images/'], [int $param = NULL], [string $param_directory = '/images/'], [string $alt = NULL], [array $attribs = null], [boolean $type = 1])
Method void site (string $file, [string $folder = '/images/M_images/'], [int $altFile = NULL], [string $altFolder = '/images/M_images/'], [string $alt = NULL], [array $attribs = null], [boolean $asTag = 1])
Methods
administrator (line 109)

Checks to see if an image exists in the current templates image directory if it does it loads this image. Otherwise the default image is loaded.

Also can be used in conjunction with the menulist param to create the chosen image load the default or use no image

void administrator (string $file, [string $directory = '/images/'], [int $param = NULL], [string $param_directory = '/images/'], [string $alt = NULL], [array $attribs = null], [boolean $type = 1])
  • string $file: The file name, eg foobar.png
  • string $directory: The path to the image
  • int $param: empty: use $file and $folder, -1: show no image, not-empty: use $altFile and $altFolder
  • string $param_directory: Another path. Only used for the contact us form based on the value of the imagelist parm
  • string $alt: Alt text
  • array $attribs: An associative array of attributes to add
  • boolean $type: True (default) to display full tag, false to return just the path
site (line 42)

Checks to see if an image exists in the current templates image directory if it does it loads this image. Otherwise the default image is loaded.

Also can be used in conjunction with the menulist param to create the chosen image load the default or use no image

void site (string $file, [string $folder = '/images/M_images/'], [int $altFile = NULL], [string $altFolder = '/images/M_images/'], [string $alt = NULL], [array $attribs = null], [boolean $asTag = 1])
  • string $file: The file name, eg foobar.png
  • string $folder: The path to the image
  • int $altFile: empty: use $file and $folder, -1: show no image, not-empty: use $altFile and $altFolder
  • string $altFolder: Another path. Only used for the contact us form based on the value of the imagelist parm
  • string $alt: Alt text
  • array $attribs: An associative array of attributes to add
  • boolean $asTag: True (default) to display full tag, false to return just the path
Support Joomla!