Settings.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\OERHarvester\Settings;

class Settings implements SettingsInterface
{
    protected const string STORAGE_IDENTIFIER = 'meta_oer';
    protected const array ELIGIBLE_TYPES = [
        'blog',
        'copa',
        'dcl',
        'exc',
        'file',
        'glo',
        'lm',
        'htlm',
        'sahs',
        'mcst',
        'mep',
        'qpl',
        'spl',
        'webr',
        'wiki'
    ];

    protected \ilSetting $settings;

    protected array $selected_obj_types;

    protected array $selected_cp_entry_ids;
    protected int $target_for_harvesting_ref_id;
    protected int $source_for_exposing_ref_id;

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

    public function getObjectTypesEligibleForHarvesting(): array
    {
        return self::ELIGIBLE_TYPES;
    }

    public function getObjectTypesSelectedForHarvesting(): 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()
        );
    }

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

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

    public function getCopyrightEntryIDsSelectedForHarvesting(): 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;
    }

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

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

    public function getContainerRefIDForHarvesting(): 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'
        );
    }

    public function saveContainerRefIDForHarvesting(int $ref_id): void
    {
        $this->target_for_harvesting_ref_id = $ref_id;
        $this->settings->set('target', (string) $ref_id);
    }

    public function getContainerRefIDForExposing(): 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'
        );
    }

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