Class Xmf\Module\Admin


					
	protected

__construct()

Constructor

#


					
	public
					static

getInstance(): object

Retrieve a module admin instance

If we are on a next generation system this will be the native Xoops\Module\Admin instance. Older systems with the Frameworks based admin class will get an instance of this class which provides compatible methods built from the old Frameworks version.

Returns

a ModuleAdmin or Xoops\Module\Admin instance.

#


					
	public

addConfigBoxLine(string $value = '', string $type = 'default'): bool

Add config line

Parameters

$value

message to include in config box

$type

type of line to add minimal set of acceptable types and value expectation 'default' - value is message displayed directly (also used for unknown types) 'folder' - value is directory name, will display accept if exists, error if not 'chmod' - value is array(directory, permission) accept if exists with permission, else error 'module' - value is string module name, or array(module name, errortype) If module is active, an accept line displays, otherwise, a warning (if value is array(module, "warning") or an error displays.

#


					
	public

addInfoBox(string $title, string $type = 'default', string $extra = ''): bool

Add Info box

Parameters

`$title`	info box title
`$type`	for compatibility only
`$extra`	for compatibility only

#


					
	public

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

Add line to the info box

Parameters

`$text`	text to add to info box
`$type`	type of infobox line
`$color`	color for infobox line

#


					
	public

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

Add Item button

Parameters

`$title`	title of button
`$link`	link for button
`$icon`	icon for button
`$extra`	extra

#


					
	public

renderButton(string $position = null, string $delimiter = " "): string

Render all items buttons

Parameters

`$position`	button position (left, right)
`$delimiter`	delimiter between buttons

#


					
	public

displayButton(string $position = null, string $delimiter = " "): void

Display all item buttons

Parameters

`$position`	button position (left, right)
`$delimiter`	delimiter between buttons

#


					
	public

renderInfoBox(): string

Render InfoBox

Returns

HTML rendered info box

#


					
	public

displayInfoBox(): void

Display InfoBox

#


					
	public

renderIndex(): string

Render index page for admin

Returns

HTML rendered info box

#


					
	public

displayIndex(): void

Display index page for admin

#


					
	public

renderNavigation(string $menu = ''): string

Render the navigation menu

Parameters

$menu

menu key (script name, i.e. index.php)

#


					
	public

displayNavigation(string $menu = ''): void

Display the navigation menu

Parameters

$menu

menu key (script name, i.e. index.php)

#


					
	public

renderAbout(bool $logo_xoops = true): bool|mixed|string

Render about page

Parameters

$logo_xoops

display XOOPS logo

#


					
	public

displayAbout(bool $logo_xoops = true): void

Display about page

Parameters

$logo_xoops

display XOOPS logo

#


					
	public

addConfigError(string $value = ''): bool

Add error to config box

Parameters

$value

the error message

#


					
	public

addConfigAccept(string $value = ''): bool

Add accept (OK) message to config box

Parameters

$value

the OK message

#


					
	public

addConfigWarning(string $value = ''): bool

Add warning to config box

Parameters

$value

the warning message

#


					
	public

addConfigModuleVersion(string $moddir, integer $minversion): bool

Check for installed module and version and do addConfigBoxLine()

Parameters

`$moddir`	module directory name
`$minversion`	minimum acceptable module version

Returns

true if requested version of the module is available

#


					
	protected
					static

isXng(): bool

Are we in a next generation environment?

not part of next generation Xoops\Module\Admin

Returns

true if we are in a post XOOPS 2.5.x environment

#


					
	public
					static

menuIconPath(string $image): string

Get an appropriate imagePath for menu.php use.

just to help with other admin things than ModuleAdmin

not part of next generation Xoops\Module\Admin

Parameters

$image

icon name to prepend with path

Returns

the icon path

#


					
	public
					static

iconUrl(string $name = '', string $size = '32'): string

Get an appropriate URL for system provided icons.

Things which were in Frameworks in 2.5 are in media in later versions, making it harder to use and rely on the standard icons.

not part of next generation Xoops\Module\Admin

Parameters

`$name`	the image name to provide URL for, or blank to just get the URL path.
`$size`	the icon size (directory). Valid values are 16, 32 or /. A '/' slash will simply set the path to the icon directory and append $image.

Returns

path to icons

#


					
	public
					static

setPaypal(string $paypal = ''): void

set PayPal for 2.5.x renderAbout

not part of next generation Xoops\Module\Admin

Parameters

$paypal

PayPal identifier for donate button

#

Properties
`protected static`	`object`	`$ModuleAdmin = null`	#
`protected`		`$lastInfoBoxTitle = null`	#
`protected static`		`$paypal = ''`	#

Namespaces

Classes

Class Xmf\Module\Admin

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters