ModuleAdmin Class Reference

Public Member Functions
	__construct ()
	getInfo ()
	getVersion ()
	getReleaseDate ()
	getClassMethods ()
	loadLanguage ()
	renderMenuIndex ()
	renderButton ($position='right', $delimeter=' ')
	addItemButton ($title, $link, $icon='add', $extra='')
	addConfigBoxLine ($value='', $type='default')
	renderIndex ()
	addInfoBox ($title)
	addInfoBoxLine ($label, $text, $value='', $color='inherit', $type='default')
	renderInfoBox ()
	renderAbout ($business='', $logo_xoops=true)
	addNavigation ($menu='')

Detailed Description

Frameworks Module Admin

You may not change or alter any portion of this comment or credits of supporting developers from this source code or any supporting source code which is considered copyrighted (c) material of the original comment or credit authors. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Copyright

Grégory Mage (Aka Mage)

(c) 2000-2016 XOOPS Project (www.xoops.org) @license GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)

Author

Grégory Mage (Aka Mage)

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructor

Here is the call graph for this function:

Member Function Documentation

addConfigBoxLine()

addConfigBoxLine	(		$value = '',
			$type = 'default'
	)

Parameters

string	$value
string	$type

Returns

bool

addInfoBox()

addInfoBox

(

$title

)

Parameters

$title

Returns

bool

Here is the caller graph for this function:

addInfoBoxLine()

addInfoBoxLine	(		$label,
			$text,
			$value = '',
			$color = 'inherit',
			$type = 'default'
	)

Parameters

	$label
	$text
string	$value
string	$color
string	$type

Returns

bool

Here is the caller graph for this function:

addItemButton()

addItemButton	(		$title,
			$link,
			$icon = 'add',
			$extra = ''
	)

Parameters

	$title
	$link
string	$icon
string	$extra

Returns

bool

addNavigation()

addNavigation

(

$menu = ''

)

Parameters

string

$menu

Returns

string

getClassMethods()

getClassMethods

(

)

Return the available methods for the class

Returns

array methods supported by this class

Here is the caller graph for this function:

getInfo()

getInfo

(

)

Returns

array

Here is the call graph for this function:

getReleaseDate()

getReleaseDate

(

)

Return the Module Admin class release date return string version

version is rev of this class

Here is the caller graph for this function:

getVersion()

getVersion

(

)

Return the Module Admin class version number return string version

version is rev of this class

Here is the caller graph for this function:

loadLanguage()

loadLanguage

(

)

Returns

bool|mixed

Here is the caller graph for this function:

renderAbout()

renderAbout	(		$business = '',
			$logo_xoops = true
	)

Create HTML text to display on Admin About page

Parameters

string	$business	the PAYPAL business email or Merchant Account ID
bool	$logo_xoops	true to display XOOPS logo and link on page

Returns

string HTML to display

Here is the call graph for this function:

renderButton()

renderButton	(		$position = 'right',
			$delimeter = ' '
	)

Parameters

string	$position
string	$delimeter

Returns

string

renderIndex()

renderIndex

(

)

Returns

string

Here is the call graph for this function:

renderInfoBox()

renderInfoBox

(

)

Returns

string

Here is the caller graph for this function:

renderMenuIndex()

renderMenuIndex

(

)

Returns

string

Here is the caller graph for this function:

---

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

• C:/xoops2511b2/htdocs/Frameworks/moduleclasses/moduleadmin/moduleadmin.php