ILIAS\WebDAV\Objects\IRSSStreamHandler Class Reference

Inheritance diagram for ILIAS\WebDAV\Objects\IRSSStreamHandler:

Collaboration diagram for ILIAS\WebDAV\Objects\IRSSStreamHandler:

Public Member Functions
	__construct (private ?ResourceIdentification $resource_identification)
	get ()
	put (string $title, mixed $data, bool $publish)
	publish ()
	get ()
	publish ()
	put (string $title, mixed $data, bool $publish)

Private Attributes
Manager	$manager
Consumers	$consumer
ilObjFileStakeholder	$stakeholder

Detailed Description

Author

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

Definition at line 34 of file IRSSStreamHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WebDAV\Objects\IRSSStreamHandler::__construct

(

private ?ResourceIdentification

$resource_identification

)

Definition at line 42 of file IRSSStreamHandler.php.

      {
        global $DIC; // TODO remove Service Locator
        $this->manager = $DIC->resourceStorage()->manage();
        $this->consumer = $DIC->resourceStorage()->consume();
        $this->stakeholder = new \ilObjFileStakeholder();
    }

References $DIC.

Member Function Documentation

get()

ILIAS\WebDAV\Objects\IRSSStreamHandler::get

(

)

Implements ILIAS\WebDAV\Objects\StreamHandler.

Definition at line 51 of file IRSSStreamHandler.php.

                         : ?FileStream
    {
        if ($this->resource_identification === null) {
            return null;
        }
        try {
            return $this->consumer->stream($this->resource_identification)->getStream();
        } catch (\Throwable) {
            return null;
        }
    }

publish()

ILIAS\WebDAV\Objects\IRSSStreamHandler::publish

(

)

Implements ILIAS\WebDAV\Objects\StreamHandler.

Definition at line 109 of file IRSSStreamHandler.php.

                             : void
    {
        if ($this->manager->getCurrentRevisionIncludingDraft(
            $this->resource_identification
        )->getStatus() === RevisionStatus::DRAFT
        ) {
            $this->manager->publish($this->resource_identification);
        }
    }

References ILIAS\ResourceStorage\Revision\DRAFT.

put()

ILIAS\WebDAV\Objects\IRSSStreamHandler::put	(	string	$title,
		mixed	$data,
		bool	$publish
	)

Implements ILIAS\WebDAV\Objects\StreamHandler.

Definition at line 63 of file IRSSStreamHandler.php.

                                                                  : bool
    {
        if (is_resource($data)) {
            $stream = Streams::ofResource($data);
        } elseif (is_string($data) && $data !== '') {
            $stream = Streams::ofString($data);
        } else {
            return false;
        }
 
        // Detect the empty `_Empty` placeholder revision created in
        // TreeProxyRepository::createObject(). If the resource currently holds
        // only that single DRAFT placeholder, remove it after the real
        // revision has been published so the file does not appear with two
        // versions (one empty, one with content).
        $placeholder_revision_number = null;
        $resource = $this->manager->getResource($this->resource_identification);
        if (count($resource->getAllRevisionsIncludingDraft()) === 1) {
            $only = $resource->getCurrentRevisionIncludingDraft();
            if ($only->getStatus() === RevisionStatus::DRAFT) {
                $placeholder_revision_number = $only->getVersionNumber();
            }
        }
 
        $this->manager->appendNewRevisionFromStream(
            $this->resource_identification,
            $stream,
            $this->stakeholder,
            $title,
            true
        );
 
        if ($publish) {
            $this->manager->publish($this->resource_identification);
        }
 
        if ($placeholder_revision_number !== null && $publish) {
            $this->manager->removeRevision(
                $this->resource_identification,
                $placeholder_revision_number
            );
        }
 
        return true;
    }

References $data, ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\Filesystem\Stream\Streams\ofResource(), and ILIAS\Filesystem\Stream\Streams\ofString().

Here is the call graph for this function:

Field Documentation

$consumer

Consumers ILIAS\WebDAV\Objects\IRSSStreamHandler::$consumer

private

Definition at line 39 of file IRSSStreamHandler.php.

$manager

Manager ILIAS\WebDAV\Objects\IRSSStreamHandler::$manager

private

Definition at line 38 of file IRSSStreamHandler.php.

$stakeholder

ilObjFileStakeholder ILIAS\WebDAV\Objects\IRSSStreamHandler::$stakeholder

private

Definition at line 40 of file IRSSStreamHandler.php.

---

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

• components/ILIAS/WebDAV/src/Objects/IRSSStreamHandler.php