ILIAS\LegalDocuments\Consumer\BaseConsumer Class Reference

Inheritance diagram for ILIAS\LegalDocuments\Consumer\BaseConsumer:

Collaboration diagram for ILIAS\LegalDocuments\Consumer\BaseConsumer:

Public Member Functions
	__construct (StorableResource $resource, StreamAccess $stream_access, FileNamePolicy $file_name_policy)
	DownloadConsumer constructor. More...
	run ()
	This runs the actual DeliveryConsumer. More...
	setRevisionNumber (int $revision_number)
	overrideFileName (string $file_name)

Protected Attributes
int	$revision_number = null
string	$file_name = ''
StorableResource	$resource
StreamAccess	$stream_access
FileNamePolicy	$file_name_policy

Detailed Description

Definition at line 31 of file BaseConsumer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\Consumer\BaseConsumer::__construct	(	StorableResource	$resource,
		StreamAccess	$stream_access,
		FileNamePolicy	$file_name_policy
	)

DownloadConsumer constructor.

Definition at line 44 of file BaseConsumer.php.

References ILIAS\LegalDocuments\Consumer\BaseConsumer\$file_name_policy, ILIAS\LegalDocuments\Consumer\BaseConsumer\$resource, ILIAS\LegalDocuments\Consumer\BaseConsumer\$stream_access, and ILIAS\LegalDocuments\Consumer\BaseConsumer\run().

      {
        $this->resource = $resource;
        $this->stream_access = $stream_access;
        $this->file_name_policy = $file_name_policy;
        $this->file_name = $resource->getCurrentRevision()->getInformation()->getTitle();
    }

Here is the call graph for this function:

Member Function Documentation

overrideFileName()

ILIAS\LegalDocuments\Consumer\BaseConsumer::overrideFileName

(

string

$file_name

)

Implements ILIAS\LegalDocuments\Consumer\DeliveryConsumer.

Definition at line 66 of file BaseConsumer.php.

References ILIAS\LegalDocuments\Consumer\BaseConsumer\$file_name.

                                                       : DeliveryConsumer
    {
        $this->file_name = $file_name;
        return $this;
    }

run()

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

abstract

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.

Referenced by ILIAS\LegalDocuments\Consumer\BaseConsumer\__construct().

Here is the caller graph for this function:

setRevisionNumber()

ILIAS\LegalDocuments\Consumer\BaseConsumer::setRevisionNumber

(

int

$revision_number

)

Implements ILIAS\LegalDocuments\Consumer\DeliveryConsumer.

Definition at line 60 of file BaseConsumer.php.

References ILIAS\LegalDocuments\Consumer\BaseConsumer\$revision_number.

                                                           : DeliveryConsumer
    {
        $this->revision_number = $revision_number;
        return $this;
    }

Field Documentation

$file_name

string ILIAS\LegalDocuments\Consumer\BaseConsumer::$file_name = ''

protected

Definition at line 36 of file BaseConsumer.php.

Referenced by ILIAS\LegalDocuments\Consumer\BaseConsumer\overrideFileName().

$file_name_policy

FileNamePolicy ILIAS\LegalDocuments\Consumer\BaseConsumer::$file_name_policy

protected

Definition at line 39 of file BaseConsumer.php.

Referenced by ILIAS\LegalDocuments\Consumer\BaseConsumer\__construct().

$resource

StorableResource ILIAS\LegalDocuments\Consumer\BaseConsumer::$resource

protected

Definition at line 37 of file BaseConsumer.php.

Referenced by ILIAS\LegalDocuments\Consumer\BaseConsumer\__construct().

$revision_number

int ILIAS\LegalDocuments\Consumer\BaseConsumer::$revision_number = null

protected

Definition at line 35 of file BaseConsumer.php.

Referenced by ILIAS\LegalDocuments\Consumer\BaseConsumer\setRevisionNumber().

$stream_access

StreamAccess ILIAS\LegalDocuments\Consumer\BaseConsumer::$stream_access

protected

Definition at line 38 of file BaseConsumer.php.

Referenced by ILIAS\LegalDocuments\Consumer\BaseConsumer\__construct().

---

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

• components/ILIAS/ResourceStorage/src/Consumer/BaseConsumer.php