ILIAS\ResourceStorage\Collection\Collections Class Reference

Class Collections. More...

Collaboration diagram for ILIAS\ResourceStorage\Collection\Collections:

Public Member Functions
	__construct (ResourceBuilder $resource_builder, CollectionBuilder $collection_builder, RepositoryPreloader $preloader)
	Consumers constructor. More...
	id (?string $collection_identification=null, ?int $owner=null)
	exists (string $collection_identification)
	idOrNull (?string $collection_identification=null, ?int $owner=null)
	get (ResourceCollectionIdentification $identification, ?int $owner=null)
	store (ResourceCollection $collection)
	clone (ResourceCollectionIdentification $source_collection_id)
	remove (ResourceCollectionIdentification $collection_id, ResourceStakeholder $stakeholder, bool $delete_resources_as_well=false)
	rangeAsArray (ResourceCollection $collection, int $from, int $amout)
	rangeAsGenerator (ResourceCollection $collection, int $from, int $to)
	sort (ResourceCollection $collection)

Private Attributes
array	$cache = []
ResourceBuilder	$resource_builder
CollectionBuilder	$collection_builder
RepositoryPreloader	$preloader

Detailed Description

Class Collections.

Author

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

Definition at line 36 of file Collections.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Collection\Collections::__construct	(	ResourceBuilder	$resource_builder,
		CollectionBuilder	$collection_builder,
		RepositoryPreloader	$preloader
	)

Consumers constructor.

Definition at line 46 of file Collections.php.

      {
        $this->resource_builder = $resource_builder;
        $this->collection_builder = $collection_builder;
        $this->preloader = $preloader;
    }

References ILIAS\ResourceStorage\Collection\Collections\$collection_builder, ILIAS\ResourceStorage\Collection\Collections\$preloader, and ILIAS\ResourceStorage\Collection\Collections\$resource_builder.

Member Function Documentation

clone()

ILIAS\ResourceStorage\Collection\Collections::clone

(

ResourceCollectionIdentification

$source_collection_id

)

Definition at line 120 of file Collections.php.

                                                                                 : ResourceCollectionIdentification
    {
        $target_collection_id = $this->id();
        $target_collection = $this->get($target_collection_id);
        $source_collection = $this->get($source_collection_id);
 
        foreach ($source_collection->getResourceIdentifications() as $identification) {
            $resource = $this->resource_builder->get($identification);
            $cloned_resource = $this->resource_builder->clone($resource);
            $target_collection->add($cloned_resource->getIdentification());
        }
        $this->store($target_collection);
 
        return $target_collection_id;
    }

References ILIAS\GlobalScreen\Provider\id().

Here is the call graph for this function:

exists()

ILIAS\ResourceStorage\Collection\Collections::exists

(

string

$collection_identification

)

Definition at line 78 of file Collections.php.

                                                             : bool
    {
        return $this->collection_builder->has(new ResourceCollectionIdentification($collection_identification));
    }

get()

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

Definition at line 93 of file Collections.php.

     : ResourceCollection {
        $collection = $this->cache[$identification->serialize()]
            ?? $this->collection_builder->get(
                $identification,
                $owner
            );
 
        $preload = [];
        foreach ($this->collection_builder->getResourceIds($identification) as $resource_identification) {
            if ($this->resource_builder->has($resource_identification)) {
                $collection->add($resource_identification);
                $preload[] = $resource_identification;
            }
        }
        $this->preloader->preload($preload);
 
        return $this->cache[$identification->serialize()] = $collection;
    }

References ILIAS\ResourceStorage\Collection\ResourceCollection\add(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

id()

ILIAS\ResourceStorage\Collection\Collections::id	(	?string	$collection_identification = null,
		?int	$owner = null
	)

Parameters

string | null	$collection_identification	an existing collection identification or null for a new
int | null	$owner	if this colletion is owned by a users, you must prvide it's owner ID

Definition at line 60 of file Collections.php.

     : ResourceCollectionIdentification {
        if ($collection_identification === null
            || $collection_identification === ''
            || !$this->collection_builder->has(new ResourceCollectionIdentification($collection_identification))
        ) {
            $collection = $this->collection_builder->new($owner);
            $identification = $collection->getIdentification();
            $this->cache[$identification->serialize()] = $collection;
 
            return $identification;
        }
 
        return new ResourceCollectionIdentification($collection_identification);
    }

idOrNull()

ILIAS\ResourceStorage\Collection\Collections::idOrNull	(	?string	$collection_identification = null,
		?int	$owner = null
	)

Definition at line 83 of file Collections.php.

     : ?ResourceCollectionIdentification {
        if ($this->exists($collection_identification)) {
            return $this->id($collection_identification, $owner);
        }
        return null;
    }

References ILIAS\GlobalScreen\Provider\id().

Here is the call graph for this function:

rangeAsArray()

ILIAS\ResourceStorage\Collection\Collections::rangeAsArray	(	ResourceCollection	$collection,
		int	$from,
		int	$amout
	)

Returns

ResourceIdentification[]

Definition at line 154 of file Collections.php.

                                                                                       : array
    {
        $return = [];
        foreach ($collection->getResourceIdentifications() as $position => $identification) {
            if ($position >= $from && $position < $from + $amout) {
                $return[] = $identification;
            }
        }
        return $return;
    }

References ILIAS\ResourceStorage\Collection\ResourceCollection\getResourceIdentifications().

Here is the call graph for this function:

rangeAsGenerator()

ILIAS\ResourceStorage\Collection\Collections::rangeAsGenerator	(	ResourceCollection	$collection,
		int	$from,
		int	$to
	)

Returns

\Generator|ResourceIdentification[]

Definition at line 168 of file Collections.php.

                                                                                        : \Generator
    {
        foreach ($collection->getResourceIdentifications() as $position => $identification) {
            if ($position >= $from && $position <= $to) {
                yield $identification;
            }
        }
    }

References ILIAS\ResourceStorage\Collection\ResourceCollection\getResourceIdentifications().

Here is the call graph for this function:

remove()

ILIAS\ResourceStorage\Collection\Collections::remove	(	ResourceCollectionIdentification	$collection_id,
		ResourceStakeholder	$stakeholder,
		bool	$delete_resources_as_well = false
	)

Definition at line 136 of file Collections.php.

     : bool {
        $collection = $this->get($collection_id);
        if ($delete_resources_as_well) {
            foreach ($collection->getResourceIdentifications() as $resource_identification) {
                $resource = $this->resource_builder->get($resource_identification);
                $this->resource_builder->remove($resource, $stakeholder);
            }
        }
        return $this->collection_builder->delete($collection_id);
    }

sort()

ILIAS\ResourceStorage\Collection\Collections::sort

(

ResourceCollection

$collection

)

Definition at line 177 of file Collections.php.

                                                        : Sorter
    {
        return new Sorter(
            $this->resource_builder,
            $this->collection_builder,
            $collection
        );
    }

store()

ILIAS\ResourceStorage\Collection\Collections::store

(

ResourceCollection

$collection

)

Definition at line 115 of file Collections.php.

                                                         : bool
    {
        return $this->collection_builder->store($collection);
    }

Field Documentation

$cache

array ILIAS\ResourceStorage\Collection\Collections::$cache = []

private

Definition at line 38 of file Collections.php.

$collection_builder

CollectionBuilder ILIAS\ResourceStorage\Collection\Collections::$collection_builder

private

Definition at line 40 of file Collections.php.

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

$preloader

RepositoryPreloader ILIAS\ResourceStorage\Collection\Collections::$preloader

private

Definition at line 41 of file Collections.php.

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

$resource_builder

ResourceBuilder ILIAS\ResourceStorage\Collection\Collections::$resource_builder

private

Definition at line 39 of file Collections.php.

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

---

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

• src/ResourceStorage/Collection/Collections.php