ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
ilCronUpdateOrgUnitPaths Class Reference

Class ilCronUpdateOrgUnitPaths. More...

+ Inheritance diagram for ilCronUpdateOrgUnitPaths:
+ Collaboration diagram for ilCronUpdateOrgUnitPaths:

Public Member Functions

 __construct ()
 
 getId ()
 
 getTitle ()
 
 getDescription ()
 
 hasAutoActivation ()
 
 hasFlexibleSchedule ()
 
 getDefaultScheduleType ()
 
 getDefaultScheduleValue ()
 
 run ()
 
- Public Member Functions inherited from ilCronJob
 setDateTimeProvider (?Closure $date_time_provider)
 
 isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)
 
 getScheduleType ()
 Get current schedule type (if flexible) More...
 
 getScheduleValue ()
 Get current schedule value (if flexible) More...
 
 setSchedule (?CronJobScheduleType $a_type, ?int $a_value)
 Update current schedule (if flexible) More...
 
 getAllScheduleTypes ()
 Get all available schedule types. More...
 
 getScheduleTypesWithValues ()
 
 getValidScheduleTypes ()
 Returns a collection of all valid schedule types for a specific job. More...
 
 isManuallyExecutable ()
 
 hasCustomSettings ()
 
 addCustomSettingsToForm (ilPropertyFormGUI $a_form)
 
 saveCustomSettings (ilPropertyFormGUI $a_form)
 
 addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)
 
 activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
 Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...
 
 getId ()
 
 getTitle ()
 
 getDescription ()
 
 hasAutoActivation ()
 Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
 
 hasFlexibleSchedule ()
 
 getDefaultScheduleType ()
 
 getDefaultScheduleValue ()
 
 run ()
 

Data Fields

const ID = "orgunit_paths"
 

Protected Attributes

ilDBInterface $db
 
ilLogger $log
 
ilTree $tree
 
- Protected Attributes inherited from ilCronJob
CronJobScheduleType $schedule_type = null
 
int $schedule_value = null
 
Closure $date_time_provider = null
 

Private Attributes

ilLanguage $lng
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilCronUpdateOrgUnitPaths::__construct ( )

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

References $DIC, and ILIAS\Repository\lng().

37  {
38  global $DIC;
39 
40  $this->lng = $DIC->language();
41  }
global $DIC
Definition: shib_login.php:25
+ Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCronUpdateOrgUnitPaths::getDefaultScheduleType ( )

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

69  {
70  return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
71  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getDefaultScheduleValue()

ilCronUpdateOrgUnitPaths::getDefaultScheduleValue ( )

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

73  : ?int
74  {
75  return null;
76  }

◆ getDescription()

ilCronUpdateOrgUnitPaths::getDescription ( )

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

References ILIAS\Repository\lng().

53  : string
54  {
55  return $this->lng->txt("update_orgunits_desc");
56  }
+ Here is the call graph for this function:

◆ getId()

ilCronUpdateOrgUnitPaths::getId ( )

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

43  : string
44  {
45  return self::ID;
46  }

◆ getTitle()

ilCronUpdateOrgUnitPaths::getTitle ( )

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

References ILIAS\Repository\lng().

48  : string
49  {
50  return $this->lng->txt("update_orgunits");
51  }
+ Here is the call graph for this function:

◆ hasAutoActivation()

ilCronUpdateOrgUnitPaths::hasAutoActivation ( )

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

58  : bool
59  {
60  return true;
61  }

◆ hasFlexibleSchedule()

ilCronUpdateOrgUnitPaths::hasFlexibleSchedule ( )

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

63  : bool
64  {
65  return true;
66  }

◆ run()

ilCronUpdateOrgUnitPaths::run ( )

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

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

79  {
81  ilOrgUnitPathStorage::writePathByRefId($ref_id);
82  }
83  ilOrgUnitPathStorage::clearDeleted();
84  $result = new ilCronJobResult();
85  $result->setStatus(ilCronJobResult::STATUS_OK);
86 
87  return $result;
88  }
$ref_id
Definition: ltiauth.php:66
+ Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilCronUpdateOrgUnitPaths::$db
protected

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

◆ $lng

ilLanguage ilCronUpdateOrgUnitPaths::$lng
private

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

◆ $log

ilLogger ilCronUpdateOrgUnitPaths::$log
protected

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

◆ $tree

ilTree ilCronUpdateOrgUnitPaths::$tree
protected

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

◆ ID

const ilCronUpdateOrgUnitPaths::ID = "orgunit_paths"

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


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