ILIAS\ResourceStorage\Consumer\ConsumerFactory Class Reference

Class ConsumerFactory. More...

Collaboration diagram for ILIAS\ResourceStorage\Consumer\ConsumerFactory:

Public Member Functions
	__construct (private StreamAccess $stream_access, protected FileNamePolicy $file_name_policy=new NoneFileNamePolicy())
	ConsumerFactory constructor. More...
	download (StorableResource $resource)
	inline (StorableResource $resource)
	fileStream (StorableResource $resource)
	absolutePath (StorableResource $resource)
	src (StorableResource $resource, SrcBuilder $src_builder)
	flavourUrl (Flavour $flavour, SrcBuilder $src_builder)
	downloadMultiple (array $resources, ?string $zip_filename=null)
	containerZIP (StorableContainerResource $resource,)
	containerURI (StorableContainerResource $resource, SrcBuilder $src_builder, string $start_file='index.html', float $valid_for_at_least_minutes=120.0)

Private Attributes
Services	$http
	@readonly More...

Detailed Description

Class ConsumerFactory.

Author

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

Definition at line 35 of file ConsumerFactory.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::__construct	(	private StreamAccess	$stream_access,
		protected FileNamePolicy	$file_name_policy = new NoneFileNamePolicy()
	)

ConsumerFactory constructor.

Parameters

FileNamePolicy | null

$file_name_policy

Definition at line 46 of file ConsumerFactory.php.

      {
        global $DIC;
        $this->http = $DIC->http();
    }

References $DIC, and ILIAS\FileDelivery\http().

Here is the call graph for this function:

Member Function Documentation

absolutePath()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::absolutePath

(

StorableResource

$resource

)

Deprecated:

Definition at line 85 of file ConsumerFactory.php.

                                                            : AbsolutePathConsumer
    {
        return new AbsolutePathConsumer(
            $resource,
            $this->stream_access,
            $this->file_name_policy
        );
    }

containerURI()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::containerURI	(	StorableContainerResource	$resource,
		SrcBuilder	$src_builder,
		string	$start_file = 'index.html',
		float	$valid_for_at_least_minutes = 120.0
	)

Definition at line 132 of file ConsumerFactory.php.

     : ContainerConsumer {
        return new ContainerURIConsumer(
            $src_builder,
            $resource,
            $this->stream_access,
            $start_file,
            $valid_for_at_least_minutes
        );
    }

containerZIP()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::containerZIP

(

StorableContainerResource

$resource

)

Definition at line 123 of file ConsumerFactory.php.

     : ContainerConsumer {
        return new ContainerZIPAccessConsumer(
            $resource,
            $this->stream_access
        );
    }

download()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::download

(

StorableResource

$resource

)

Definition at line 54 of file ConsumerFactory.php.

                                                        : DownloadConsumer
    {
        return new DownloadConsumer(
            $this->http,
            $resource,
            $this->stream_access,
            $this->file_name_policy
        );
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

downloadMultiple()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::downloadMultiple	(	array	$resources,
		?string	$zip_filename = null
	)

Definition at line 111 of file ConsumerFactory.php.

     : DownloadMultipleConsumer {
        return new DownloadMultipleConsumer(
            $resources,
            $this->stream_access,
            $this->file_name_policy,
            $zip_filename ?? 'Download.zip'
        );
    }

fileStream()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::fileStream

(

StorableResource

$resource

)

Definition at line 74 of file ConsumerFactory.php.

                                                          : FileStreamConsumer
    {
        return new FileStreamConsumer(
            $resource,
            $this->stream_access
        );
    }

flavourUrl()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::flavourUrl	(	Flavour	$flavour,
		SrcBuilder	$src_builder
	)

Definition at line 103 of file ConsumerFactory.php.

                                                                         : FlavourURLs
    {
        return new FlavourURLs(
            $src_builder,
            $flavour
        );
    }

inline()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::inline

(

StorableResource

$resource

)

Definition at line 64 of file ConsumerFactory.php.

                                                      : InlineConsumer
    {
        return new InlineConsumer(
            $this->http,
            $resource,
            $this->stream_access,
            $this->file_name_policy
        );
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

src()

ILIAS\ResourceStorage\Consumer\ConsumerFactory::src	(	StorableResource	$resource,
		SrcBuilder	$src_builder
	)

Definition at line 94 of file ConsumerFactory.php.

                                                                            : SrcConsumer
    {
        return new SrcConsumer(
            $src_builder,
            $resource,
            $this->stream_access
        );
    }

Field Documentation

$http

Services ILIAS\ResourceStorage\Consumer\ConsumerFactory::$http

private

@readonly

Definition at line 40 of file ConsumerFactory.php.

---

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

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