Inheritance diagram for dashboard:

Collaboration diagram for dashboard:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...

	DatabaseContentsRow ($TableName, $TableLabel, $fromRest=false)
	Return each html row for DatabaseContents() More...

	DatabaseContents ()
	Database Contents metrics. More...

	GetLastAnalyzeTimeOrVacTime ($queryPart, $TableName)

	GetLastVacTime ($TableName)

	GetPHPInfoTable ($fromRest=false)

	GetLastAnalyzeTime ($TableName)

	DatabaseMetrics ($fromRest=false)
	Database metrics. More...

	DatabaseQueries ($fromRest=false)
	Database queries. More...

	DiskFree ($fromRest=false)
	Determine amount of free disk space.

	Output ()
	This function is called when user output is requested. This function is responsible for content. (OutputOpen and Output are separated so one plugin can call another plugin's Output.)

Public Member Functions inherited from FO_Plugin
	Install ()
	This function (when defined) is only called when the plugin is first installed. It should make sure all requirements are available and create anything it needs to run. It returns 0 on success, non-zero on failure. A failed install is not inserted in the system. More...

	Remove ()
	This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.

	Initialize ()
	dummy stub till all references are removed.

	PostInitialize ()
	This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...

	RegisterMenus ()
	While menus can be added to any time at or after the PostInitialize phase, this is the standard location for registering this item with menus. More...

	Destroy ()
	This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.

	OutputOpen ()
	This function is called when user output is requested. This function is responsible for assigning headers.

	OutputUnSet ()
	Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.

	getResponse ()

	getTemplateName ()

	renderString ($templateName, $vars=null)

	renderScripts ($scripts)
	Render JavaScript in the template's footer. More...

	getRequest ()

	execute ()

	preInstall ()

	postInstall ()

	unInstall ()

	getName ()

	__toString ()

Public Attributes
	$pgVersion

Public Attributes inherited from FO_Plugin
	$State = PLUGIN_STATE_INVALID

	$Name = ""

	$Version = "1.0"

	$Title = ""

	$DBaccess = PLUGIN_DB_NONE

	$LoginFlag = 0

	$NoMenu = 0

	$NoHeader = 0

	$PluginLevel = 10

	$Dependency = array()

	$InitOrder = 0

	$MenuList = NULL

	$MenuOrder = 0

	$MenuTarget = NULL

	$OutputType = "HTML"

	$OutputToStdout = 0

Protected Member Functions
	DoCmd ($cmd)
	execute a shell command More...

Protected Member Functions inherited from FO_Plugin
	render ($templateName, $vars=null)

Private Attributes
	$dbManager

Additional Inherited Members
Protected Attributes inherited from FO_Plugin
	$microMenu

	$renderer

	$vars = array()

Detailed Description

Definition at line 14 of file admin-dashboard-general.php.

Constructor & Destructor Documentation

◆ __construct()

dashboard::__construct ( )

base constructor. Most plugins will just use this

Makes sure the plugin is in the correct state. If so, the plugin is inserted into the Plugins data structure.

The constructor assumes that Install() was already run one time (possibly years ago and not during this object's creation).

Returns: true on success, false on failure.

On failure the plugin is not used by the system. NOTE: This function must NOT assume that other plugins are installed. See PostInitialize.

Reimplemented from FO_Plugin.

Definition at line 21 of file admin-dashboard-general.php.

Member Function Documentation

◆ DatabaseContents()

dashboard::DatabaseContents ( )

Database Contents metrics.

Returns: html table containing metrics

Definition at line 81 of file admin-dashboard-general.php.

◆ DatabaseContentsRow()

dashboard::DatabaseContentsRow	(	$TableName,
		$TableLabel,
		$fromRest = `false`
	)

Return each html row for DatabaseContents()

Returns: html table row

Definition at line 37 of file admin-dashboard-general.php.

◆ DatabaseMetrics()

dashboard::DatabaseMetrics ( $fromRest = false )

Database metrics.

Returns: html table containing metrics

Definition at line 194 of file admin-dashboard-general.php.

◆ DatabaseQueries()

dashboard::DatabaseQueries ( $fromRest = false )

Database queries.

Returns: html table containing query strings, pid, and start time

Exceptions

Exception

Definition at line 256 of file admin-dashboard-general.php.

◆ DoCmd()

dashboard::DoCmd ( $cmd )

protected

execute a shell command

Parameters

$cmd	- command to execute

Returns: command results

Definition at line 478 of file admin-dashboard-general.php.

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

src/www/ui/admin-dashboard-general.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members