maintagent Class Reference

Queue the maintenance agent with the requested parameters. More...

Inheritance diagram for maintagent:

Collaboration diagram for maintagent:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	handle ($request)
	Queue the job. More...
	DisplayForm ()
	Display the input form. More...
	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.) More...
	getOptions ()
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
const	OPTIONS
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

Private Attributes
	$dbManager

Additional Inherited Members
Protected Member Functions inherited from FO_Plugin
	render ($templateName, $vars=null)
Protected Attributes inherited from FO_Plugin
	$microMenu
	$renderer
	$vars = array()

Detailed Description

Queue the maintenance agent with the requested parameters.

Definition at line 19 of file maintagent.php.

Constructor & Destructor Documentation

__construct()

maintagent::__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 46 of file maintagent.php.

Member Function Documentation

DisplayForm()

maintagent::DisplayForm

(

)

Display the input form.

Returns

string HTML in string

Definition at line 111 of file maintagent.php.

handle()

maintagent::handle

(

$request

)

Queue the job.

Returns

string Status string

Definition at line 63 of file maintagent.php.

Output()

maintagent::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.)

See also

FO_Plugin::Output()

Reimplemented from FO_Plugin.

Definition at line 155 of file maintagent.php.

Member Data Documentation

OPTIONS

const maintagent::OPTIONS

Initial value:

= [
    "a"=>"Run all non slow maintenance operations.",
    "A"=>"Run all maintenance operations.",
    "F"=>"Validate folder contents.",
    "g"=>"Remove orphaned gold files.",
    "E"=>"Remove orphaned rows from database.",
    "L"=>"Remove orphaned log files from file system.",
    "N"=>"Normalize priority ",
    
    
    "R"=>"Remove uploads with no pfiles.",
    "t"=>"Remove expired personal access tokens.",
    "T"=>"Remove orphaned temp tables.",
    "D"=>"Vacuum Analyze the database.",
    
    "Z"=>"Remove orphaned files from the repository (slow).",
    "I"=>"Reindexing of database (This activity may take 5-10 mins. Execute only when system is not in use).",
    "v"=>"verbose (turns on debugging output)",
    "o"=>"Remove older gold files from repository.",
    "l"=>"Remove older log files from repository."
    ]

Definition at line 24 of file maintagent.php.

---

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

• src/maintagent/ui/maintagent.php