ILIAS\ResourceStorage\Revision\RevisionCollection Class Reference

Class RevisionCollection. More...

Collaboration diagram for ILIAS\ResourceStorage\Revision\RevisionCollection:

Public Member Functions
	__construct (ResourceIdentification $identification, array $revisions=[])
	RevisionCollection constructor. More...
	add (Revision $revision)
	remove (Revision $revision)
	replaceSingleRevision (Revision $revision)
	replaceAllRevisions (Revision $revision)
	getCurrent (bool $including_drafts)
	getAll (bool $including_drafts)
	getMax (bool $including_drafts)
	getFullSize ()

Private Attributes
ResourceIdentification	$identification
array	$revisions = []

Detailed Description

Class RevisionCollection.

Author

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

Definition at line 29 of file RevisionCollection.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Revision\RevisionCollection::__construct	(	ResourceIdentification	$identification,
		array	$revisions = []
	)

RevisionCollection constructor.

Parameters

FileRevision[]

$revisions

Definition at line 41 of file RevisionCollection.php.

References ILIAS\ResourceStorage\Revision\RevisionCollection\$identification, and ILIAS\ResourceStorage\Revision\RevisionCollection\$revisions.

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

Member Function Documentation

add()

ILIAS\ResourceStorage\Revision\RevisionCollection::add

(

Revision

$revision

)

Definition at line 47 of file RevisionCollection.php.

References $r, ILIAS\ResourceStorage\Revision\Revision\getIdentification(), and ILIAS\ResourceStorage\Revision\Revision\getVersionNumber().

Referenced by ILIAS\ResourceStorage\Revision\Repository\RevisionDBRepository\get(), and ILIAS\ResourceStorage\Revision\RevisionCollection\replaceAllRevisions().

                                           : void
    {
        if ($this->identification->serialize() !== $revision->getIdentification()->serialize()) {
            throw new NonMatchingIdentificationException(
                "Can't add Revision since it's not the same ResourceIdentification"
            );
        }
        foreach ($this->revisions as $r) {
            if ($r->getVersionNumber() === $revision->getVersionNumber()) {
                throw new RevisionExistsException(
                    sprintf(
                        "Can't add already existing version number: %s",
                        $revision->getVersionNumber()
                    )
                );
            }
        }
        $this->revisions[$revision->getVersionNumber()] = $revision;
        asort($this->revisions);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAll()

ILIAS\ResourceStorage\Revision\RevisionCollection::getAll

(

bool

$including_drafts

)

Returns

Revision[]

Definition at line 118 of file RevisionCollection.php.

References ILIAS\ResourceStorage\Revision\RevisionCollection\$revisions, and ILIAS\ResourceStorage\Revision\Revision\getStatus().

                                                  : array
    {
        if($including_drafts) {
            return $this->revisions;
        }
        return array_filter($this->revisions, static function (Revision $revision): bool {
            return $revision->getStatus() === RevisionStatus::PUBLISHED;
        });
    }

Here is the call graph for this function:

getCurrent()

ILIAS\ResourceStorage\Revision\RevisionCollection::getCurrent

(

bool

$including_drafts

)

Definition at line 94 of file RevisionCollection.php.

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\ResourceStorage\Revision\RevisionCollection\$revisions, ILIAS\ResourceStorage\Revision\Revision\getStatus(), and ILIAS\ResourceStorage\Revision\Revision\getVersionNumber().

Referenced by ILIAS\ResourceStorage\Revision\RevisionCollection\getMax().

                                                      : Revision
    {
        $v = $this->revisions;

        if (!$including_drafts) {
            $v = array_filter($v, static function (Revision $revision): bool {
                return $revision->getStatus() === RevisionStatus::PUBLISHED;
            });
        }
        usort($v, static function (Revision $a, Revision $b): int {
            return $a->getVersionNumber() <=> $b->getVersionNumber();
        });

        $current = end($v);
        if (!$current instanceof Revision) {
            $current = new NullRevision($this->identification);
        }

        return $current;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFullSize()

ILIAS\ResourceStorage\Revision\RevisionCollection::getFullSize

(

)

Definition at line 136 of file RevisionCollection.php.

                                 : int
    {
        $size = 0;
        foreach ($this->revisions as $revision) {
            $size += $revision->getInformation()->getSize();
        }

        return $size;
    }

getMax()

ILIAS\ResourceStorage\Revision\RevisionCollection::getMax

(

bool

$including_drafts

)

Definition at line 128 of file RevisionCollection.php.

References ILIAS\ResourceStorage\Revision\RevisionCollection\getCurrent().

                                                  : int
    {
        if ($this->revisions === []) {
            return 0;
        }
        return $this->getCurrent($including_drafts)->getVersionNumber();
    }

Here is the call graph for this function:

remove()

ILIAS\ResourceStorage\Revision\RevisionCollection::remove

(

Revision

$revision

)

Definition at line 68 of file RevisionCollection.php.

                                              : void
    {
        foreach ($this->revisions as $k => $revision_e) {
            if ($revision->getVersionNumber() === $revision_e->getVersionNumber()) {
                unset($this->revisions[$k]);

                return;
            }
        }
    }

replaceAllRevisions()

ILIAS\ResourceStorage\Revision\RevisionCollection::replaceAllRevisions

(

Revision

$revision

)

Definition at line 88 of file RevisionCollection.php.

References ILIAS\ResourceStorage\Revision\RevisionCollection\add().

                                                           : void
    {
        $this->revisions = [];
        $this->add($revision);
    }

Here is the call graph for this function:

replaceSingleRevision()

ILIAS\ResourceStorage\Revision\RevisionCollection::replaceSingleRevision

(

Revision

$revision

)

Definition at line 79 of file RevisionCollection.php.

References ILIAS\ResourceStorage\Revision\Revision\getVersionNumber().

                                                             : void
    {
        foreach ($this->revisions as $k => $revision_e) {
            if ($revision_e->getVersionNumber() === $revision->getVersionNumber()) {
                $this->revisions[$k] = $revision;
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$identification

ResourceIdentification ILIAS\ResourceStorage\Revision\RevisionCollection::$identification

private

Definition at line 31 of file RevisionCollection.php.

Referenced by ILIAS\ResourceStorage\Revision\RevisionCollection\__construct().

$revisions

array ILIAS\ResourceStorage\Revision\RevisionCollection::$revisions = []

private

Definition at line 35 of file RevisionCollection.php.

Referenced by ILIAS\ResourceStorage\Revision\RevisionCollection\__construct(), ILIAS\ResourceStorage\Revision\RevisionCollection\getAll(), and ILIAS\ResourceStorage\Revision\RevisionCollection\getCurrent().

---

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

• src/ResourceStorage/Revision/RevisionCollection.php