Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

 Class JAdminMenus

Description

Utility class for drawing admin menu HTML elements

  • since: 1.0

Located in /joomla/html/html.php (line 733)

Class JAdminMenus   (Subpackage HTML)
Method Summary
Method void Access ( &$row)
Method void ComponentCategory ( $name,  $section, [ $active = NULL], [ $javascript = NULL], [ $order = 'ordering'], [ $size = 1], [ $sel_cat = 1])
Method void GenericOrdering (string $sql, [integer $chop = '30'])
Method void ImageCheck ( $file, [ $directory = '/images/M_images/'], [ $param = NULL], [ $param_directory = '/images/M_images/'], [ $alt = NULL], [ $name = 'image'], [ $type = 1], [ $align = 'top'])
Method void ImageCheckAdmin ( $file, [ $directory = '/images/'], [ $param = NULL], [ $param_directory = '/images/'], [ $alt = NULL], [ $name = NULL], [ $type = 1], [ $align = 'middle'])
Method void Images ( $name,  &$active, [ $javascript = NULL], [ $directory = NULL])
Method void MenuLinkOptions ([ $all = false], [ $unassigned = false])
Method void Ordering ( &$row,  $id)
Method void Positions ( $name, [ $active = NULL], [ $javascript = NULL], [ $none = 1], [ $center = 1], [ $left = 1], [ $right = 1], [ $id = false])
Method void SelectSection ( $name, [ $active = NULL], [ $javascript = NULL], [ $order = 'ordering'])
Method void SpecificOrdering ( &$row,  $id,  $query, [ $neworder = 0])
Method void UserSelect ( $name,  $active, [ $nouser = 0], [ $javascript = NULL], [ $order = 'name'], [ $reg = 1])
Methods
Access (line 766)

build the select list for access level

void Access ( &$row)
  • &$row
ComponentCategory (line 1015)

Select list of active categories for components

void ComponentCategory ( $name,  $section, [ $active = NULL], [ $javascript = NULL], [ $order = 'ordering'], [ $size = 1], [ $sel_cat = 1])
  • $name
  • $section
  • $active
  • $javascript
  • $order
  • $size
  • $sel_cat
GenericOrdering (line 894)

Description

  • since: 1.5
void GenericOrdering (string $sql, [integer $chop = '30'])
  • string $sql: SQL with ordering As value and 'name field' AS text
  • integer $chop: The length of the truncated headline
ImageCheck (line 1078)

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 ImageCheck ( $file, [ $directory = '/images/M_images/'], [ $param = NULL], [ $param_directory = '/images/M_images/'], [ $alt = NULL], [ $name = 'image'], [ $type = 1], [ $align = 'top'])
  • $file
  • $directory
  • $param
  • $param_directory
  • $alt
  • $name
  • $type
  • $align
ImageCheckAdmin (line 1135)

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 ImageCheckAdmin ( $file, [ $directory = '/images/'], [ $param = NULL], [ $param_directory = '/images/'], [ $alt = NULL], [ $name = NULL], [ $type = 1], [ $align = 'middle'])
  • $file
  • $directory
  • $param
  • $param_directory
  • $alt
  • $name
  • $type
  • $align
Images (line 861)

build the select list to choose an image

void Images ( $name,  &$active, [ $javascript = NULL], [ $directory = NULL])
  • $name
  • &$active
  • $javascript
  • $directory
MenuLinkOptions (line 787)

build the multiple select list for Menu Links/Pages

void MenuLinkOptions ([ $all = false], [ $unassigned = false])
  • $all
  • $unassigned
Ordering (line 741)

build the select list for Menu Ordering

void Ordering ( &$row,  $id)
  • &$row
  • $id
Positions (line 989)

Select list of positions - generally used for location of images

void Positions ( $name, [ $active = NULL], [ $javascript = NULL], [ $none = 1], [ $center = 1], [ $left = 1], [ $right = 1], [ $id = false])
  • $name
  • $active
  • $javascript
  • $none
  • $center
  • $left
  • $right
  • $id
SelectSection (line 1050)

Select list of active sections

void SelectSection ( $name, [ $active = NULL], [ $javascript = NULL], [ $order = 'ordering'])
  • $name
  • $active
  • $javascript
  • $order
SpecificOrdering (line 930)

build the select list for Ordering of a specified Table

void SpecificOrdering ( &$row,  $id,  $query,  $neworder)
  • &$row
  • $id
  • $query
  • $neworder
UserSelect (line 954)

Select list of active users

void UserSelect ( $name,  $active,  $nouser, [ $javascript = NULL], [ $order = 'name'], [ $reg = 1])
  • $name
  • $active
  • $nouser
  • $javascript
  • $order
  • $reg

Documentation generated on Mon, 05 Mar 2007 21:06:34 +0000 by phpDocumentor 1.3.1