Cronjob Class Reference

Inheritance diagram for Cronjob:

Collaboration diagram for Cronjob:

Public Member Functions
	setUp ()
	execute ($lastResult, $parameters=[])
	tearDown ()
	execute ($last_result, $parameters=array())
	setUp ()
	tearDown ()

Static Public Member Functions
static	getName ()
static	getDescription ()
static	getParameters ()
Static Public Member Functions inherited from CronJob
static	getName ()
static	getDescription ()
static	getParameters ()
static	register ()
static	unregister ()

Detailed Description

Cron job that re-indexes all files.

@license GPL2 or any later version

Since

Stud.IP 4.1

Member Function Documentation

execute()

execute	(		$lastResult,
			$parameters = []
	)

{Execute the cronjob.

Parameters

mixed	$last_result	What the last execution of this cronjob returned.
Array	$parameters	Parameters for this cronjob instance which were defined during scheduling.

}

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Reimplemented from CronJob.

getDescription()

static getDescription ( )

static

{Return the description of the cronjob.}

Reimplemented from CronJob.

getName()

static getName ( )

static

{Return the name of the cronjob.}

Reimplemented from CronJob.

getParameters()

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

Array

List of paramters in the format described above.

}

Reimplemented from CronJob.

setUp()

setUp

(

)

{Setup method.}

Reimplemented from CronJob.

tearDown()

tearDown

(

)

{Teardown method.}

Reimplemented from CronJob.

---

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

• lib/classes/FilesSearch/Cronjob.php