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

Inheritance diagram for ilCronOerHarvester:

Collaboration diagram for ilCronOerHarvester:

Public Member Functions
	__construct ()
	ilOerHarvester constructor. More...

	getTitle ()
	Get title. Returns string More...

	getDescription ()
	Get description. Returns string More...

	getId ()
	Get id. Returns string More...

	hasAutoActivation ()
	Is to be activated on "installation". Returns boolean More...

	hasFlexibleSchedule ()
	Can the schedule be configured? Returns boolean More...

	getDefaultScheduleType ()
	Get schedule type. Returns int More...

	getDefaultScheduleValue ()
	Get schedule value. Returns int\|array More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? Returns boolean More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	run ()
	Run job. Returns ilCronJobResult More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Provide external settings for presentation in MD settings. More...

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...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. 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	CRON_JOB_IDENTIFIER = 'meta_oer_harvester'

const	DEFAULT_SCHEDULE_VALUE = 1

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

Private Attributes
	$logger = null

	$lng = null

	$settings = null

Additional Inherited Members
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

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

ilOerHarvester constructor.

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->meta();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('meta');
 
        $this->settings = ilOerHarvesterSettings::getInstance();
    }

References $DIC, ilOerHarvesterSettings\getInstance(), and settings().

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronOerHarvester::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilCronJob.

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

    {
        // target selection
        $target = new ilRepositorySelector2InputGUI(
            $this->lng->txt('meta_oer_target'),
            'target',
            false
        );
 
        $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(),
                $copyright_entry->getEntryId(),
                $copyright_entry->getDescription()
            );
            $checkbox_group->addOption($copyright_checkox);
        }
        $a_form->addItem($checkbox_group);
        return $a_form;
    }

References $target, ilMDCopyrightSelectionEntry\_getEntries(), ilPropertyFormGUI\addItem(), and settings().

Here is the call graph for this function:

◆ addToExternalSettingsForm()

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

Provide external settings for presentation in MD settings.

Parameters

int	$a_form_id
array	$a_fields
bool	$a_is_active

Reimplemented from ilCronJob.

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

    {
        #23901
        global $DIC;
        $lng = $DIC->language();
 
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_META_COPYRIGHT:
 
                $a_fields['meta_oer_harvester'] =
                    (
                        $a_is_active ?
                        $lng->txt('enabled') :
                        $lng->txt('disabled')
                    );
                break;
        }
    }

References $DIC, $lng, and ilAdministrationSettingsFormHandler\FORM_META_COPYRIGHT.

◆ getDefaultScheduleType()

ilCronOerHarvester::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilCronOerHarvester::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

    {
        return self::DEFAULT_SCHEDULE_VALUE;
    }

References DEFAULT_SCHEDULE_VALUE.

◆ getDescription()

ilCronOerHarvester::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

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

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

◆ getId()

ilCronOerHarvester::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return self::CRON_JOB_IDENTIFIER;
    }

References CRON_JOB_IDENTIFIER.

◆ getTitle()

ilCronOerHarvester::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

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

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

◆ hasAutoActivation()

ilCronOerHarvester::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ hasCustomSettings()

ilCronOerHarvester::hasCustomSettings ( )

Has cron job any custom setting which can be edited?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCronOerHarvester::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ run()

ilCronOerHarvester::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

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

References $res.

◆ saveCustomSettings()

ilCronOerHarvester::saveCustomSettings ( ilPropertyFormGUI $a_form )

Parameters

\ilPropertyFormGUI $a_form

Returns: bool|void

Reimplemented from ilCronJob.

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

    {
        $this->settings->setTarget($a_form->getInput('target'));
        $this->settings->setCopyrightTemplates($a_form->getInput('copyright'));
        $this->settings->save();
 
        return true;
    }