ResourceCollection.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ResourceStorage\Collection;

use ILIAS\ResourceStorage\Identification\ResourceCollectionIdentification;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;

class ResourceCollection
{
    public const NO_SPECIFIC_OWNER = -1;
    private array $resource_identifications = [];
    private string $title = 'default';
    private ResourceCollectionIdentification $identification;
    private int $owner;

    public function __construct(
        ResourceCollectionIdentification $identification,
        int $owner,
        string $title // currently unused
    ) {
        $this->identification = $identification;
        $this->owner = $owner;
    }

    public function getIdentification(): ResourceCollectionIdentification
    {
        return $this->identification;
    }

    public function hasSpecificOwner(): bool
    {
        return $this->owner !== self::NO_SPECIFIC_OWNER;
    }

    public function getOwner(): int
    {
        return $this->owner;
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function add(ResourceIdentification $identification): void
    {
        if ($this->isIn($identification)) {
            return;
        }
        $this->resource_identifications[] = $identification;
    }

    public function remove(ResourceIdentification $identification): void
    {
        $this->resource_identifications = array_filter(
            $this->resource_identifications,
            fn(ResourceIdentification $i): bool => $i->serialize() !== $identification->serialize()
        );
    }

    public function isIn(ResourceIdentification $identification): bool
    {
        foreach ($this->resource_identifications as $i) {
            if ($i->serialize() === $identification->serialize()) {
                return true;
            }
        }
        return false;
    }

    public function getResourceIdentifications(): array
    {
        return $this->resource_identifications;
    }

    public function count(): int
    {
        return count($this->resource_identifications);
    }

    public function clear(): void
    {
        $this->resource_identifications = [];
    }
}