ILIAS\ResourceStorage\Resource\AbstractStorableResource Class Reference

Inheritance diagram for ILIAS\ResourceStorage\Resource\AbstractStorableResource:

Collaboration diagram for ILIAS\ResourceStorage\Resource\AbstractStorableResource:

Public Member Functions
	__construct (protected ResourceIdentification $identification)
	StorableFileResource constructor. More...
	getIdentification ()
	getCurrentRevision ()
	getCurrentRevisionIncludingDraft ()
	getSpecificRevision (int $number)
	hasSpecificRevision (int $number)
	getAllRevisions ()
	getAllRevisionsIncludingDraft ()
	addRevision (Revision $revision)
	removeRevision (Revision $revision)
	replaceRevision (Revision $revision)
	setRevisions (RevisionCollection $collection)
	getStakeholders ()
	addStakeholder (ResourceStakeholder $s)
	removeStakeholder (ResourceStakeholder $s)
	setStakeholders (array $stakeholders)
	getStorageId ()
	setStorageId (string $storage_id)
	getMaxRevision (bool $including_drafts=false)
	getFullSize ()
	getType ()
Public Member Functions inherited from ILIAS\ResourceStorage\Resource\StorableResource
	getStorageID ()
	setStorageID (string $storage_id)

Protected Attributes
RevisionCollection	$revisions
array	$stakeholders = []
string	$storage_id = ''

Detailed Description

Author

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

Definition at line 31 of file AbstractStorableResource.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::__construct

(

protected ResourceIdentification

$identification

)

StorableFileResource constructor.

Definition at line 43 of file AbstractStorableResource.php.

    {
        $this->revisions = new RevisionCollection($this->identification);
    }

Member Function Documentation

addRevision()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::addRevision

(

Revision

$revision

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 99 of file AbstractStorableResource.php.

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

addStakeholder()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::addStakeholder

(

ResourceStakeholder

$s

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 127 of file AbstractStorableResource.php.

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

getAllRevisions()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getAllRevisions

(

)

Returns

Revision[]

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 86 of file AbstractStorableResource.php.

                                     : array
    {
        return $this->revisions->getAll(false);
    }

getAllRevisionsIncludingDraft()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getAllRevisionsIncludingDraft

(

)

Returns

Revision[]

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 94 of file AbstractStorableResource.php.

Referenced by ILIAS\ResourceStorage\Resource\AbstractStorableResource\getSpecificRevision(), and ILIAS\ResourceStorage\Resource\AbstractStorableResource\hasSpecificRevision().

                                                   : array
    {
        return $this->revisions->getAll(true);
    }

Here is the caller graph for this function:

getCurrentRevision()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getCurrentRevision

(

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 53 of file AbstractStorableResource.php.

                                        : Revision
    {
        return $this->revisions->getCurrent(false);
    }

getCurrentRevisionIncludingDraft()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getCurrentRevisionIncludingDraft

(

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 58 of file AbstractStorableResource.php.

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\addStreamToContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\addUploadToContainer(), ILIAS\ResourceStorage\Resource\ResourceBuilder\createDirectoryInsideContainer(), and ILIAS\ResourceStorage\Resource\ResourceBuilder\removePathInsideContainer().

                                                      : Revision
    {
        return $this->revisions->getCurrent(true);
    }

Here is the caller graph for this function:

getFullSize()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getFullSize

(

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 170 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Resource\AbstractStorableResource\getType().

                                 : int
    {
        return $this->revisions->getFullSize();
    }

Here is the call graph for this function:

getIdentification()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getIdentification

(

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 48 of file AbstractStorableResource.php.

                                       : ResourceIdentification
    {
        return $this->identification;
    }

getMaxRevision()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getMaxRevision

(

bool

$including_drafts = false

)

Parameters

bool

$including_drafts

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 165 of file AbstractStorableResource.php.

                                                                  : int
    {
        return $this->revisions->getMax($including_drafts);
    }

getSpecificRevision()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getSpecificRevision

(

int

$number

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 63 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Resource\AbstractStorableResource\getAllRevisionsIncludingDraft(), and null.

                                                    : ?Revision
    {
        foreach ($this->getAllRevisionsIncludingDraft() as $revision) {
            if ($revision->getVersionNumber() === $number) {
                return $revision;
            }
        }
        return null;
    }

Here is the call graph for this function:

getStakeholders()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getStakeholders

(

)

Returns

ResourceStakeholder[]

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 122 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Resource\AbstractStorableResource\$stakeholders.

                                     : array
    {
        return $this->stakeholders;
    }

getStorageId()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getStorageId

(

)

Definition at line 151 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Resource\AbstractStorableResource\$storage_id.

                                  : string
    {
        return $this->storage_id;
    }

getType()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::getType ( )

abstract

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Referenced by ILIAS\ResourceStorage\Resource\AbstractStorableResource\getFullSize().

Here is the caller graph for this function:

hasSpecificRevision()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::hasSpecificRevision

(

int

$number

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 73 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Resource\AbstractStorableResource\getAllRevisionsIncludingDraft().

                                                    : bool
    {
        foreach ($this->getAllRevisionsIncludingDraft() as $revision) {
            if ($revision->getVersionNumber() === $number) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

removeRevision()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::removeRevision

(

Revision

$revision

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 104 of file AbstractStorableResource.php.

                                                      : void
    {
        $this->revisions->remove($revision);
    }

removeStakeholder()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::removeStakeholder

(

ResourceStakeholder

$s

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 132 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getId().

                                                             : void
    {
        foreach ($this->stakeholders as $k => $stakeholder) {
            if ($stakeholder->getId() === $s->getId()) {
                unset($this->stakeholders[$k]);
            }
        }
    }

Here is the call graph for this function:

replaceRevision()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::replaceRevision

(

Revision

$revision

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 109 of file AbstractStorableResource.php.

                                                       : void
    {
        $this->revisions->replaceSingleRevision($revision);
    }

setRevisions()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::setRevisions

(

RevisionCollection

$collection

)

Implements ILIAS\ResourceStorage\Resource\StorableResource.

Definition at line 114 of file AbstractStorableResource.php.

                                                                : void
    {
        $this->revisions = $collection;
    }

setStakeholders()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::setStakeholders

(

array

$stakeholders

)

Parameters

ResourceStakeholder[]

$stakeholders

Definition at line 144 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Resource\AbstractStorableResource\$stakeholders.

                                                        : self
    {
        $this->stakeholders = $stakeholders;

        return $this;
    }

setStorageId()

ILIAS\ResourceStorage\Resource\AbstractStorableResource::setStorageId

(

string

$storage_id

)

Definition at line 156 of file AbstractStorableResource.php.

References ILIAS\ResourceStorage\Resource\AbstractStorableResource\$storage_id.

                                                    : void
    {
        $this->storage_id = $storage_id;
    }

Field Documentation

$revisions

RevisionCollection ILIAS\ResourceStorage\Resource\AbstractStorableResource::$revisions

protected

Definition at line 33 of file AbstractStorableResource.php.

$stakeholders

array ILIAS\ResourceStorage\Resource\AbstractStorableResource::$stakeholders = []

protected

Definition at line 37 of file AbstractStorableResource.php.

Referenced by ILIAS\ResourceStorage\Resource\AbstractStorableResource\getStakeholders(), and ILIAS\ResourceStorage\Resource\AbstractStorableResource\setStakeholders().

$storage_id

string ILIAS\ResourceStorage\Resource\AbstractStorableResource::$storage_id = ''

protected

Definition at line 38 of file AbstractStorableResource.php.

Referenced by ILIAS\ResourceStorage\Resource\AbstractStorableResource\getStorageId(), and ILIAS\ResourceStorage\Resource\AbstractStorableResource\setStorageId().

---

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

• components/ILIAS/ResourceStorage/src/Resource/AbstractStorableResource.php