ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilCronUpdateOrgUnitPaths Class Reference

Class ilCronUpdateOrgUnitPaths. More...

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

Public Member Functions

 __construct ()
 
 getId ()
 
 getTitle ()
 
 getDescription ()
 
 hasAutoActivation ()
 Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
 
 hasFlexibleSchedule ()
 
 getDefaultScheduleType ()
 
 getDefaultScheduleValue ()
 
 run ()
 
- Public Member Functions inherited from ILIAS\Cron\CronJob
 setDateTimeProvider (?\Closure $date_time_provider)
 
 isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()
 
 usesLegacyForms ()
 
 getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)
 
 addCustomSettingsToForm (\ilPropertyFormGUI $a_form)
 
 saveCustomConfiguration (mixed $form_data)
 
 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 ILIAS\Cron\CronJob
JobScheduleType $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 37 of file class.ilCronUpdateOrgUnitPaths.php.

38 {
39 global $DIC;
40
41 $this->lng = $DIC->language();
42 }
global $DIC
Definition: shib_login.php:26

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

+ Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCronUpdateOrgUnitPaths::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

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

70 {
71 return JobScheduleType::DAILY;
72 }

◆ getDefaultScheduleValue()

ilCronUpdateOrgUnitPaths::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

◆ getDescription()

ilCronUpdateOrgUnitPaths::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

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

54 : string
55 {
56 return $this->lng->txt("update_orgunits_desc");
57 }

References ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ getId()

ilCronUpdateOrgUnitPaths::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

References ID.

◆ getTitle()

ilCronUpdateOrgUnitPaths::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

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

49 : string
50 {
51 return $this->lng->txt("update_orgunits");
52 }

References ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ hasAutoActivation()

ilCronUpdateOrgUnitPaths::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

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

59 : bool
60 {
61 return true;
62 }

◆ hasFlexibleSchedule()

ilCronUpdateOrgUnitPaths::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

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

64 : bool
65 {
66 return true;
67 }

◆ run()

ilCronUpdateOrgUnitPaths::run ( )

Reimplemented from ILIAS\Cron\CronJob.

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

79 : JobResult
80 {
82 ilOrgUnitPathStorage::writePathByRefId($ref_id);
83 }
84 ilOrgUnitPathStorage::clearDeleted();
85 $result = new JobResult();
86 $result->setStatus(JobResult::STATUS_OK);
87
88 return $result;
89 }
$ref_id
Definition: ltiauth.php:66

References $ref_id, and ilOrgUnitPathStorage\getAllOrguRefIds().

+ Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilCronUpdateOrgUnitPaths::$db
protected

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

◆ $lng

ilLanguage ilCronUpdateOrgUnitPaths::$lng
private

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

◆ $log

ilLogger ilCronUpdateOrgUnitPaths::$log
protected

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

◆ $tree

ilTree ilCronUpdateOrgUnitPaths::$tree
protected

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

◆ ID

const ilCronUpdateOrgUnitPaths::ID = "orgunit_paths"

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

Referenced by getId().


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