Public Member Functions
	__construct ()

	addBreadcrumbLink ($title= '', $link= '', $home=false)

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

	addInfoBox ($title, $type= 'default', $extra= '')

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

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

	addTips ($text= '')

	displayAbout ($logo_xoops=true)

	displayBreadcrumb ()

	displayButton ($position="floatright", $delimiter=" ")

	displayIndex ()

	displayInfoBox ()

	displayNavigation ($menu= '')

	displayTips ()

	renderAbout ($logo_xoops=true)

	renderBreadcrumb ()

	renderButton ($position="floatright", $delimiter=" ")

	renderIndex ()

	renderInfoBox ()

	renderNavigation ($menu= '')

	renderTips ()

Public Attributes
	$tplFile

	$tplModule = 'system'

Private Member Functions
	getTplPath ($type= '')

Private Attributes
	$bread = array()

	$itemButton = array()

	$itemConfigBoxLine = array()

	$itemInfoBox = array()

	$module = null

	$tips = ''

Detailed Description

Definition at line 25 of file Admin.php.

Constructor & Destructor Documentation

Xoops\Module\Admin::__construct ( )

Constructor

Definition at line 94 of file Admin.php.

References $xoops, and Xoops\getInstance().

Here is the call graph for this function:

Member Function Documentation

Xoops\Module\Admin::addBreadcrumbLink	(	$title = `''`,
		$link = `''`,
		$home = `false`
	)

Add breadcrumb menu

Parameters

string	$title	title
string	$link	url
bool	$home	is home

Returns: void

Definition at line 110 of file Admin.php.

References $link.

Xoops\Module\Admin::addConfigBoxLine	(	$value = `''`,
		$type = `'default'`
	)

Add config line

Parameters

string	$value	line value - a string or array of values
string	$type	type of line default, folder, chmod, extension, module

Returns: bool

Definition at line 127 of file Admin.php.

References $text, $type, $xoops, XoopsLocaleEn_US\EF_EXTENSION_IS_NOT_INSTALLED, XoopsLocaleEn_US\EF_FOLDER_DOES_NOT_EXIST, XoopsLocaleEn_US\EF_FOLDER_MUST_BE_WITH_CHMOD, XoopsLocaleEn_US\EF_SERVICE_IS_NOT_INSTALLED, XoopsLocaleEn_US\F_MODULE_IS_INSTALLED, XoopsLocaleEn_US\F_MODULE_IS_NOT_INSTALLED, Xoops\getInstance(), XoopsLocaleEn_US\SF_EXTENSION_IS_INSTALLED, XoopsLocaleEn_US\SF_FOLDER_EXISTS, and XoopsLocaleEn_US\SF_SERVICE_IS_INSTALLED.

Referenced by Xoops\Module\Admin\renderIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Admin::addInfoBox	(	$title,
		$type = `'default'`,
		$extra = `''`
	)

Add Info box

Parameters

string	$title	title
string	$type	type
string	$extra	extra

Returns: bool

Definition at line 246 of file Admin.php.

References $type.

Referenced by Xoops\Module\Admin\renderAbout().

Here is the caller graph for this function:

Xoops\Module\Admin::addInfoBoxLine	(	$text = `''`,
		$type = `'default'`,
		$color = `'inherit'`
	)

Add line to the info box

Parameters

string	$text	title
string	$type	type
string	$color	color

Returns: bool

Definition at line 264 of file Admin.php.

References $i, $text, and $type.

Referenced by Xoops\Module\Admin\renderAbout().

Here is the caller graph for this function:

Xoops\Module\Admin::addItemButton	(	$title,
		$link,
		$icon = `'add'`,
		$extra = `''`
	)

Add Item button

Parameters

string	$title	title
string	$link	link
string	$icon	icon
string	$extra	extra

Returns: bool

Definition at line 289 of file Admin.php.

References $link.

Xoops\Module\Admin::addTips ( $text = '' )

Add a tips

Parameters

string $text text

Returns: void

Definition at line 306 of file Admin.php.

References $text.

Xoops\Module\Admin::displayAbout ( $logo_xoops = true )

displayAbout

Parameters

bool $logo_xoops display logo

Returns: void

Definition at line 714 of file Admin.php.

References Xoops\Module\Admin\renderAbout().

Here is the call graph for this function:

Xoops\Module\Admin::displayBreadcrumb ( )

displayBreadcrumb

Returns: void

Definition at line 340 of file Admin.php.

References Xoops\Module\Admin\renderBreadcrumb().

Here is the call graph for this function:

Xoops\Module\Admin::displayButton	(	$position = `"floatright"`,
		$delimiter = `" "`
	)

displayButton

Parameters

string	$position	position
string	$delimiter	delimiter

Returns: void

Definition at line 371 of file Admin.php.

References Xoops\Module\Admin\renderButton().

Here is the call graph for this function:

Xoops\Module\Admin::displayIndex ( )

displayIndex

Returns: void

Definition at line 551 of file Admin.php.

References Xoops\Module\Admin\renderIndex().

Here is the call graph for this function:

Xoops\Module\Admin::displayInfoBox ( )

displayInfoBox

Returns: void

Definition at line 393 of file Admin.php.

References Xoops\Module\Admin\renderInfoBox().

Here is the call graph for this function:

Xoops\Module\Admin::displayNavigation ( $menu = '' )

displayNavigation

Parameters

string $menu current menu

Returns: void

Definition at line 598 of file Admin.php.

References $menu, and Xoops\Module\Admin\renderNavigation().

Here is the call graph for this function:

Xoops\Module\Admin::displayTips ( )

displayTips

Returns: void

Definition at line 623 of file Admin.php.

References Xoops\Module\Admin\renderTips().

Here is the call graph for this function:

Xoops\Module\Admin::getTplPath ( $type = '' )

private

Construct template path

Parameters

string $type type

Returns: string

Definition at line 318 of file Admin.php.

References $type.

Referenced by Xoops\Module\Admin\renderAbout(), Xoops\Module\Admin\renderBreadcrumb(), Xoops\Module\Admin\renderButton(), Xoops\Module\Admin\renderIndex(), Xoops\Module\Admin\renderInfoBox(), Xoops\Module\Admin\renderNavigation(), and Xoops\Module\Admin\renderTips().

Here is the caller graph for this function:

Xoops\Module\Admin::renderAbout ( $logo_xoops = true )

Render about page

Parameters

bool $logo_xoops show logo

Returns: bool|mixed|string

Definition at line 635 of file Admin.php.

References $file, $i, $language, $xoops, Xoops\Module\Admin\addInfoBox(), Xoops\Module\Admin\addInfoBoxLine(), XoopsLocaleEn_US\C_DESCRIPTION, XoopsLocaleEn_US\C_UPDATE_DATE, XoopsLocaleEn_US\C_WEBSITE, Xoops_Locale_Abstract\formatTimestamp(), XoopsBaseConfig\get(), Xoops\getInstance(), Xoops\Module\Admin\getTplPath(), and XoopsLocaleEn_US\MODULE_INFORMATION.

Referenced by Xoops\Module\Admin\displayAbout().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Admin::renderBreadcrumb ( )

renderBreadcrumb

Returns: string

Definition at line 328 of file Admin.php.

References $xoops, Xoops\getInstance(), and Xoops\Module\Admin\getTplPath().

Referenced by Xoops\Module\Admin\displayBreadcrumb().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Admin::renderButton	(	$position = `"floatright"`,
		$delimiter = `" "`
	)

Render all items buttons

Parameters

string	$position	position
string	$delimiter	delimiter

Returns: string

Definition at line 353 of file Admin.php.

References $xoops, Xoops\getInstance(), and Xoops\Module\Admin\getTplPath().

Referenced by Xoops\Module\Admin\displayButton().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Admin::renderIndex ( )

Render index page for admin

Returns: string

Definition at line 403 of file Admin.php.

References $i, $j, $xoops, Xoops\Module\Admin\addConfigBoxLine(), XoopsLocaleEn_US\F_MINIMUM_DATABASE_VERSION_REQUIRED, XoopsLocaleEn_US\F_MINIMUM_PHP_VERSION_REQUIRED, XoopsLocaleEn_US\F_MINIMUM_XOOPS_VERSION_REQUIRED, XoopsLoad\fileExists(), XoopsBaseConfig\get(), Xoops\getInstance(), Xoops\Module\Admin\getTplPath(), XoopsLocaleEn_US\HELP, and Xoops\VERSION.

Referenced by Xoops\Module\Admin\displayIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Admin::renderInfoBox ( )

Render InfoBox

Returns: string

Definition at line 381 of file Admin.php.

References $xoops, Xoops\getInstance(), and Xoops\Module\Admin\getTplPath().

Referenced by Xoops\Module\Admin\displayInfoBox().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Admin::renderNavigation ( $menu = '' )

Render navigation to admin page

Parameters

string $menu current menu

Returns: array

Definition at line 563 of file Admin.php.

References $i, $menu, $xoops, XoopsLoad\fileExists(), Xoops\getInstance(), and Xoops\Module\Admin\getTplPath().

Referenced by Xoops\Module\Admin\displayNavigation().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Admin::renderTips ( )

Render tips to admin page

Returns: string

Definition at line 611 of file Admin.php.

References $xoops, Xoops\getInstance(), and Xoops\Module\Admin\getTplPath().

Referenced by Xoops\Module\Admin\displayTips().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Xoops\Module\Admin::$bread = array()

private

Definition at line 82 of file Admin.php.

Xoops\Module\Admin::$itemButton = array()

private

Definition at line 61 of file Admin.php.

Xoops\Module\Admin::$itemConfigBoxLine = array()

private

Definition at line 75 of file Admin.php.

Xoops\Module\Admin::$itemInfoBox = array()

private

Definition at line 68 of file Admin.php.

XoopsModule Xoops\Module\Admin::$module = null

private

Current module object

Definition at line 89 of file Admin.php.

Xoops\Module\Admin::$tips = ''

private

Definition at line 54 of file Admin.php.

Xoops\Module\Admin::$tplFile

Initial value:

= 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',
    )

Definition at line 39 of file Admin.php.

Xoops\Module\Admin::$tplModule = 'system'

Definition at line 32 of file Admin.php.

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

C:/usr64/htdocs/xoops_lib/Xoops/Module/Admin.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation