ILIAS\ResourceStorage\Consumer\BaseConsumer Class Reference

Inheritance diagram for ILIAS\ResourceStorage\Consumer\BaseConsumer:

Collaboration diagram for ILIAS\ResourceStorage\Consumer\BaseConsumer:

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

Protected Attributes
	$storage_handler
	$resource
	$revision_number = null
	$file_name_policy
	$file_name = ''

Detailed Description

Definition at line 13 of file BaseConsumer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Consumer\BaseConsumer::__construct	(	StorableResource	$resource,
		StorageHandler	$storage_handler,
		FileNamePolicy	$file_name_policy
	)

DownloadConsumer constructor.

Parameters

StorableResource	$resource
StorageHandler	$storage_handler
FileNamePolicy	$file_name_policy

Definition at line 44 of file BaseConsumer.php.

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

References ILIAS\ResourceStorage\Consumer\BaseConsumer\$file_name_policy, ILIAS\ResourceStorage\Consumer\BaseConsumer\$resource, and ILIAS\ResourceStorage\Consumer\BaseConsumer\$storage_handler.

Member Function Documentation

overrideFileName()

ILIAS\ResourceStorage\Consumer\BaseConsumer::overrideFileName

(

string

$file_name

)

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 67 of file BaseConsumer.php.

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

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

run()

ILIAS\ResourceStorage\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\ResourceStorage\Consumer\DeliveryConsumer.

Reimplemented in ILIAS\ResourceStorage\Consumer\AbsolutePathConsumer, ILIAS\ResourceStorage\Consumer\DownloadConsumer, and ILIAS\ResourceStorage\Consumer\InlineConsumer.

setRevisionNumber()

ILIAS\ResourceStorage\Consumer\BaseConsumer::setRevisionNumber

(

int

$revision_number

)

@inheritDoc

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 61 of file BaseConsumer.php.

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

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

Field Documentation

$file_name

ILIAS\ResourceStorage\Consumer\BaseConsumer::$file_name = ''

protected

Definition at line 36 of file BaseConsumer.php.

Referenced by ILIAS\ResourceStorage\Consumer\BaseConsumer\overrideFileName(), ILIAS\ResourceStorage\Consumer\DownloadConsumer\run(), and ILIAS\ResourceStorage\Consumer\InlineConsumer\run().

$file_name_policy

ILIAS\ResourceStorage\Consumer\BaseConsumer::$file_name_policy

protected

Definition at line 32 of file BaseConsumer.php.

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

$resource

ILIAS\ResourceStorage\Consumer\BaseConsumer::$resource

protected

Definition at line 24 of file BaseConsumer.php.

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

$revision_number

ILIAS\ResourceStorage\Consumer\BaseConsumer::$revision_number = null

protected

Definition at line 28 of file BaseConsumer.php.

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

$storage_handler

ILIAS\ResourceStorage\Consumer\BaseConsumer::$storage_handler

protected

Definition at line 20 of file BaseConsumer.php.

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

---

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

• src/ResourceStorage/Consumer/BaseConsumer.php