ILIAS  trunk Revision v11.0_alpha-1831-g8615d53dadb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer Class Reference
+ Inheritance diagram for ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer:
+ Collaboration diagram for ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer:

Public Member Functions

 getAbsolutePath ()
 
 run ()
 This runs the actual DeliveryConsumer. More...
 
- Public Member Functions inherited from ILIAS\LegalDocuments\Consumer\BaseConsumer
 __construct (protected StorableResource $resource, protected StreamAccess $stream_access, protected FileNamePolicy $file_name_policy)
 DownloadConsumer constructor. More...
 
 run ()
 This runs the actual DeliveryConsumer. More...
 
 setRevisionNumber (int $revision_number)
 
 overrideFileName (string $file_name)
 

Protected Attributes

string $absolute_path = ''
 
- Protected Attributes inherited from ILIAS\LegalDocuments\Consumer\BaseConsumer
int $revision_number = null
 
string $file_name = ''
 

Detailed Description

Definition at line 27 of file AbsolutePathConsumer.php.

Member Function Documentation

◆ getAbsolutePath()

ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer::getAbsolutePath ( )

Definition at line 31 of file AbsolutePathConsumer.php.

References ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer\$absolute_path, and ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer\run().

31  : string
32  {
33  $this->run();
34  return $this->absolute_path;
35  }
run()
This runs the actual DeliveryConsumer.
+ Here is the call graph for this function:

◆ run()

ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer::run ( )

This runs the actual DeliveryConsumer.

E.g. a DownloadConsumer will pass the Stream of a Ressource to the HTTP-Service and download the file.

Implements ILIAS\LegalDocuments\Consumer\DeliveryConsumer.

Definition at line 37 of file AbsolutePathConsumer.php.

Referenced by ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer\getAbsolutePath().

37  : void
38  {
39  $revision = $this->stream_access->populateRevision($this->getRevision());
40 
41  $stream = $revision->maybeStreamResolver()?->getStream();
42 
43  $this->absolute_path = (string)($stream->getMetadata('uri') ?? '');
44  }
+ Here is the caller graph for this function:

Field Documentation

◆ $absolute_path

string ILIAS\LegalDocuments\Consumer\AbsolutePathConsumer::$absolute_path = ''
protected

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