[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/HTML/Helpers/ -> Sidebar.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: 156 lines (4 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 7 functions

  render()
  addEntry()
  getEntries()
  addFilter()
  getFilters()
  setAction()
  getAction()

Functions
Functions that are not part of a class:

render()   X-Ref
Render the sidebar.

return: string  The necessary HTML to display the sidebar

addEntry($name, $link = '', $active = false)   X-Ref
Method to add a menu item to submenu.

param: string  $name    Name of the menu item.
param: string  $link    URL of the menu item.
param: bool    $active  True if the item is active, false otherwise.
return: void

getEntries()   X-Ref
Returns an array of all submenu entries

return: array

addFilter($label, $name, $options, $noDefault = false)   X-Ref
Method to add a filter to the submenu

param: string  $label      Label for the menu item.
param: string  $name       Name for the filter. Also used as id.
param: string  $options    Options for the select field.
param: bool    $noDefault  Don't show the label as the empty option
return: void

getFilters()   X-Ref
Returns an array of all filters

return: array

setAction($action)   X-Ref
Set value for the action attribute of the filter form

param: string  $action  Value for the action attribute of the form
return: void

getAction()   X-Ref
Get value for the action attribute of the filter form

return: string



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