CheckAdmissionJob Class Reference

Inheritance diagram for CheckAdmissionJob:

Collaboration diagram for CheckAdmissionJob:

Public Member Functions
	setUp ()
	execute ($last_result, $parameters=array())
Public Member Functions inherited from CronJob
	tearDown ()

Static Public Member Functions
static	getName ()
static	getDescription ()
static	getParameters ()

Detailed Description

check_admission.class.php

Author

André Noack noack.nosp@m.@dat.nosp@m.a-que.nosp@m.st.d.nosp@m.e, Suchi & Berg GmbH info@.nosp@m.data.nosp@m.-ques.nosp@m.t.de public

Since

2.4

Member Function Documentation

execute	(		$last_result,
			$parameters = array()
	)

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.

Reimplemented from CronJob.

Here is the call graph for this function:

static getDescription ( )

static

Return the description of the cronjob.

Reimplemented from CronJob.

static getName ( )

static

Return the name of the cronjob.

Reimplemented from 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 "required" (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 method.

Reimplemented from CronJob.

---

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

• lib/cronjobs/check_admission.class.php