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

Inheritance diagram for ilCronOerHarvester:

Collaboration diagram for ilCronOerHarvester:

Public Member Functions
	__construct ()

	usesLegacyForms ()

	getTitle ()

	getDescription ()

	getId ()

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

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

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

Data Fields
const string	CRON_JOB_IDENTIFIER = 'meta_oer_harvester'

Protected Attributes
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

PresentationUtilities	$presentation_utilities

PublishingServices	$publishing_services

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

Constructor & Destructor Documentation

◆ __construct()

ilCronOerHarvester::__construct ( )

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

    {
        global $DIC;
 
        $internal_services = new InternalServices($DIC);
 
        $this->logger = $internal_services->dic()->logger()->meta();
        $this->presentation_utilities = $internal_services->presentation()->utilities();
        $this->publishing_services = $internal_services->OERHarvester();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addToExternalSettingsForm()

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

Parameters

array<string,mixed> $a_fields

Reimplemented from ILIAS\Cron\CronJob.

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

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

References ilAdministrationSettingsFormHandler\FORM_META_COPYRIGHT.

◆ getDefaultScheduleType()

ilCronOerHarvester::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilCronOerHarvester::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                             : ?int
    {
        return self::DEFAULT_SCHEDULE_VALUE;
    }

References DEFAULT_SCHEDULE_VALUE.

◆ getDescription()

ilCronOerHarvester::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

◆ getId()

ilCronOerHarvester::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return self::CRON_JOB_IDENTIFIER;
    }

References CRON_JOB_IDENTIFIER.

◆ getTitle()

ilCronOerHarvester::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

◆ hasAutoActivation()

ilCronOerHarvester::hasAutoActivation ( )

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

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasFlexibleSchedule()

ilCronOerHarvester::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return true;
    }

◆ run()

ilCronOerHarvester::run ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

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

Here is the call graph for this function:

◆ usesLegacyForms()

ilCronOerHarvester::usesLegacyForms ( )

Deprecated:

Reimplemented from ILIAS\Cron\CronJob.

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

                                     : bool
    {
        return false;
    }

Field Documentation

◆ $logger

ilLogger ilCronOerHarvester::$logger

private

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

◆ $presentation_utilities

PresentationUtilities ilCronOerHarvester::$presentation_utilities

private

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

◆ $publishing_services

PublishingServices ilCronOerHarvester::$publishing_services

private

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

◆ CRON_JOB_IDENTIFIER

const string ilCronOerHarvester::CRON_JOB_IDENTIFIER = 'meta_oer_harvester'

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

Referenced by getId(), and ilMDPublishingSettingsGUI\isOERHarvesterActive().

◆ DEFAULT_SCHEDULE_VALUE

const int ilCronOerHarvester::DEFAULT_SCHEDULE_VALUE = 1

protected

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

Referenced by getDefaultScheduleValue().

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

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

Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToExternalSettingsForm()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ run()

◆ usesLegacyForms()

Field Documentation

◆ $logger

◆ $presentation_utilities

◆ $publishing_services

◆ CRON_JOB_IDENTIFIER

◆ DEFAULT_SCHEDULE_VALUE