CollectionDBRepository.php

Go to the documentation of this file.

<?php

namespace ILIAS\ResourceStorage\Resource\Repository;

use ILIAS\ResourceStorage\Collection\Repository\CollectionRepository;
use ILIAS\ResourceStorage\Collection\ResourceCollection;
use ILIAS\ResourceStorage\Identification\ResourceCollectionIdentification;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Events\DataContainer;
use ILIAS\ResourceStorage\Events\CollectionData;

class CollectionDBRepository implements CollectionRepository
{
    public const COLLECTION_TABLE_NAME = 'il_resource_rc';
    public const COLLECTION_ASSIGNMENT_TABLE_NAME = 'il_resource_rca';
    public const R_IDENTIFICATION = 'rid';
    public const C_IDENTIFICATION = 'rcid';

    public function __construct(protected \ilDBInterface $db)
    {
    }

    public function getNamesForLocking(): array
    {
        return [self::COLLECTION_TABLE_NAME, self::COLLECTION_ASSIGNMENT_TABLE_NAME];
    }

    public function blank(
        ResourceCollectionIdentification $identification,
        ?int $owner_id = null,
        ?string $title = null
    ): ResourceCollection {
        return new ResourceCollection(
            $identification,
            $owner_id ?? ResourceCollection::NO_SPECIFIC_OWNER,
            $title ?? ''
        );
    }

    public function existing(ResourceCollectionIdentification $identification): ResourceCollection
    {
        $q = "SELECT owner_id, title FROM " . self::COLLECTION_TABLE_NAME . " WHERE " . self::C_IDENTIFICATION . " = %s";
        $r = $this->db->queryF($q, ['text'], [$identification->serialize()]);
        $d = $this->db->fetchObject($r);
        $owner_id = (int) ($d->owner_id ?? ResourceCollection::NO_SPECIFIC_OWNER);
        $title = (string) ($d->title ?? '');

        return $this->blank($identification, $owner_id, $title);
    }

    public function has(ResourceCollectionIdentification $identification): bool
    {
        $q = "SELECT EXISTS (
              SELECT 1 FROM " . self::COLLECTION_TABLE_NAME . " 
              WHERE " . self::C_IDENTIFICATION . " = %s
          ) AS found";

        $r = $this->db->queryF($q, ['text'], [$identification->serialize()]);
        $d = $this->db->fetchAssoc($r);

        return (bool) ($d['found'] ?? false);
    }

    public function getResourceIdStrings(ResourceCollectionIdentification $identification): \Generator
    {
        $q = "SELECT " . self::R_IDENTIFICATION . " FROM " . self::COLLECTION_ASSIGNMENT_TABLE_NAME . " WHERE " . self::C_IDENTIFICATION . " = %s ORDER BY position ASC";
        $r = $this->db->queryF($q, ['text'], [$identification->serialize()]);
        while ($d = $this->db->fetchAssoc($r)) {
            yield (string) $d[self::R_IDENTIFICATION];
        }
    }

    public function clear(ResourceCollectionIdentification $identification): void
    {
        $q = "DELETE FROM " . self::COLLECTION_ASSIGNMENT_TABLE_NAME . " WHERE " . self::C_IDENTIFICATION . " = %s";
        $r = $this->db->manipulateF($q, ['text'], [$identification->serialize()]);
    }

    public function update(ResourceCollection $collection, DataContainer $event_data_container): void
    {
        $identification = $collection->getIdentification();
        $resource_identifications = $collection->getResourceIdentifications();
        $owner_id = $collection->getOwner();
        $title = $collection->getTitle();

        $resource_identification_strings = array_map(
            static fn(ResourceIdentification $i): string => $i->serialize(),
            $resource_identifications
        );

        $q = "DELETE FROM " . self::COLLECTION_ASSIGNMENT_TABLE_NAME . " WHERE " . self::C_IDENTIFICATION . " = %s AND "
            . $this->db->in(self::R_IDENTIFICATION, $resource_identification_strings, true, 'text');
        $r = $this->db->manipulateF($q, ['text'], [$identification->serialize()]);

        $missing_resource_identification_string = array_diff(
            $resource_identification_strings,
            iterator_to_array($this->getResourceIdStrings($identification))
        );
        foreach ($missing_resource_identification_string as $position => $resource_identification_string) {
            $this->db->insert(self::COLLECTION_ASSIGNMENT_TABLE_NAME, [
                self::C_IDENTIFICATION => ['text', $identification->serialize()],
                self::R_IDENTIFICATION => ['text', $resource_identification_string],
                'position' => ['integer', (int) $position + 1],
            ]);
            $event_data_container->append(
                new CollectionData(['rid' => $resource_identification_string, 'rcid' => $identification->serialize()])
            );
        }
        foreach ($resource_identification_strings as $position => $resource_identification_string) {
            $this->db->update(
                self::COLLECTION_ASSIGNMENT_TABLE_NAME,
                [
                    self::C_IDENTIFICATION => ['text', $identification->serialize()],
                    self::R_IDENTIFICATION => ['text', $resource_identification_string],
                    'position' => ['integer', (int) $position + 1],
                ],
                [
                    self::C_IDENTIFICATION => ['text', $identification->serialize()],
                    self::R_IDENTIFICATION => ['text', $resource_identification_string],
                ]
            );
        }
        if ($this->has($identification)) {
            $this->db->update(
                self::COLLECTION_TABLE_NAME,
                [
                    self::C_IDENTIFICATION => ['text', $identification->serialize()],
                    'title' => ['text', $title ?? ''],
                    'owner_id' => ['integer', $owner_id],
                ],
                [
                    self::C_IDENTIFICATION => ['text', $identification->serialize()]
                ]
            );
        } else {
            $this->db->insert(
                self::COLLECTION_TABLE_NAME,
                [
                    self::C_IDENTIFICATION => ['text', $identification->serialize()],
                    'title' => ['text', $title ?? ''],
                    'owner_id' => ['integer', $owner_id],
                ]
            );
        }
    }

    public function removeResourceFromAllCollections(ResourceIdentification $resource_identification): void
    {
        $this->db->manipulateF(
            "DELETE FROM " . self::COLLECTION_ASSIGNMENT_TABLE_NAME . " WHERE " . self::R_IDENTIFICATION . " = %s",
            ['text'],
            [$resource_identification->serialize()]
        );
    }

    public function delete(ResourceCollectionIdentification $identification): void
    {
        $this->db->manipulateF(
            "DELETE FROM " . self::COLLECTION_ASSIGNMENT_TABLE_NAME . " WHERE " . self::C_IDENTIFICATION . " = %s",
            ['text'],
            [$identification->serialize()]
        );
        $this->db->manipulateF(
            "DELETE FROM " . self::COLLECTION_TABLE_NAME . " WHERE " . self::C_IDENTIFICATION . " = %s",
            ['text'],
            [$identification->serialize()]
        );
    }

    public function preload(array $identification_strings): void
    {
        // TODO: Implement preload() method.
    }

    public function populateFromArray(array $data): void
    {
        // TODO: Implement populateFromArray() method.
    }
}