XH\ClassicPluginMenu Class Reference

The plugin menu builders for the classic plugin menu. More...

Inheritance diagram for XH\ClassicPluginMenu:

Public Member Functions
	__construct ()
	Initializes a new instance.
	render ($showMain)
	Renders the plugin menu. More...
	makeRow (array $style=array())
	Makes a new menu item row. More...
	makeTab ($link, $target, $text, array $style=array())
	Makes a new menu item tab. More...
	makeData ($text, array $style=array())
	Makes a new data menu item. More...
	show ()
	Renders the built plugin menu. More...

Protected Member Functions
	makeMainItem ()
	Makes the main menu item. More...
	makeStylesheetItem ()
	Makes the stylesheet menu item. More...
	makeConfigItem ()
	Makes the configuration menu item. More...
	makeLanguageItem ()
	Makes the language menu item. More...
	makeHelpItem ()
	Makes the help menu item. More...

Additional Inherited Members
Protected Attributes inherited from XH\PluginMenu
string	$scriptName
	The script name.
string	$plugin
	The name of current plugin.
string	$mainLabel
	The label of the main item of the current plugin.
string	$cssLabel
	The label of the stylesheet item of the current plugin.
string	$configLabel
	The label of the configuration item of the current plugin.
string	$languageLabel
	The label of the language item of the current plugin.
string	$helpLabel
	The label of the help item of the current plugin.
string	$mainUrl
	The URL of the main item of the current plugin.
string	$cssUrl
	The URL of the stylesheet item of the current plugin.
string	$configUrl
	The URL of the configuration item of the current plugin.
string	$languageUrl
	The URL of the language item of the current plugin.
string	$helpUrl
	The URL of the help item of the current plugin.

Detailed Description

The plugin menu builders for the classic plugin menu.

Author

Peter Harteg peter.nosp@m.@har.nosp@m.teg.d.nosp@m.k

The CMSimple_XH developers devs@.nosp@m.cmsi.nosp@m.mple-.nosp@m.xh.o.nosp@m.rg

Copyright

1999-2009 Peter Harteg

2009-2023 The CMSimple_XH developers https://www.cmsimple-xh.org/?About-CMSimple_XH/The-XH-Team

GNU GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html

Since

1.6.2

Member Function Documentation

makeConfigItem()

XH\ClassicPluginMenu::makeConfigItem ( )

protected

Makes the configuration menu item.

Returns

void

Reimplemented from XH\PluginMenu.

makeData()

XH\ClassicPluginMenu::makeData	(		$text,
		array	$style = array()
	)

Makes a new data menu item.

Parameters

string	$text	Content of the td element.
array	$style	Attributes of the td element.

Returns

void

makeHelpItem()

XH\ClassicPluginMenu::makeHelpItem ( )

protected

Makes the help menu item.

Returns

void

Reimplemented from XH\PluginMenu.

makeLanguageItem()

XH\ClassicPluginMenu::makeLanguageItem ( )

protected

Makes the language menu item.

Returns

void

Reimplemented from XH\PluginMenu.

makeMainItem()

XH\ClassicPluginMenu::makeMainItem ( )

protected

Makes the main menu item.

Returns

void

Reimplemented from XH\PluginMenu.

makeRow()

XH\ClassicPluginMenu::makeRow

(

array

$style = array()

)

Makes a new menu item row.

Parameters

array

$style

Attributes of the table element.

Returns

void

makeStylesheetItem()

XH\ClassicPluginMenu::makeStylesheetItem ( )

protected

Makes the stylesheet menu item.

Returns

void

Reimplemented from XH\PluginMenu.

makeTab()

XH\ClassicPluginMenu::makeTab	(		$link,
			$target,
			$text,
		array	$style = array()
	)

Makes a new menu item tab.

Parameters

string	$link	href attribute value of the anchor element.
string	$target	target attribute of the anchor element.
string	$text	Content of the anchor element.
array	$style	Attributes of the td resp. anchor element.

Returns

void

render()

XH\ClassicPluginMenu::render

(

$showMain

)

Renders the plugin menu.

Note that this override returns a string!

Parameters

bool

$showMain

Whether to show the main settings menu item.

Returns

string|void

Reimplemented from XH\PluginMenu.

show()

XH\ClassicPluginMenu::show

(

)

Renders the built plugin menu.

Returns

string HTML

---

The documentation for this class was generated from the following file:

• cmsimple/classes/ClassicPluginMenu.php