Inheritance diagram for ILIAS\MetaData\OERHarvester\Settings\Settings:

Collaboration diagram for ILIAS\MetaData\OERHarvester\Settings\Settings:

Public Member Functions
	__construct ()

	getObjectTypesEligibleForPublishing ()

	getObjectTypesSelectedForPublishing ()

	isObjectTypeSelectedForPublishing (string $type)

	saveObjectTypesSelectedForPublishing (string ... $types)

	getCopyrightEntryIDsSelectedForPublishing ()

	isCopyrightEntryIDSelectedForPublishing (int $id)

	saveCopyrightEntryIDsSelectedForPublishing (int ... $ids)

	isEditorialStepEnabled ()

	saveEditorialStepEnabled (bool $enabled)

	getContainerRefIDForEditorialStep ()

	saveContainerRefIDForEditorialStep (int $ref_id)

	getContainerRefIDForPublishing ()

	saveContainerRefIDForPublishing (int $ref_id)

	isManualPublishingEnabled ()

	saveManualPublishingEnabled (bool $enabled)

	isAutomaticPublishingEnabled ()

	saveAutomaticPublishingEnabled (bool $enabled)

	getObjectTypesEligibleForPublishing ()

	getObjectTypesSelectedForPublishing ()

	isObjectTypeSelectedForPublishing (string $type)

	saveObjectTypesSelectedForPublishing (string ... $types)

	getCopyrightEntryIDsSelectedForPublishing ()

	isCopyrightEntryIDSelectedForPublishing (int $id)

	saveCopyrightEntryIDsSelectedForPublishing (int ... $ids)

	isEditorialStepEnabled ()

	saveEditorialStepEnabled (bool $enabled)

	getContainerRefIDForEditorialStep ()

	saveContainerRefIDForEditorialStep (int $ref_id)

	getContainerRefIDForPublishing ()

	saveContainerRefIDForPublishing (int $ref_id)

	isManualPublishingEnabled ()

	saveManualPublishingEnabled (bool $enabled)

	isAutomaticPublishingEnabled ()

	saveAutomaticPublishingEnabled (bool $enabled)

Protected Attributes
const string	STORAGE_IDENTIFIER = 'meta_oer'

const array	ELIGIBLE_TYPES

ilSetting	$settings

array	$selected_obj_types

array	$selected_cp_entry_ids

bool	$editorial_step_enabled

int	$editorial_ref_id

int	$source_for_exposing_ref_id

bool	$manual_publishing_enabled

bool	$automatic_publishing_enabled

Detailed Description

Definition at line 23 of file Settings.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\OERHarvester\Settings\Settings::__construct ( )

Definition at line 61 of file Settings.php.

    {
        $this->settings = new \ilSetting(self::STORAGE_IDENTIFIER);
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ getContainerRefIDForEditorialStep()

ILIAS\MetaData\OERHarvester\Settings\Settings::getContainerRefIDForEditorialStep ( )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 155 of file Settings.php.

                                                       : int
    {
        if (isset($this->editorial_ref_id)) {
            return $this->editorial_ref_id;
        }
        return $this->editorial_ref_id = (int) $this->settings->get(
            'target',
            '0'
        );
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\$editorial_ref_id, ILIAS\Repository\int(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getContainerRefIDForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::getContainerRefIDForPublishing ( )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 172 of file Settings.php.

                                                    : int
    {
        if (isset($this->source_for_exposing_ref_id)) {
            return $this->source_for_exposing_ref_id;
        }
        return $this->source_for_exposing_ref_id = (int) $this->settings->get(
            'exposed_container',
            '0'
        );
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\$source_for_exposing_ref_id, ILIAS\Repository\int(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getCopyrightEntryIDsSelectedForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::getCopyrightEntryIDsSelectedForPublishing ( )

Returns: int[]

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 110 of file Settings.php.

                                                               : array
    {
        if (isset($this->selected_cp_entry_ids)) {
            return $this->selected_cp_entry_ids;
        }
        $ids_from_storage = unserialize(
            $this->settings->get('templates', serialize([])),
            ['allowed_classes' => false]
        );
        $this->selected_cp_entry_ids = [];
        foreach ($ids_from_storage as $id) {
            $this->selected_cp_entry_ids[] = (int) $id;
        }
        return $this->selected_cp_entry_ids;
    }

References $id, ILIAS\MetaData\OERHarvester\Settings\Settings\$selected_cp_entry_ids, ILIAS\Repository\int(), and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\isCopyrightEntryIDSelectedForPublishing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectTypesEligibleForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::getObjectTypesEligibleForPublishing ( )

Returns: string[]

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 69 of file Settings.php.

                                                         : array
    {
        return self::ELIGIBLE_TYPES;
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\ELIGIBLE_TYPES.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\getObjectTypesSelectedForPublishing().

Here is the caller graph for this function:

◆ getObjectTypesSelectedForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::getObjectTypesSelectedForPublishing ( )

Returns: string[]

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 77 of file Settings.php.

                                                         : array
    {
        if (isset($this->selected_obj_types)) {
            return $this->selected_obj_types;
        }
        $types_from_storage = unserialize(
            $this->settings->get(
                'collected_types',
                serialize($this->getObjectTypesEligibleForPublishing()),
            ),
            ['allowed_classes' => false]
        );
        return $this->selected_obj_types = array_intersect(
            $types_from_storage,
            $this->getObjectTypesEligibleForPublishing()
        );
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\$selected_obj_types, ILIAS\MetaData\OERHarvester\Settings\Settings\getObjectTypesEligibleForPublishing(), and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\isObjectTypeSelectedForPublishing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAutomaticPublishingEnabled()

ILIAS\MetaData\OERHarvester\Settings\Settings::isAutomaticPublishingEnabled ( )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 208 of file Settings.php.

                                                  : bool
    {
        if (isset($this->automatic_publishing_enabled)) {
            return $this->automatic_publishing_enabled;
        }
        return $this->automatic_publishing_enabled = (bool) $this->settings->get(
            'automatic_publishing',
            '0'
        );
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\$automatic_publishing_enabled, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ isCopyrightEntryIDSelectedForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::isCopyrightEntryIDSelectedForPublishing ( int $id )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 126 of file Settings.php.

                                                                    : bool
    {
        $entry_ids = $this->getCopyrightEntryIDsSelectedForPublishing();
        return in_array($id, $entry_ids);
    }

References $id, and ILIAS\MetaData\OERHarvester\Settings\Settings\getCopyrightEntryIDsSelectedForPublishing().

Here is the call graph for this function:

◆ isEditorialStepEnabled()

ILIAS\MetaData\OERHarvester\Settings\Settings::isEditorialStepEnabled ( )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 138 of file Settings.php.

                                            : bool
    {
        if (isset($this->editorial_step_enabled)) {
            return $this->editorial_step_enabled;
        }
        return $this->editorial_step_enabled = (bool) $this->settings->get(
            'editorial_step',
            '0'
        );
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\$editorial_step_enabled, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ isManualPublishingEnabled()

ILIAS\MetaData\OERHarvester\Settings\Settings::isManualPublishingEnabled ( )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 191 of file Settings.php.

                                               : bool
    {
        if (isset($this->manual_publishing_enabled)) {
            return $this->manual_publishing_enabled;
        }
        return $this->manual_publishing_enabled = (bool) $this->settings->get(
            'manual_publishing',
            '0'
        );
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\$manual_publishing_enabled, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ isObjectTypeSelectedForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::isObjectTypeSelectedForPublishing ( string $type )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 95 of file Settings.php.

                                                                   : bool
    {
        $types = $this->getObjectTypesSelectedForPublishing();
        return in_array($type, $types);
    }

References ILIAS\MetaData\OERHarvester\Settings\Settings\getObjectTypesSelectedForPublishing().

Here is the call graph for this function:

◆ saveAutomaticPublishingEnabled()

ILIAS\MetaData\OERHarvester\Settings\Settings::saveAutomaticPublishingEnabled ( bool $enabled )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 219 of file Settings.php.

                                                                 : void
    {
        $this->editorial_step_enabled = $enabled;
        $this->settings->set('automatic_publishing', $enabled ? '1' : '0');
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ saveContainerRefIDForEditorialStep()

ILIAS\MetaData\OERHarvester\Settings\Settings::saveContainerRefIDForEditorialStep ( int $ref_id )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 166 of file Settings.php.

                                                                   : void
    {
        $this->editorial_ref_id = $ref_id;
        $this->settings->set('target', (string) $ref_id);
    }

References $ref_id, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ saveContainerRefIDForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::saveContainerRefIDForPublishing ( int $ref_id )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 183 of file Settings.php.

                                                                : void
    {
        $this->source_for_exposing_ref_id = $ref_id;
        $this->settings->set('exposed_container', (string) $ref_id);
    }

References $ref_id, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ saveCopyrightEntryIDsSelectedForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::saveCopyrightEntryIDsSelectedForPublishing ( int ... $ids )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 132 of file Settings.php.

                                                                           : void
    {
        $this->selected_cp_entry_ids = $ids;
        $this->settings->set('templates', serialize($ids));
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ saveEditorialStepEnabled()

ILIAS\MetaData\OERHarvester\Settings\Settings::saveEditorialStepEnabled ( bool $enabled )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 149 of file Settings.php.

                                                           : void
    {
        $this->editorial_step_enabled = $enabled;
        $this->settings->set('editorial_step', $enabled ? '1' : '0');
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ saveManualPublishingEnabled()

ILIAS\MetaData\OERHarvester\Settings\Settings::saveManualPublishingEnabled ( bool $enabled )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 202 of file Settings.php.

                                                              : void
    {
        $this->editorial_step_enabled = $enabled;
        $this->settings->set('manual_publishing', $enabled ? '1' : '0');
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ saveObjectTypesSelectedForPublishing()

ILIAS\MetaData\OERHarvester\Settings\Settings::saveObjectTypesSelectedForPublishing ( string ... $types )

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 101 of file Settings.php.

                                                                          : void
    {
        $this->selected_obj_types = $types;
        $this->settings->set('collected_types', serialize($types));
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

Field Documentation

◆ $automatic_publishing_enabled

bool ILIAS\MetaData\OERHarvester\Settings\Settings::$automatic_publishing_enabled

protected

Definition at line 59 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\isAutomaticPublishingEnabled().

◆ $editorial_ref_id

int ILIAS\MetaData\OERHarvester\Settings\Settings::$editorial_ref_id

protected

Definition at line 56 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\getContainerRefIDForEditorialStep().

◆ $editorial_step_enabled

bool ILIAS\MetaData\OERHarvester\Settings\Settings::$editorial_step_enabled

protected

Definition at line 55 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\isEditorialStepEnabled().

◆ $manual_publishing_enabled

bool ILIAS\MetaData\OERHarvester\Settings\Settings::$manual_publishing_enabled

protected

Definition at line 58 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\isManualPublishingEnabled().

◆ $selected_cp_entry_ids

array ILIAS\MetaData\OERHarvester\Settings\Settings::$selected_cp_entry_ids

protected

Definition at line 54 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\getCopyrightEntryIDsSelectedForPublishing().

◆ $selected_obj_types

array ILIAS\MetaData\OERHarvester\Settings\Settings::$selected_obj_types

protected

Definition at line 49 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\getObjectTypesSelectedForPublishing().

◆ $settings

ilSetting ILIAS\MetaData\OERHarvester\Settings\Settings::$settings

protected

Definition at line 44 of file Settings.php.

◆ $source_for_exposing_ref_id

int ILIAS\MetaData\OERHarvester\Settings\Settings::$source_for_exposing_ref_id

protected

Definition at line 57 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\getContainerRefIDForPublishing().

◆ ELIGIBLE_TYPES

const array ILIAS\MetaData\OERHarvester\Settings\Settings::ELIGIBLE_TYPES

protected

Initial value:

= [
        'blog',
        'copa',
        'dcl',
        'exc',
        'file',
        'glo',
        'lm',
        'htlm',
        'sahs',
        'mcst',
        'mep',
        'qpl',
        'spl',
        'webr',
        'wiki'
    ]

Definition at line 26 of file Settings.php.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\getObjectTypesEligibleForPublishing().

◆ STORAGE_IDENTIFIER

const string ILIAS\MetaData\OERHarvester\Settings\Settings::STORAGE_IDENTIFIER = 'meta_oer'

protected

Definition at line 25 of file Settings.php.

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

components/ILIAS/MetaData/classes/OERHarvester/Settings/Settings.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getContainerRefIDForEditorialStep()

◆ getContainerRefIDForPublishing()

◆ getCopyrightEntryIDsSelectedForPublishing()

◆ getObjectTypesEligibleForPublishing()

◆ getObjectTypesSelectedForPublishing()

◆ isAutomaticPublishingEnabled()

◆ isCopyrightEntryIDSelectedForPublishing()

◆ isEditorialStepEnabled()

◆ isManualPublishingEnabled()

◆ isObjectTypeSelectedForPublishing()

◆ saveAutomaticPublishingEnabled()

◆ saveContainerRefIDForEditorialStep()

◆ saveContainerRefIDForPublishing()

◆ saveCopyrightEntryIDsSelectedForPublishing()

◆ saveEditorialStepEnabled()

◆ saveManualPublishingEnabled()

◆ saveObjectTypesSelectedForPublishing()

Field Documentation

◆ $automatic_publishing_enabled

◆ $editorial_ref_id

◆ $editorial_step_enabled

◆ $manual_publishing_enabled

◆ $selected_cp_entry_ids

◆ $selected_obj_types

◆ $settings

◆ $source_for_exposing_ref_id

◆ ELIGIBLE_TYPES

◆ STORAGE_IDENTIFIER