DatabaseManipulator.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Repository\Utilities;

use ILIAS\MetaData\Elements\RessourceID\RessourceIDInterface;
use ILIAS\MetaData\Elements\SetInterface;
use ILIAS\MetaData\Repository\Dictionary\DictionaryInterface;
use ILIAS\MetaData\Elements\ElementInterface;
use ILIAS\MetaData\Elements\Markers\MarkableInterface;
use ILIAS\MetaData\Elements\Markers\MarkerInterface;
use ILIAS\MetaData\Repository\Dictionary\TagInterface;
use ILIAS\MetaData\Elements\Markers\Action as MarkerAction;
use ILIAS\MetaData\Repository\Utilities\Queries\DatabaseQuerierInterface;
use ILIAS\MetaData\Repository\Utilities\Queries\Assignments\AssignmentFactoryInterface;
use ILIAS\MetaData\Repository\Utilities\Queries\Assignments\AssignmentRowInterface;
use ILIAS\MetaData\Repository\Utilities\Queries\Assignments\Action;
use ILIAS\MetaData\Elements\NoID;

class DatabaseManipulator implements DatabaseManipulatorInterface
{
    protected DictionaryInterface $dictionary;
    protected DatabaseQuerierInterface $querier;
    protected AssignmentFactoryInterface $assignment_factory;
    protected \ilLogger $logger;

    public function __construct(
        DictionaryInterface $dictionary,
        DatabaseQuerierInterface $querier,
        AssignmentFactoryInterface $assignment_factory,
        \ilLogger $logger
    ) {
        $this->dictionary = $dictionary;
        $this->querier = $querier;
        $this->assignment_factory = $assignment_factory;
        $this->logger = $logger;
    }

    public function deleteAllMD(RessourceIDInterface $ressource_id): void
    {
        $this->querier->deleteAll($ressource_id);
    }

    public function manipulateMD(
        SetInterface $set
    ): void {
        foreach ($set->getRoot()->getSubElements() as $sub) {
            foreach ($this->collectRowsForManipulationFromElementAndSubElements(
                0,
                $sub
            ) as $row) {
                $this->querier->manipulate(
                    $set->getRessourceID(),
                    $row
                );
            }
        }
    }

    public function transferMD(SetInterface $from_set, RessourceIDInterface $to_ressource_id): void
    {
        foreach ($from_set->getRoot()->getSubElements() as $sub) {
            foreach ($this->collectRowsForTransferFromElementAndSubElements(
                0,
                $sub
            ) as $row) {
                $this->querier->manipulate(
                    $to_ressource_id,
                    $row
                );
            }
        }
    }

    protected function collectRowsForManipulationFromElementAndSubElements(
        int $depth,
        ElementInterface $element,
        AssignmentRowInterface $current_row = null,
        bool $delete_all = false
    ): array {
        if ($depth > 20) {
            throw new \ilMDStructureException('LOM Structure is nested to deep.');
        }

        $collected_rows = [];

        $marker = $this->marker($element);
        if (!isset($marker) && !$delete_all) {
            return [];
        }

        $tag = $this->tag($element);
        if (!is_null($next_row = $this->getNewRowIfNecessary($element->getMDID(), $tag, $current_row))) {
            $current_row = $next_row;
            $collected_rows[] = $next_row;
        }

        $action = $marker?->action();
        if ($delete_all) {
            $action = MarkerAction::DELETE;
        }
        switch ($action) {
            case MarkerAction::NEUTRAL:
                if ($element->isScaffold()) {
                    return [];
                }
                break;

            case MarkerAction::CREATE_OR_UPDATE:
                if (!is_null($tag)) {
                    $this->createOrUpdateElement(
                        $element,
                        $tag,
                        $marker->dataValue(),
                        $current_row
                    );
                }
                break;

            case MarkerAction::DELETE:
                if (!is_null($tag)) {
                    $current_row->addAction($this->assignment_factory->action(
                        Action::DELETE,
                        $tag
                    ));
                }
                $delete_all = true;
        }

        foreach ($element->getSubElements() as $sub) {
            $collected_rows = array_merge(
                $collected_rows,
                $this->collectRowsForManipulationFromElementAndSubElements(
                    $depth + 1,
                    $sub,
                    $current_row,
                    $delete_all
                )
            );
        }
        return $collected_rows;
    }

    protected function collectRowsForTransferFromElementAndSubElements(
        int $depth,
        ElementInterface $element,
        AssignmentRowInterface $current_row = null
    ): array {
        if ($depth > 20) {
            throw new \ilMDStructureException('LOM Structure is nested to deep.');
        }

        $collected_rows = [];
        $marker = $this->marker($element);

        if ($element->isScaffold() && $marker?->action() !== MarkerAction::CREATE_OR_UPDATE) {
            return [];
        }
        $data_value = !is_null($marker?->dataValue()) ? $marker->dataValue() : $element->getData()->value();

        $tag = $this->tag($element);
        if (!is_null($next_row = $this->getNewRowIfNecessary(NoID::SCAFFOLD, $tag, $current_row))) {
            $current_row = $next_row;
            $collected_rows[] = $next_row;
        }

        if (!is_null($tag)) {
            $current_row->addAction($this->assignment_factory->action(
                Action::CREATE,
                $tag,
                $data_value
            ));
            if (!$current_row->id()) {
                $current_row->setId($this->querier->nextID($current_row->table()));
            }
        }

        foreach ($element->getSubElements() as $sub) {
            $collected_rows = array_merge(
                $collected_rows,
                $this->collectRowsForTransferFromElementAndSubElements(
                    $depth + 1,
                    $sub,
                    $current_row
                )
            );
        }
        return $collected_rows;
    }

    protected function getNewRowIfNecessary(
        NoID|int $md_id,
        ?TagInterface $tag,
        ?AssignmentRowInterface $current_row
    ): ?AssignmentRowInterface {
        $table = $tag?->table() ?? '';
        if ($table && $current_row?->table() !== $table) {
            return $this->assignment_factory->row(
                $table,
                is_int($md_id) ? $md_id : 0,
                $current_row?->id() ?? 0
            );
        }
        return null;
    }

    protected function createOrUpdateElement(
        ElementInterface $element,
        TagInterface $tag,
        string $data_value,
        AssignmentRowInterface $row
    ): void {
        if (!$element->isScaffold()) {
            $row->addAction($this->assignment_factory->action(
                Action::UPDATE,
                $tag,
                $data_value
            ));
        } else {
            $row->addAction($this->assignment_factory->action(
                Action::CREATE,
                $tag,
                $data_value
            ));
            if (!$row->id()) {
                $row->setId($this->querier->nextID($row->table()));
            }
        }
    }

    protected function tag(
        ElementInterface $element,
    ): ?TagInterface {
        return $this->dictionary->tagForElement($element);
    }

    protected function marker(
        ElementInterface $element
    ): ?MarkerInterface {
        if (!($element instanceof MarkableInterface) || !$element->isMarked()) {
            return null;
        }
        return $element->getMarker();
    }
}