ILIAS\ResourceStorage\Collection\ResourceCollection Class Reference

Class ResourceCollection. More...

Collaboration diagram for ILIAS\ResourceStorage\Collection\ResourceCollection:

Public Member Functions
	__construct (ResourceCollectionIdentification $identification, int $owner, string $title)
	getIdentification ()
	hasSpecificOwner ()
	getOwner ()
	getTitle ()
	add (ResourceIdentification $identification)
	remove (ResourceIdentification $identification)
	isIn (ResourceIdentification $identification)
	getResourceIdentifications ()
	count ()
	clear ()

Data Fields
const	NO_SPECIFIC_OWNER = -1

Private Attributes
array	$resource_identifications = []
string	$title = 'default'
ResourceCollectionIdentification	$identification
int	$owner

Detailed Description

Class ResourceCollection.

Author

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

Definition at line 32 of file ResourceCollection.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Collection\ResourceCollection::__construct	(	ResourceCollectionIdentification	$identification,
		int	$owner,
		string	$title
	)

Definition at line 43 of file ResourceCollection.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\$identification, and ILIAS\ResourceStorage\Collection\ResourceCollection\$owner.

      {
        $this->identification = $identification;
        $this->owner = $owner;
    }

Member Function Documentation

add()

ILIAS\ResourceStorage\Collection\ResourceCollection::add

(

ResourceIdentification

$identification

)

Definition at line 72 of file ResourceCollection.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\$identification, and ILIAS\ResourceStorage\Collection\ResourceCollection\isIn().

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\addEntryOfZipResourceToCollection(), ILIAS\Exercise\IRSS\CollectionWrapper\importFilesFromDirectoryToCollection(), ILIAS\Exercise\IRSS\CollectionWrapper\importFilesFromLegacyUploadToCollection(), and ILIAS\ResourceStorage\Collection\Sorter\AbstractBaseSorter\sort().

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

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

ILIAS\ResourceStorage\Collection\ResourceCollection::clear

(

)

Definition at line 111 of file ResourceCollection.php.

Referenced by ILIAS\ResourceStorage\Collection\Sorter\AbstractBaseSorter\sort().

                           : void
    {
        $this->resource_identifications = [];
    }

Here is the caller graph for this function:

count()

ILIAS\ResourceStorage\Collection\ResourceCollection::count

(

)

Definition at line 106 of file ResourceCollection.php.

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

getIdentification()

ILIAS\ResourceStorage\Collection\ResourceCollection::getIdentification

(

)

Definition at line 52 of file ResourceCollection.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\$identification.

Referenced by ILIAS\ResourceStorage\Collection\Collections\store(), and ILIAS\ResourceStorage\Resource\Repository\CollectionDBRepository\update().

                                       : ResourceCollectionIdentification
    {
        return $this->identification;
    }

Here is the caller graph for this function:

getOwner()

ILIAS\ResourceStorage\Collection\ResourceCollection::getOwner

(

)

Definition at line 62 of file ResourceCollection.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\$owner.

Referenced by ILIAS\ResourceStorage\Resource\Repository\CollectionDBRepository\update().

                              : int
    {
        return $this->owner;
    }

Here is the caller graph for this function:

getResourceIdentifications()

ILIAS\ResourceStorage\Collection\ResourceCollection::getResourceIdentifications

(

)

Returns

ResourceIdentification[]

Definition at line 101 of file ResourceCollection.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\$resource_identifications.

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\getCollectionResourcesInfo(), ILIAS\ResourceStorage\Resource\CollectionSortingTest\getFlatOrder(), ILIAS\ResourceStorage\Collection\Collections\rangeAsArray(), ILIAS\ResourceStorage\Collection\Collections\rangeAsGenerator(), ILIAS\ResourceStorage\Collection\Sorter\AbstractBaseSorter\sort(), and ILIAS\ResourceStorage\Resource\Repository\CollectionDBRepository\update().

                                                : array
    {
        return $this->resource_identifications;
    }

Here is the caller graph for this function:

getTitle()

ILIAS\ResourceStorage\Collection\ResourceCollection::getTitle

(

)

Definition at line 67 of file ResourceCollection.php.

References ILIAS\ResourceStorage\Collection\ResourceCollection\$title.

Referenced by ILIAS\ResourceStorage\Resource\Repository\CollectionDBRepository\update().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

hasSpecificOwner()

ILIAS\ResourceStorage\Collection\ResourceCollection::hasSpecificOwner

(

)

Definition at line 57 of file ResourceCollection.php.

                                      : bool
    {
        return $this->owner !== self::NO_SPECIFIC_OWNER;
    }

isIn()

ILIAS\ResourceStorage\Collection\ResourceCollection::isIn

(

ResourceIdentification

$identification

)

Definition at line 88 of file ResourceCollection.php.

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

Referenced by ILIAS\ResourceStorage\Collection\ResourceCollection\add().

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

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

ILIAS\ResourceStorage\Collection\ResourceCollection::remove

(

ResourceIdentification

$identification

)

Definition at line 80 of file ResourceCollection.php.

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

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

Here is the call graph for this function:

Field Documentation

$identification

ResourceCollectionIdentification ILIAS\ResourceStorage\Collection\ResourceCollection::$identification

private

Definition at line 40 of file ResourceCollection.php.

Referenced by ILIAS\ResourceStorage\Collection\ResourceCollection\__construct(), ILIAS\ResourceStorage\Collection\ResourceCollection\add(), and ILIAS\ResourceStorage\Collection\ResourceCollection\getIdentification().

$owner

int ILIAS\ResourceStorage\Collection\ResourceCollection::$owner

private

Definition at line 41 of file ResourceCollection.php.

Referenced by ILIAS\ResourceStorage\Collection\ResourceCollection\__construct(), and ILIAS\ResourceStorage\Collection\ResourceCollection\getOwner().

$resource_identifications

array ILIAS\ResourceStorage\Collection\ResourceCollection::$resource_identifications = []

private

Definition at line 35 of file ResourceCollection.php.

Referenced by ILIAS\ResourceStorage\Collection\ResourceCollection\getResourceIdentifications().

$title

string ILIAS\ResourceStorage\Collection\ResourceCollection::$title = 'default'

private

Definition at line 39 of file ResourceCollection.php.

Referenced by ILIAS\ResourceStorage\Collection\ResourceCollection\getTitle().

NO_SPECIFIC_OWNER

const ILIAS\ResourceStorage\Collection\ResourceCollection::NO_SPECIFIC_OWNER = -1

Definition at line 34 of file ResourceCollection.php.

Referenced by ILIAS\ResourceStorage\Resource\Repository\CollectionDBRepository\blank(), ILIAS\ResourceStorage\Resource\Repository\CollectionDBRepository\existing(), ILIAS\ResourceStorage\Collection\CollectionBuilder\new(), ILIAS\ResourceStorage\Resource\CollectionSortingTest\setUp(), ILIAS\ResourceStorage\Resource\CollectionTest\testAddAndRemove(), and ILIAS\ResourceStorage\Resource\CollectionTest\testDuplicates().

---

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

• src/ResourceStorage/Collection/ResourceCollection.php