Collaboration diagram for ILIAS\ResourceStorage\Collection\CollectionBuilder:

Public Member Functions
	__construct (Repository\CollectionRepository $collection_repository, ?CollectionIdentificationGenerator $id_generator=null, ?\ILIAS\ResourceStorage\Lock\LockHandler $lock_handler=null)

	has (ResourceCollectionIdentification $identification)

	getResourceIdStrings (ResourceCollectionIdentification $identification)

	getResourceIds (ResourceCollectionIdentification $identification)

	new (?int $owner=null)

	get (ResourceCollectionIdentification $identification, ?int $owner=null)

	store (ResourceCollection $collection)

	delete (ResourceCollectionIdentification $identification)

	notififyResourceDeletion (ResourceIdentification $identification)

Private Member Functions
	validate (ResourceCollectionIdentification $identification)

Private Attributes
Repository CollectionRepository	$collection_repository

CollectionIdentificationGenerator	$id_generator = null

ILIAS ResourceStorage Lock LockHandler	$lock_handler = null

Detailed Description

Class CollectionBuilder.

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 35 of file CollectionBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ResourceStorage\Collection\CollectionBuilder::__construct	(	Repository\CollectionRepository	$collection_repository,
		?CollectionIdentificationGenerator	$id_generator = `null`,
		?\ILIAS\ResourceStorage\Lock\LockHandler	$lock_handler = `null`
	)

Definition at line 44 of file CollectionBuilder.php.

      {
        $this->collection_repository = $collection_repository;
        $this->lock_handler = $lock_handler;
        $this->id_generator = $id_generator ?? new UniqueIDCollectionIdentificationGenerator();
    }

References ILIAS\ResourceStorage\Collection\CollectionBuilder\$collection_repository, ILIAS\ResourceStorage\Collection\CollectionBuilder\$id_generator, and ILIAS\ResourceStorage\Collection\CollectionBuilder\$lock_handler.

Member Function Documentation

◆ delete()

ILIAS\ResourceStorage\Collection\CollectionBuilder::delete ( ResourceCollectionIdentification $identification )

Definition at line 121 of file CollectionBuilder.php.

                                                                            : bool
    {
        $this->collection_repository->delete($identification);
        return true;
    }

◆ get()

ILIAS\ResourceStorage\Collection\CollectionBuilder::get	(	ResourceCollectionIdentification	$identification,
		?int	$owner = `null`
	)

Definition at line 92 of file CollectionBuilder.php.

                                                                                             : ResourceCollection
    {
        $this->validate($identification);
        $existing = $this->collection_repository->existing($identification);
        if ($existing->hasSpecificOwner()
            && $existing->getOwner() !== $owner
        ) {
            throw new \InvalidArgumentException('Invalid owner of collection');
        }
        return $existing;
    }

References ILIAS\ResourceStorage\Collection\CollectionBuilder\validate().

Here is the call graph for this function:

◆ getResourceIds()

ILIAS\ResourceStorage\Collection\CollectionBuilder::getResourceIds ( ResourceCollectionIdentification $identification )

Returns: \Generator|ResourceIdentification[]

Definition at line 70 of file CollectionBuilder.php.

                                                                                    : \Generator
    {
        foreach ($this->getResourceIdStrings($identification) as $string) {
            yield new ResourceIdentification($string);
        }
    }

References ILIAS\ResourceStorage\Collection\CollectionBuilder\getResourceIdStrings().

Here is the call graph for this function:

◆ getResourceIdStrings()

ILIAS\ResourceStorage\Collection\CollectionBuilder::getResourceIdStrings ( ResourceCollectionIdentification $identification )

Returns: \Generator|string[]

Definition at line 62 of file CollectionBuilder.php.

                                                                                          : \Generator
    {
        yield from $this->collection_repository->getResourceIdStrings($identification);
    }

Referenced by ILIAS\ResourceStorage\Collection\CollectionBuilder\getResourceIds().

Here is the caller graph for this function:

◆ has()

ILIAS\ResourceStorage\Collection\CollectionBuilder::has ( ResourceCollectionIdentification $identification )

Definition at line 54 of file CollectionBuilder.php.

                                                                         : bool
    {
        return $this->collection_repository->has($identification);
    }

◆ new()

ILIAS\ResourceStorage\Collection\CollectionBuilder::new ( ?int $owner = null )

Definition at line 84 of file CollectionBuilder.php.

                                           : ResourceCollection
    {
        return $this->collection_repository->blank(
            $this->id_generator->getUniqueResourceCollectionIdentification(),
            $owner ?? ResourceCollection::NO_SPECIFIC_OWNER
        );
    }

References ILIAS\ResourceStorage\Collection\ResourceCollection\NO_SPECIFIC_OWNER.

◆ notififyResourceDeletion()

ILIAS\ResourceStorage\Collection\CollectionBuilder::notififyResourceDeletion ( ResourceIdentification $identification )

Definition at line 127 of file CollectionBuilder.php.

                                                                                    : void
    {
        $this->collection_repository->removeResourceFromAllCollections($identification);
    }

◆ store()

ILIAS\ResourceStorage\Collection\CollectionBuilder::store ( ResourceCollection $collection )

Definition at line 104 of file CollectionBuilder.php.

                                                         : bool
    {
        if ($this->lock_handler !== null) {
            $result = $this->lock_handler->lockTables(
                $this->collection_repository->getNamesForLocking(),
                function () use ($collection): void {
                    $this->collection_repository->update($collection);
                }
            );
            $result->runAndUnlock();
        } else {
            $this->collection_repository->update($collection);
        }
 
        return true;
    }

References function.

◆ validate()

ILIAS\ResourceStorage\Collection\CollectionBuilder::validate ( ResourceCollectionIdentification $identification )

private

Definition at line 77 of file CollectionBuilder.php.

                                                                               : void
    {
        if (!$this->id_generator->validateScheme($identification->serialize())) {
            throw new \InvalidArgumentException('Invalid identification scheme');
        }
    }