ILIAS\FileDelivery Class Reference

Inheritance diagram for ILIAS\FileDelivery:

Collaboration diagram for ILIAS\FileDelivery:

Public Member Functions
	init (array|\ArrayAccess &$define, array|\ArrayAccess &$implement, array|\ArrayAccess &$use, array|\ArrayAccess &$contribute, array|\ArrayAccess &$seek, array|\ArrayAccess &$provide, array|\ArrayAccess &$pull, array|\ArrayAccess &$internal,)
	init (array|\ArrayAccess &$define, array|\ArrayAccess &$implement, array|\ArrayAccess &$use, array|\ArrayAccess &$contribute, array|\ArrayAccess &$seek, array|\ArrayAccess &$provide, array|\ArrayAccess &$pull, array|\ArrayAccess &$internal,)
	init (array|\ArrayAccess &$define, array|\ArrayAccess &$implement, array|\ArrayAccess &$use, array|\ArrayAccess &$contribute, array|\ArrayAccess &$seek, array|\ArrayAccess &$provide, array|\ArrayAccess &$pull, array|\ArrayAccess &$internal,)

Data Fields
trait	HttpServiceAware
	Trait HttpServiceAware. More...

Detailed Description

Definition at line 45 of file FileDelivery.php.

Member Function Documentation

init()

ILIAS\FileDelivery::init	(	array|\ArrayAccess &	$define,
		array|\ArrayAccess &	$implement,
		array|\ArrayAccess &	$use,
		array|\ArrayAccess &	$contribute,
		array|\ArrayAccess &	$seek,
		array|\ArrayAccess &	$provide,
		array|\ArrayAccess &	$pull,
		array|\ArrayAccess &	$internal
	)

Every activity that delivers a file builds its result with this, so all of them look alike to their consumers - see the activities of the ResourceStorage.

Reimplemented from ILIAS\Component.

Definition at line 47 of file FileDelivery.php.

     : void {
        $define[] = DataSigning::class;
        $define[] = FileDeliveryServices::class;
 
        $contribute[Agent::class] = static fn() => new \ILIAS\FileDelivery\Setup\Agent(
            $pull[Factory::class]
        );
 
        $contribute[PublicAsset::class] = fn() => new Endpoint($this, "deliver.php");
 
        // INITIALIZATION OF SERVICES
        // The delivery method is baked into an artefact at setup time, so the
        // builder is picked without a DB or ini read.
        $internal[ResponseBuilder::class] = static fn() => ResponseBuilderFactory::fromArtefact();
 
        // Both the content domain and the ILIAS domain (derived from http_path)
        // are baked into the artefact at setup time, so no ini read is needed.
        $internal[IsolationConfig::class] = static fn() => IsolationConfig::fromArtefact();
 
        $internal[PHPResponseBuilder::class] = (static fn() => new PHPResponseBuilder());
 
        $internal[DataSigning::class] = static fn() => new DataSigner(
            SecretKeyRotation::fromArtefact(KeyRotationObjective::PATH())
        );
 
        $implement[DataSigning::class] = static fn() => $internal[DataSigning::class];
 
        $internal[StreamDelivery::class] = (static fn() => new StreamDelivery(
            $use[DataSigning::class],
            $use[GlobalHttpState::class],
            $internal[ResponseBuilder::class],
            $internal[PHPResponseBuilder::class],
            $internal[IsolationConfig::class],
        ));
 
        $internal[LegacyDelivery::class] = (static fn() => new LegacyDelivery(
            $use[GlobalHttpState::class],
            $internal[ResponseBuilder::class],
            $internal[PHPResponseBuilder::class],
            $internal[IsolationConfig::class],
        ));
 
        $internal[FileDeliveryServices::class] = (static fn() => new Services(
            $internal[StreamDelivery::class],
            $internal[LegacyDelivery::class],
            $use[DataSigning::class],
            $use[GlobalHttpState::class],
            $internal[IsolationConfig::class],
            $use[HttpPathProvider::class],
        ));
 
        $implement[FileDeliveryServices::class] = static fn() => $internal[FileDeliveryServices::class];
 
        $contribute[EntryPoint::class] = static fn() => new \ILIAS\FileDelivery\EntryPoint(
            $internal[FileDeliveryServices::class],
            $use[GlobalHttpState::class],
        );
 
        $internal[FilePayloadFactory::class] = static fn() => new FilePayloadFactory();
        $provide[FilePayloadFactory::class] = static fn() => $internal[FilePayloadFactory::class];
    }

Field Documentation

HttpServiceAware

trait ILIAS\FileDelivery::HttpServiceAware

Initial value:

{
    
    private static $http

Trait HttpServiceAware.

This trait provide a convenient way to consume the global http state and aids to reduce code duplication.

Please only use this trait if you need the global http state from a static context! Otherwise consider to pass the http global state via constructor (DI).

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0

Since

5.3

@Internal

Definition at line 38 of file HttpServiceAware.php.

---

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

• components/ILIAS/FileDelivery/FileDelivery.php
• components/ILIAS/FileDelivery/classes/HttpServiceAware.php