ILIAS\ResourceStorage\Collection\CollectionBuilder Class Reference

Class CollectionBuilder. More...

Collaboration diagram for ILIAS\ResourceStorage\Collection\CollectionBuilder:

Public Member Functions
	__construct (Repository\CollectionRepository $collection_repository, private Subject $events, ?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 38 of file CollectionBuilder.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 47 of file CollectionBuilder.php.

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

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

Member Function Documentation

delete()

ILIAS\ResourceStorage\Collection\CollectionBuilder::delete

(

ResourceCollectionIdentification

$identification

)

Definition at line 136 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 96 of file CollectionBuilder.php.

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

                                                                                             : ResourceCollection
    {
        $this->validate($identification);
        $existing = $this->collection_repository->existing($identification);
        if ($existing->hasSpecificOwner()
            && $existing->getOwner() !== $owner
        ) {
            // The original plan was that collections could be explicitly assigned to a user as an option.
            // Such collections can then only be read by that user. However, the concept was never described
            // and the check has therefore now been deactivated.
            // See, for example, https://mantis.ilias.de/view.php?id=42127#c112463
            // throw new \InvalidArgumentException('Invalid owner of collection');

        }
        return $existing;
    }

Here is the call graph for this function:

getResourceIds()

ILIAS\ResourceStorage\Collection\CollectionBuilder::getResourceIds

(

ResourceCollectionIdentification

$identification

)

Returns

|ResourceIdentification[]

Definition at line 74 of file CollectionBuilder.php.

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

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

Here is the call graph for this function:

getResourceIdStrings()

ILIAS\ResourceStorage\Collection\CollectionBuilder::getResourceIdStrings

(

ResourceCollectionIdentification

$identification

)

Returns

|string[]

Definition at line 66 of file CollectionBuilder.php.

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

has()

ILIAS\ResourceStorage\Collection\CollectionBuilder::has

(

ResourceCollectionIdentification

$identification

)

Definition at line 58 of file CollectionBuilder.php.

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

new()

ILIAS\ResourceStorage\Collection\CollectionBuilder::new

(

?int

$owner = null

)

Definition at line 88 of file CollectionBuilder.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\NO_SPECIFIC_OWNER.

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

notififyResourceDeletion()

ILIAS\ResourceStorage\Collection\CollectionBuilder::notififyResourceDeletion

(

ResourceIdentification

$identification

)

Definition at line 142 of file CollectionBuilder.php.

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

store()

ILIAS\ResourceStorage\Collection\CollectionBuilder::store

(

ResourceCollection

$collection

)

Definition at line 113 of file CollectionBuilder.php.

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

        // notify about the change. we must do this after the lock is released
        foreach ($event_data_container->get() as $event_data) {
            $this->events->notify(Event::COLLECTION_RESOURCE_ADDED, $event_data);
        }

        return true;
    }

validate()

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

private

Definition at line 81 of file CollectionBuilder.php.

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$collection_repository

Repository CollectionRepository ILIAS\ResourceStorage\Collection\CollectionBuilder::$collection_repository

private

Definition at line 42 of file CollectionBuilder.php.

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

$id_generator

CollectionIdentificationGenerator ILIAS\ResourceStorage\Collection\CollectionBuilder::$id_generator = null

private

Definition at line 43 of file CollectionBuilder.php.

$lock_handler

ILIAS ResourceStorage Lock LockHandler ILIAS\ResourceStorage\Collection\CollectionBuilder::$lock_handler = null

private

Definition at line 44 of file CollectionBuilder.php.

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

---

The documentation for this class was generated from the following file:

• src/ResourceStorage/Collection/CollectionBuilder.php