ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilCronUpdateOrgUnitPaths Class Reference

Class ilCronUpdateOrgUnitPaths. More...

+ 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

Member Function Documentation

◆ getDefaultScheduleType()

ilCronUpdateOrgUnitPaths::getDefaultScheduleType ( )
Returns
int

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

76  {
77  return self::SCHEDULE_TYPE_DAILY;
78  }

◆ getDefaultScheduleValue()

ilCronUpdateOrgUnitPaths::getDefaultScheduleValue ( )

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

84  {
85  return;
86  }

◆ getDescription()

ilCronUpdateOrgUnitPaths::getDescription ( )
Returns
string

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

References $DIC, and $lng.

49  {
50  global $DIC;
51  $lng = $DIC['lng'];
52 
53  return $lng->txt("update_orgunits_desc");
54  }
global $lng
Definition: privfeed.php:17
global $DIC

◆ getId()

ilCronUpdateOrgUnitPaths::getId ( )
Returns
string

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

30  {
31  return self::ID;
32  }

◆ getTitle()

ilCronUpdateOrgUnitPaths::getTitle ( )
Returns
string

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

References $DIC, and $lng.

38  {
39  global $DIC;
40  $lng = $DIC['lng'];
41 
42  return $lng->txt("update_orgunits");
43  }
global $lng
Definition: privfeed.php:17
global $DIC

◆ hasAutoActivation()

ilCronUpdateOrgUnitPaths::hasAutoActivation ( )
Returns
bool

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

60  {
61  return true;
62  }

◆ hasFlexibleSchedule()

ilCronUpdateOrgUnitPaths::hasFlexibleSchedule ( )
Returns
bool

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

68  {
69  return true;
70  }

◆ run()

ilCronUpdateOrgUnitPaths::run ( )
Returns
ilCronJobResult

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

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

92  {
93  require_once('./Modules/OrgUnit/classes/PathStorage/class.ilOrgUnitPathStorage.php');
95  ilOrgUnitPathStorage::writePathByRefId($ref_id);
96  }
97  ilOrgUnitPathStorage::clearDeleted();
98  $result = new ilCronJobResult();
100 
101  return $result;
102  }
$result
$ref_id
Definition: sahs_server.php:39
Cron job result data container.
+ Here is the call graph for this function:

Field Documentation

◆ $db

ilCronUpdateOrgUnitPaths::$db
protected

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

◆ $log

ilCronUpdateOrgUnitPaths::$log
protected

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

◆ $tree

ilCronUpdateOrgUnitPaths::$tree
protected

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

◆ ID

const ilCronUpdateOrgUnitPaths::ID = "orgunit_paths"

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


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