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

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

Public Member Functions
	__construct ()

	getObjectTypesEligibleForHarvesting ()

	getObjectTypesSelectedForHarvesting ()

	isObjectTypeSelectedForHarvesting (string $type)

	saveObjectTypesSelectedForHarvesting (string ... $types)

	getCopyrightEntryIDsSelectedForHarvesting ()

	isCopyrightEntryIDSelectedForHarvesting (int $id)

	saveCopyrightEntryIDsSelectedForHarvesting (int ... $ids)

	getContainerRefIDForHarvesting ()

	saveContainerRefIDForHarvesting (int $ref_id)

	getContainerRefIDForExposing ()

	saveContainerRefIDForExposing (int $ref_id)

	getObjectTypesEligibleForHarvesting ()

	getObjectTypesSelectedForHarvesting ()

	isObjectTypeSelectedForHarvesting (string $type)

	saveObjectTypesSelectedForHarvesting (string ... $types)

	getCopyrightEntryIDsSelectedForHarvesting ()

	isCopyrightEntryIDSelectedForHarvesting (int $id)

	saveCopyrightEntryIDsSelectedForHarvesting (int ... $ids)

	getContainerRefIDForHarvesting ()

	saveContainerRefIDForHarvesting (int $ref_id)

	getContainerRefIDForExposing ()

	saveContainerRefIDForExposing (int $ref_id)

Protected Attributes
const string	STORAGE_IDENTIFIER = 'meta_oer'

const array	ELIGIBLE_TYPES

ilSetting	$settings

array	$selected_obj_types

array	$selected_cp_entry_ids

int	$target_for_harvesting_ref_id

int	$source_for_exposing_ref_id

Detailed Description

Definition at line 23 of file Settings.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 58 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

◆ getContainerRefIDForExposing()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 152 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:

◆ getContainerRefIDForHarvesting()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 135 of file Settings.php.

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

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

Here is the call graph for this function:

◆ getCopyrightEntryIDsSelectedForHarvesting()

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

Returns: int[]

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 107 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\isCopyrightEntryIDSelectedForHarvesting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectTypesEligibleForHarvesting()

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

Returns: string[]

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 66 of file Settings.php.

                                                         : array
    {
        return self::ELIGIBLE_TYPES;
    }

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

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

Here is the caller graph for this function:

◆ getObjectTypesSelectedForHarvesting()

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

Returns: string[]

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 74 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->getObjectTypesEligibleForHarvesting()),
            ),
            ['allowed_classes' => false]
        );
        return $this->selected_obj_types = array_intersect(
            $types_from_storage,
            $this->getObjectTypesEligibleForHarvesting()
        );
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCopyrightEntryIDSelectedForHarvesting()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 123 of file Settings.php.

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

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

Here is the call graph for this function:

◆ isObjectTypeSelectedForHarvesting()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 92 of file Settings.php.

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

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

Here is the call graph for this function:

◆ saveContainerRefIDForExposing()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 163 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:

◆ saveContainerRefIDForHarvesting()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 146 of file Settings.php.

                                                                : void
    {
        $this->target_for_harvesting_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:

◆ saveCopyrightEntryIDsSelectedForHarvesting()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 129 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:

◆ saveObjectTypesSelectedForHarvesting()

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

Implements ILIAS\MetaData\OERHarvester\Settings\SettingsInterface.

Definition at line 98 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

◆ $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\getCopyrightEntryIDsSelectedForHarvesting().

◆ $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\getObjectTypesSelectedForHarvesting().

◆ $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 56 of file Settings.php.

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

◆ $target_for_harvesting_ref_id

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

protected

Definition at line 55 of file Settings.php.

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

◆ 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\getObjectTypesEligibleForHarvesting().

◆ 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

◆ getContainerRefIDForExposing()

◆ getContainerRefIDForHarvesting()

◆ getCopyrightEntryIDsSelectedForHarvesting()

◆ getObjectTypesEligibleForHarvesting()

◆ getObjectTypesSelectedForHarvesting()

◆ isCopyrightEntryIDSelectedForHarvesting()

◆ isObjectTypeSelectedForHarvesting()

◆ saveContainerRefIDForExposing()

◆ saveContainerRefIDForHarvesting()

◆ saveCopyrightEntryIDsSelectedForHarvesting()

◆ saveObjectTypesSelectedForHarvesting()

Field Documentation

◆ $selected_cp_entry_ids

◆ $selected_obj_types

◆ $settings

◆ $source_for_exposing_ref_id

◆ $target_for_harvesting_ref_id

◆ ELIGIBLE_TYPES

◆ STORAGE_IDENTIFIER