FOSSology  3.2.0rc1
Open Source License Compliance by Open Source Software
admin_scheduler Class Reference

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

Inheritance diagram for admin_scheduler:
Inheritance graph
Collaboration diagram for admin_scheduler:
Collaboration graph

Public Member Functions

 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 ()
 
- 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.
 
 __construct ()
 base constructor. Most plugins will just use this More...
 
 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 ()
 
 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.)
 
 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 30 of file admin-scheduler.php.

Member Function Documentation

admin_scheduler::GetOperationText (   $operation)

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

Parameters
$operationoperation name, e.g. 'status'
Returns
one operation text

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

admin_scheduler::JobListOption ( )

get the job list for the operation 'status'

Returns
job list

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

admin_scheduler::OperationListOption ( )

get the operation list

Returns
operation list

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

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

submit the specified operation

Parameters
$operationoperation name, e.g. 'status'
$job_idselected job id
$priority_idselected priority id
$level_idselected level id
Returns
return response from the scheduler

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

admin_scheduler::StartScheduler (   $operation = '')

start the scheduler

Parameters
$operation- null maeans start, others mean restart

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


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