Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
CronJob Class Reference
Inheritance diagram for CronJob:
CheckAdmissionJob CleanObjectUserVisits CleanupLogJob Cronjob GarbageCollectorJob PurgeCacheJob SendMailNotificationsJob SendMailQueueJob SessionGcJob

Public Member Functions

 execute ($last_result, $parameters=[])
 
 setUp ()
 
 tearDown ()
 

Static Public Member Functions

static getName ()
 
static getDescription ()
 
static getParameters ()
 
static register ()
 
static unregister ()
 

Member Function Documentation

execute (   $last_result,
  $parameters = [] 
)
abstract

Execute the cronjob.

Parameters
mixed$last_resultWhat the last execution of this cronjob returned.
Array$parametersParameters for this cronjob instance which were defined during scheduling.
static getDescription ( )
staticabstract

Return the description of the cronjob.

static getName ( )
staticabstract

Return the name of the cronjob.

static getParameters ( )
static

Returns a list of available parameters for this cronjob.

Each parameter is an entry in the resulting with a unique identifier with the following array fields:

  • "type" which is one of the following:
    • boolean, a simple binary option
    • string, a single line of text
    • text, a multiline chunk of text
    • integer, a number
    • select, a defined set of values (define in the field "values" as an array)
  • "default" provides a default value for this field (optional)
  • "status" is either "optional" or "mandatory" (optional, defaults to optional)
  • "description" provides a decription for this parameter

Example:

return array( 'area' => array( 'type' => 'select', 'values' => array('seminar', 'institute', 'user'), 'description' => 'Example parameter #1', ), 'verbose' => array( 'type' => 'boolean', 'default' => false, 'status' => 'optional', 'description' => 'Example parameter #2', ), );

Parameters
ArrayList of paramters in the format described above.
static register ( )
static

Registers the cronjob and/or returns the corresponding task.

Returns
CronjobTask Task for this cronjob
setUp ( )

Setup method.

tearDown ( )

Teardown method.

static unregister ( )
static

Unregisters a previously registered task.


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