ManipulatorAdapter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Editor\Digest;

use ILIAS\MetaData\Elements\SetInterface;
use ILIAS\MetaData\Editor\Http\RequestForFormInterface;
use ILIAS\MetaData\Paths\FactoryInterface as PathFactory;
use ILIAS\MetaData\Paths\Navigator\NavigatorFactoryInterface;
use ILIAS\MetaData\Editor\Manipulator\ManipulatorInterface;
use ILIAS\MetaData\Vocabularies\Dictionary\LOMDictionaryInitiator;

class ManipulatorAdapter
{
    protected ContentAssembler $content_assembler;
    protected CopyrightHandler $copyright_handler;
    protected PathCollection $path_collection;
    protected ManipulatorInterface $manipulator;
    protected PathFactory $path_factory;
    protected NavigatorFactoryInterface $navigator_factory;

    public function __construct(
        ContentAssembler $content_assembler,
        CopyrightHandler $copyright_handler,
        PathCollection $path_collection,
        ManipulatorInterface $manipulator,
        PathFactory $path_factory,
        NavigatorFactoryInterface $navigator_factory
    ) {
        $this->content_assembler = $content_assembler;
        $this->copyright_handler = $copyright_handler;
        $this->path_collection = $path_collection;
        $this->manipulator = $manipulator;
        $this->path_factory = $path_factory;
        $this->navigator_factory = $navigator_factory;
    }

    public function update(
        SetInterface $set,
        RequestForFormInterface $request
    ): bool {
        $form = null;
        foreach ($this->content_assembler->get($set, $request) as $type => $entity) {
            if ($type === ContentType::FORM) {
                $form = $entity;
                break;
            }
        }

        if (!$form?->getData()) {
            return false;
        }
        $data = $form->getData();

        $set = $this->prepareGeneral($set, $data[ContentAssembler::GENERAL]);
        $set = $this->prepareAuthors($set, $data[ContentAssembler::AUTHORS]);
        if (
            $this->copyright_handler->isCPSelectionActive() &&
            isset($data[ContentAssembler::RIGHTS])
        ) {
            $set = $this->prepareRights($set, $data[ContentAssembler::RIGHTS][0]);
        }
        $set = $this->prepareTypicalLearningTime($set, $data[ContentAssembler::TYPICAL_LEARNING_TIME]);

        $this->manipulator->execute($set);
        return true;
    }

    protected function prepareGeneral(
        SetInterface $set,
        array $data
    ): SetInterface {
        foreach ($data as $post_key => $value) {
            if ($post_key === ContentAssembler::KEYWORDS) {
                $set = $this->prepareKeywords($set, $value);
                continue;
            }
            $path = $this->path_factory->fromString($post_key);
            if ($value === null || $value === '') {
                $set = $this->manipulator->prepareDelete($set, $path);
                continue;
            }
            $set = $this->manipulator->prepareCreateOrUpdate($set, $path, $value);
        }
        return $set;
    }

    protected function prepareKeywords(
        SetInterface $set,
        array $values
    ): SetInterface {
        $keyword_els = $this->navigator_factory->navigator(
            $path = $this->path_collection->keywords(),
            $set->getRoot()
        )->elementsAtFinalStep();
        $number_of_keywords = count(iterator_to_array($keyword_els));

        if (!empty($values)) {
            $set = $this->manipulator->prepareCreateOrUpdate($set, $path, ...$values);
        }
        if (count($values) < $number_of_keywords) {
            $delete_path = $this->path_collection->keywordsBetweenIndices(
                count($values),
                $number_of_keywords - 1
            );
            $set = $this->manipulator->prepareDelete($set, $delete_path);
        }
        return $set;
    }

    protected function prepareTypicalLearningTime(
        SetInterface $set,
        array $data
    ): SetInterface {
        foreach ($data as $post_key => $value) {
            $path = $this->path_factory->fromString($post_key);
            if ($value === null || $value === '') {
                $set = $this->manipulator->prepareDelete($set, $path);
                continue;
            }
            $set = $this->manipulator->prepareCreateOrUpdate($set, $path, $value);
        }
        return $set;
    }

    protected function prepareAuthors(
        SetInterface $set,
        array $data
    ): SetInterface {
        $paths = [
            ContentAssembler::FIRST_AUTHOR => $this->path_collection->firstAuthor(),
            ContentAssembler::SECOND_AUTHOR => $this->path_collection->secondAuthor(),
            ContentAssembler::THIRD_AUTHOR => $this->path_collection->thirdAuthor()
        ];
        foreach ($data as $post_key => $value) {
            $path = $paths[$post_key];
            if ($value === null || $value === '') {
                $set = $this->manipulator->prepareDelete($set, $path);
                continue;
            }
            $set = $this->manipulator->prepareCreateOrUpdate($set, $path, $value);
        }
        return $set;
    }

    protected function prepareRights(
        SetInterface $set,
        array $data
    ): SetInterface {
        $description = $data[0];
        if ($description === ContentAssembler::CUSTOM_CP) {
            $description = $data[1][ContentAssembler::CUSTOM_CP_DESCRIPTION];
        }

        if ($description === '' || $description === null) {
            $set = $this->manipulator->prepareCreateOrUpdate(
                $set,
                $this->path_collection->hasCopyright(),
                'no'
            );
            $set = $this->manipulator->prepareCreateOrUpdate(
                $set,
                $this->path_collection->sourceForHasCopyright(),
                LOMDictionaryInitiator::SOURCE
            );
            return $this->manipulator->prepareDelete($set, $this->path_collection->copyright());
        }

        $set = $this->manipulator->prepareCreateOrUpdate(
            $set,
            $this->path_collection->hasCopyright(),
            'yes'
        );
        $set = $this->manipulator->prepareCreateOrUpdate(
            $set,
            $this->path_collection->sourceForHasCopyright(),
            LOMDictionaryInitiator::SOURCE
        );
        $set = $this->manipulator->prepareCreateOrUpdate(
            $set,
            $this->path_collection->copyright(),
            $description
        );

        if (
            $this->copyright_handler->doesObjectTypeSupportHarvesting($set->getRessourceID()->type()) &&
            isset($data[1][ContentAssembler::OER_BLOCKED])
        ) {
            $this->copyright_handler->setOerHarvesterBlocked(
                $set->getRessourceID()->objID(),
                (bool) $data[1][ContentAssembler::OER_BLOCKED]
            );
        }

        return $set;
    }
}