Cron job for definition for oer harvesting. More...

Inheritance diagram for ilCronOerHarvester:

Collaboration diagram for ilCronOerHarvester:

Public Member Functions
	__construct ()

	getTitle ()

	getDescription ()

	getId ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	run ()

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

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 ()

Protected Attributes
const string	CRON_JOB_IDENTIFIER = 'meta_oer_harvester'

const int	DEFAULT_SCHEDULE_VALUE = 1

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
ilLogger	$logger

ilLanguage	$lng

Initiator	$initiator

SettingsInterface	$settings

Detailed Description

Cron job for definition for oer harvesting.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilCronOerHarvester::__construct ( )

Definition at line 42 of file class.ilCronOerHarvester.php.

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

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->meta();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('meta');
 
         $this->initiator = new Initiator($DIC);
         $this->settings = $this->initiator->settings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronOerHarvester::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 94 of file class.ilCronOerHarvester.php.

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), ROOT_FOLDER_ID, ilFormPropertyGUI\setRequired(), ILIAS\Repository\settings(), ilCheckboxGroupInputGUI\setValue(), and ilExplorerSelectInputGUI\setValue().

                                                                       : void
     {
         // target selection
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->lng->txt('meta_oer_categories'));
         $a_form->addItem($header);
 
         $target = new ilRepositorySelector2InputGUI(
             $this->lng->txt('meta_oer_target'),
             'target',
             false,
             $a_form
         );
 
         $explorer = $target->getExplorerGUI();
         $explorer->setRootId(ROOT_FOLDER_ID);
         $explorer->setTypeWhiteList(['cat']);
 
         $target_ref_id = $this->settings->getContainerRefIDForHarvesting();
         if ($target_ref_id) {
             $explorer->setPathOpen($target_ref_id);
             $target->setValue($target_ref_id);
         }
 
         $target->setRequired(true);
         $a_form->addItem($target);
 
         // source for exposing
         $ex_target = new ilRepositorySelector2InputGUI(
             $this->lng->txt('meta_oer_exposed_source'),
             'exposed_source',
             false,
             $a_form
         );
 
         $ex_explorer = $ex_target->getExplorerGUI();
         $ex_explorer->setRootId(ROOT_FOLDER_ID);
         $ex_explorer->setTypeWhiteList(['cat']);
 
         $ex_target_ref_id = $this->settings->getContainerRefIDForExposing();
         if ($ex_target_ref_id) {
             $ex_explorer->setPathOpen($ex_target_ref_id);
             $ex_target->setValue($ex_target_ref_id);
         }
 
         $ex_target->setRequired(true);
         $a_form->addItem($ex_target);
 
         // copyright selection
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->lng->txt('meta_oer_harvested_licences'));
         $a_form->addItem($header);
 
         $checkbox_group = new ilCheckboxGroupInputGUI(
             $this->lng->txt('meta_oer_copyright_selection'),
             'copyright'
         );
         $checkbox_group->setValue($this->settings->getCopyrightEntryIDsSelectedForHarvesting());
         $checkbox_group->setInfo(
             $this->lng->txt('meta_oer_copyright_selection_info')
         );
 
         foreach ($this->initiator->copyrightRepository()->getAllEntries() as $copyright_entry) {
             $copyright_checkox = new ilCheckboxOption(
                 $copyright_entry->title(),
                 (string) $copyright_entry->id(),
                 $copyright_entry->description()
             );
             $checkbox_group->addOption($copyright_checkox);
         }
         $a_form->addItem($checkbox_group);
 
         // object type selection
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->lng->txt('meta_oer_harvested_types'));
         $a_form->addItem($header);
 
         $checkbox_group = new ilCheckboxGroupInputGUI(
             $this->lng->txt('meta_oer_object_type_selection'),
             'object_type'
         );
         $checkbox_group->setRequired(true);
         $checkbox_group->setValue($this->settings->getObjectTypesSelectedForHarvesting());
 
         foreach ($this->settings->getObjectTypesEligibleForHarvesting() as $type) {
             $type_checkox = new ilCheckboxOption(
                 $this->lng->txt('objs_' . $type),
                 $type
             );
             $checkbox_group->addOption($type_checkox);
         }
         $a_form->addItem($checkbox_group);
     }

Here is the call graph for this function:

◆ addToExternalSettingsForm()

ilCronOerHarvester::addToExternalSettingsForm	(	int	$a_form_id,
		array &	$a_fields,
		bool	$a_is_active
	)

Definition at line 212 of file class.ilCronOerHarvester.php.

References ilAdministrationSettingsFormHandler\FORM_META_COPYRIGHT, and ILIAS\Repository\lng().

                                                                                                   : void
     {
         switch ($a_form_id) {
             case ilAdministrationSettingsFormHandler::FORM_META_COPYRIGHT:
 
                 $a_fields['meta_oer_harvester'] =
                     (
                         $a_is_active ?
                         $this->lng->txt('enabled') :
                         $this->lng->txt('disabled')
                     );
                 break;
         }
     }

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCronOerHarvester::getDefaultScheduleType ( )

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

                                             : JobScheduleType
     {
         return JobScheduleType::DAILY;
     }

◆ getDefaultScheduleValue()

ilCronOerHarvester::getDefaultScheduleValue ( )

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

                                              : ?int
     {
         return self::DEFAULT_SCHEDULE_VALUE;
     }

◆ getDescription()

ilCronOerHarvester::getDescription ( )

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

References ILIAS\Repository\lng().

                                     : string
     {
         return $this->lng->txt('meta_oer_harvester_desc');
     }

Here is the call graph for this function:

◆ getId()

ilCronOerHarvester::getId ( )

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

                            : string
     {
         return self::CRON_JOB_IDENTIFIER;
     }

◆ getTitle()

ilCronOerHarvester::getTitle ( )

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

References ILIAS\Repository\lng().

                               : string
     {
         return $this->lng->txt('meta_oer_harvester');
     }

Here is the call graph for this function:

◆ hasAutoActivation()

ilCronOerHarvester::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilCronOerHarvester::hasCustomSettings ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCronOerHarvester::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ run()

ilCronOerHarvester::run ( )

Definition at line 202 of file class.ilCronOerHarvester.php.

References $res, and ILIAS\Repository\logger().

                          : JobResult
     {
         $this->logger->info('Started cron oer harvester.');
         $harvester = $this->initiator->harvester();
         $res = $harvester->run(new ResultWrapper(new JobResult()));
         $this->logger->info('cron oer harvester finished');
 
         return $res->get();
     }

Here is the call graph for this function:

◆ saveCustomSettings()

ilCronOerHarvester::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 188 of file class.ilCronOerHarvester.php.

References $id, ilPropertyFormGUI\getInput(), ILIAS\Repository\int(), and ILIAS\Repository\settings().

                                                                  : bool
     {
         $copyrights = [];
         foreach ($a_form->getInput('copyright') as $id) {
             $copyrights[] = (int) $id;
         }
 
         $this->settings->saveContainerRefIDForHarvesting((int) $a_form->getInput('target'));
         $this->settings->saveContainerRefIDForExposing((int) $a_form->getInput('exposed_source'));
         $this->settings->saveCopyrightEntryIDsSelectedForHarvesting(...$copyrights);
         $this->settings->saveObjectTypesSelectedForHarvesting(...$a_form->getInput('object_type'));
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $initiator

Initiator ilCronOerHarvester::$initiator

private

Definition at line 39 of file class.ilCronOerHarvester.php.

◆ $lng

ilLanguage ilCronOerHarvester::$lng

private

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

◆ $logger

ilLogger ilCronOerHarvester::$logger

private

Definition at line 37 of file class.ilCronOerHarvester.php.

◆ $settings

SettingsInterface ilCronOerHarvester::$settings

private

Definition at line 40 of file class.ilCronOerHarvester.php.

◆ CRON_JOB_IDENTIFIER

const string ilCronOerHarvester::CRON_JOB_IDENTIFIER = 'meta_oer_harvester'

protected

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

◆ DEFAULT_SCHEDULE_VALUE

const int ilCronOerHarvester::DEFAULT_SCHEDULE_VALUE = 1

protected

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

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

components/ILIAS/MetaData/classes/class.ilCronOerHarvester.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomSettingsToForm()

◆ addToExternalSettingsForm()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ run()

◆ saveCustomSettings()

Field Documentation

◆ $initiator

◆ $lng

◆ $logger

◆ $settings

◆ CRON_JOB_IDENTIFIER

◆ DEFAULT_SCHEDULE_VALUE