[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/HTML/Helpers/ -> Dropdown.php (summary)

Joomla! Content Management System

Copyright: (C) 2012 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 344 lines (10 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 15 functions

  init()
  start()
  render()
  edit()
  publish()
  unpublish()
  featured()
  unfeatured()
  archive()
  unarchive()
  trash()
  untrash()
  checkin()
  divider()
  addCustomItem()

Functions
Functions that are not part of a class:

init()   X-Ref
Method to inject needed script

return: void

start()   X-Ref
Method to start a new dropdown menu

return: void

render()   X-Ref
Method to render current dropdown menu

return: string  HTML markup for the dropdown list

edit($id, $prefix = '', $customLink = '')   X-Ref
Append an edit item to the current dropdown menu

param: integer  $id          Record ID
param: string   $prefix      Task prefix
param: string   $customLink  The custom link if dont use default Joomla action format
return: void

publish($checkboxId, $prefix = '')   X-Ref
Append a publish item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

unpublish($checkboxId, $prefix = '')   X-Ref
Append an unpublish item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

featured($checkboxId, $prefix = '')   X-Ref
Append a featured item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

unfeatured($checkboxId, $prefix = '')   X-Ref
Append an unfeatured item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

archive($checkboxId, $prefix = '')   X-Ref
Append an archive item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

unarchive($checkboxId, $prefix = '')   X-Ref
Append an unarchive item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

trash($checkboxId, $prefix = '')   X-Ref
Append a trash item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

untrash($checkboxId, $prefix = '')   X-Ref
Append an untrash item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

checkin($checkboxId, $prefix = '')   X-Ref
Append a checkin item to the current dropdown menu

param: string  $checkboxId  ID of corresponding checkbox of the record
param: string  $prefix      The task prefix
return: void

divider()   X-Ref
Writes a divider between dropdown items

return: void

addCustomItem($label,$link = 'javascript:void(0)   X-Ref
Append a custom item to current dropdown menu

param: string   $label           The label of item
param: string   $link            The link of item
param: string   $linkAttributes  Custom link attributes
param: string   $className       Class name of item
param: boolean  $ajaxLoad        True if using ajax load when item clicked
param: string   $jsCallBackFunc  Javascript function name, called when ajax load successfully
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer