Class Admin

Xoops ModuleAdmin Classes

Namespace: Xoops\Module
Package: Admin
Category: Xoops\Module\Admin
Copyright: 2013-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Mage Grégory (AKA Mage)
Since: 2.6.0
Link: xoops.org
Located at oops_lib/Xoops/Module/Admin.php

Methods summary
`public`	# `__construct( )` Constructor Constructor
`public`	# `addBreadcrumbLink( string $title = '', string $link = '', boolean $home = false )` Add breadcrumb menu Add breadcrumb menu Parameters `$title` title `$link` url `$home` is home
`public boolean`	# `addConfigBoxLine( string $value = '', string $type = 'default' )` Add config line Add config line Parameters `$value` line value - a string or array of values `$type` type of line default, folder, chmod, extension, module Returns boolean
`public boolean`	# `addInfoBox( string $title, string $type = 'default', string $extra = '' )` Add Info box Add Info box Parameters `$title` title `$type` type `$extra` extra Returns boolean
`public boolean`	# `addInfoBoxLine( string $text = '', string $type = 'default', string $color = 'inherit' )` Add line to the info box Add line to the info box Parameters `$text` title `$type` type `$color` color Returns boolean
`public boolean`	# `addItemButton( string $title, string $link, string $icon = 'add', string $extra = '' )` Add Item button Add Item button Parameters `$title` title `$link` link `$icon` icon `$extra` extra Returns boolean
`public`	# `addTips( string $text = '' )` Add a tips Add a tips Parameters `$text` text
`public string`	# `renderBreadcrumb( )` renderBreadcrumb renderBreadcrumb Returns string
`public`	# `displayBreadcrumb( )` displayBreadcrumb displayBreadcrumb
`public string`	# `renderButton( string $position = "floatright", string $delimiter = " " )` Render all items buttons Render all items buttons Parameters `$position` position `$delimiter` delimiter Returns string
`public`	# `displayButton( string $position = "floatright", string $delimiter = " " )` displayButton displayButton Parameters `$position` position `$delimiter` delimiter
`public string`	# `renderInfoBox( )` Render InfoBox Render InfoBox Returns string
`public`	# `displayInfoBox( )` displayInfoBox displayInfoBox
`public string`	# `renderIndex( )` Render index page for admin Render index page for admin Returns string
`public`	# `displayIndex( )` displayIndex displayIndex
`public array`	# `renderNavigation( string $menu = '' )` Render navigation to admin page Render navigation to admin page Parameters `$menu` current menu Returns array
`public`	# `displayNavigation( string $menu = '' )` displayNavigation displayNavigation Parameters `$menu` current menu
`public string`	# `renderTips( )` Render tips to admin page Render tips to admin page Returns string
`public`	# `displayTips( )` displayTips displayTips
`public boolean\|mixed\|string`	# `renderAbout( boolean $logo_xoops = true )` Render about page Render about page Parameters `$logo_xoops` show logo Returns boolean\|mixed\|string
`public`	# `displayAbout( boolean $logo_xoops = true )` displayAbout displayAbout Parameters `$logo_xoops` display logo

Properties summary
`public string`	`$tplModule` Set module directory Set module directory	# `'system'`
`public array`	`$tplFile` Template call for each render parts Template call for each render parts	# `array( 'index' => 'admin_index.tpl', 'about' => 'admin_about.tpl', 'infobox' => 'admin_infobox.tpl', 'bread' => 'admin_breadcrumb.tpl', 'button' => 'admin_buttons.tpl', 'tips' => 'admin_tips.tpl', 'nav' => 'admin_navigation.tpl', )`

Namespaces

Classes

Class Admin

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters