Inheritance diagram for ilCronUpdateOrgUnitPaths:

Collaboration diagram for ilCronUpdateOrgUnitPaths:

Public Member Functions
	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $a_value)
	Update current schedule (if flexible) More...

	getValidScheduleTypes ()
	Get all available schedule types. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Data Fields
const	ID = "orgunit_paths"

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Attributes
	$db

	$log

	$tree

Additional Inherited Members
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

Class ilCronUpdateOrgUnitPaths.

Author: Theodor Truffer tt@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 9 of file class.ilCronUpdateOrgUnitPaths.php.

Member Function Documentation

◆ getDefaultScheduleType()

ilCronUpdateOrgUnitPaths::getDefaultScheduleType ( )

Returns: int

Definition at line 80 of file class.ilCronUpdateOrgUnitPaths.php.

     {
         return self::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilCronUpdateOrgUnitPaths::getDefaultScheduleValue ( )

Definition at line 89 of file class.ilCronUpdateOrgUnitPaths.php.

     {
         return;
     }

◆ getDescription()

ilCronUpdateOrgUnitPaths::getDescription ( )

Returns: string

Definition at line 50 of file class.ilCronUpdateOrgUnitPaths.php.

References $DIC, and $lng.

     {
         global $DIC;
         $lng = $DIC['lng'];
 
         return $lng->txt("update_orgunits_desc");
     }

◆ getId()

ilCronUpdateOrgUnitPaths::getId ( )

Returns: string

Definition at line 29 of file class.ilCronUpdateOrgUnitPaths.php.

     {
         return self::ID;
     }

◆ getTitle()

ilCronUpdateOrgUnitPaths::getTitle ( )

Returns: string

Definition at line 38 of file class.ilCronUpdateOrgUnitPaths.php.

References $DIC, and $lng.

     {
         global $DIC;
         $lng = $DIC['lng'];
 
         return $lng->txt("update_orgunits");
     }

◆ hasAutoActivation()

ilCronUpdateOrgUnitPaths::hasAutoActivation ( )

Returns: bool

Definition at line 62 of file class.ilCronUpdateOrgUnitPaths.php.

     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCronUpdateOrgUnitPaths::hasFlexibleSchedule ( )

Returns: bool

Definition at line 71 of file class.ilCronUpdateOrgUnitPaths.php.

     {
         return true;
     }

◆ run()

ilCronUpdateOrgUnitPaths::run ( )

Returns: ilCronJobResult

Definition at line 98 of file class.ilCronUpdateOrgUnitPaths.php.

References $result, ilOrgUnitPathStorage\getAllOrguRefIds(), and ilCronJobResult\STATUS_OK.

     {
         foreach (ilOrgUnitPathStorage::getAllOrguRefIds() as $ref_id) {
             ilOrgUnitPathStorage::writePathByRefId($ref_id);
         }
         ilOrgUnitPathStorage::clearDeleted();
         $result = new ilCronJobResult();
         $result->setStatus(ilCronJobResult::STATUS_OK);
 
         return $result;
     }