admin_scheduler Class Reference

This is a class for operations on the scheduler from GUI. More...

Inheritance diagram for admin_scheduler:

Collaboration diagram for admin_scheduler:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	OperationListOption ()
	get the operation list More...
	JobListOption ()
	get the job list for the operation 'status' More...
	GetOperationText ($operation)
	get the related operation text, e.g. the operation text of 'stop' is 'Shutdown Schedule' More...
	OperationSubmit ($operation, $job_id, $priority_id, $level_id)
	submit the specified operation More...
	StartScheduler ($operation='')
	start the scheduler 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.)
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
	$error_info = ""
	$operation_array
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

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

This is a class for operations on the scheduler from GUI.

Definition at line 19 of file admin-scheduler.php.

Constructor & Destructor Documentation

__construct()

admin_scheduler::__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 24 of file admin-scheduler.php.

Member Function Documentation

GetOperationText()

admin_scheduler::GetOperationText

(

$operation

)

get the related operation text, e.g. the operation text of 'stop' is 'Shutdown Schedule'

Parameters

$operation

operation name, e.g. 'status'

Returns

one operation text

Definition at line 85 of file admin-scheduler.php.

JobListOption()

admin_scheduler::JobListOption

(

)

get the job list for the operation 'status'

Returns

job list

Definition at line 64 of file admin-scheduler.php.

OperationListOption()

admin_scheduler::OperationListOption

(

)

get the operation list

Returns

operation list

Definition at line 51 of file admin-scheduler.php.

OperationSubmit()

admin_scheduler::OperationSubmit	(		$operation,
			$job_id,
			$priority_id,
			$level_id
	)

submit the specified operation

Parameters

$operation	operation name, e.g. 'status'
$job_id	selected job id
$priority_id	selected priority id
$level_id	selected level id

Returns

return response from the scheduler

Definition at line 158 of file admin-scheduler.php.

StartScheduler()

admin_scheduler::StartScheduler

(

$operation = ''

)

start the scheduler

Parameters

$operation

- null maeans start, others mean restart

Definition at line 197 of file admin-scheduler.php.

---

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

• src/www/ui/admin-scheduler.php