ilCronOerHarvester Class Reference

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 ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)
	isDue (?DateTimeImmutable $last_run, ?int $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 (?int $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	CRON_JOB_IDENTIFIER = 'meta_oer_harvester'
const	DEFAULT_SCHEDULE_VALUE = 1
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_MINUTES = 2
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_HOURS = 3
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_DAYS = 4
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_WEEKLY = 5
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_MONTHLY = 6
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_QUARTERLY = 7
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_YEARLY = 8
	This will be replaced with an ENUM in ILIAS 9 More...

Private Attributes
ilLogger	$logger
ilLanguage	$lng
ilOerHarvesterSettings	$settings

Additional Inherited Members
Protected Attributes inherited from ilCronJob
int	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

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 11 of file class.ilCronOerHarvester.php.

Constructor & Destructor Documentation

__construct()

ilCronOerHarvester::__construct

(

)

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

References $DIC, ilOerHarvesterSettings\getInstance(), 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->settings = ilOerHarvesterSettings::getInstance();
    }

Here is the call graph for this function:

Member Function Documentation

addCustomSettingsToForm()

ilCronOerHarvester::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

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

References ilMDCopyrightSelectionEntry\_getEntries(), ilPropertyFormGUI\addItem(), ilRepositorySelector2InputGUI\getExplorerGUI(), ILIAS\Repository\lng(), ROOT_FOLDER_ID, ilFormPropertyGUI\setRequired(), ILIAS\Repository\settings(), and ilExplorerSelectInputGUI\setValue().

                                                                      : void
    {
        // target selection
        $target = new ilRepositorySelector2InputGUI(
            $this->lng->txt('meta_oer_target'),
            'target',
            false,
            $a_form
        );

        $explorer = $target->getExplorerGUI();
        $explorer->setSelectMode('target', false);
        $explorer->setRootId(ROOT_FOLDER_ID);
        $explorer->setTypeWhiteList(['cat']);

        if ($this->settings->getTarget()) {
            $explorer->setPathOpen($this->settings->getTarget());
            $target->setValue($this->settings->getTarget());
        }

        $target->setRequired(true);
        $a_form->addItem($target);

        // copyright selection
        $checkbox_group = new ilCheckboxGroupInputGUI(
            $this->lng->txt('meta_oer_copyright_selection'),
            'copyright'
        );
        $checkbox_group->setRequired(true);
        $checkbox_group->setValue($this->settings->getCopyrightTemplates());
        $checkbox_group->setInfo(
            $this->lng->txt('meta_oer_copyright_selection_info')
        );

        foreach (ilMDCopyrightSelectionEntry::_getEntries() as $copyright_entry) {
            $copyright_checkox = new ilCheckboxOption(
                $copyright_entry->getTitle(),
                (string) $copyright_entry->getEntryId(),
                $copyright_entry->getDescription()
            );
            $checkbox_group->addOption($copyright_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 136 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 57 of file class.ilCronOerHarvester.php.

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilCronOerHarvester::getDefaultScheduleValue

(

)

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

                                             : ?int
    {
        return self::DEFAULT_SCHEDULE_VALUE;
    }

getDescription()

ilCronOerHarvester::getDescription

(

)

Definition at line 37 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 42 of file class.ilCronOerHarvester.php.

                           : string
    {
        return self::CRON_JOB_IDENTIFIER;
    }

getTitle()

ilCronOerHarvester::getTitle

(

)

Definition at line 32 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 47 of file class.ilCronOerHarvester.php.

                                       : bool
    {
        return false;
    }

hasCustomSettings()

ilCronOerHarvester::hasCustomSettings

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilCronOerHarvester::hasFlexibleSchedule

(

)

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

                                         : bool
    {
        return true;
    }

run()

ilCronOerHarvester::run

(

)

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

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

                         : ilCronJobResult
    {
        $this->logger->info('Started cron oer harvester.');
        $harvester = new ilOerHarvester(new ilCronJobResult());
        $res = $harvester->run();
        $this->logger->info('cron oer harvester finished');

        return $res;
    }

Here is the call graph for this function:

saveCustomSettings()

ilCronOerHarvester::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

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

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

                                                                 : bool
    {
        $this->settings->setTarget((int) $a_form->getInput('target'));
        $this->settings->setCopyrightTemplates($a_form->getInput('copyright'));
        $this->settings->save();

        return true;
    }

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilCronOerHarvester::$lng

private

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

$logger

ilLogger ilCronOerHarvester::$logger

private

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

$settings

ilOerHarvesterSettings ilCronOerHarvester::$settings

private

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

CRON_JOB_IDENTIFIER

const ilCronOerHarvester::CRON_JOB_IDENTIFIER = 'meta_oer_harvester'

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

DEFAULT_SCHEDULE_VALUE

const ilCronOerHarvester::DEFAULT_SCHEDULE_VALUE = 1

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

---

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

• Services/MetaData/classes/class.ilCronOerHarvester.php