ILIAS\LegalDocuments\Consumer\Consumers Class Reference

Collaboration diagram for ILIAS\LegalDocuments\Consumer\Consumers:

Public Member Functions
	__construct (ConsumerFactory $consumer_factory, ResourceBuilder $resource_builder, CollectionBuilder $collection_builder, ?SrcBuilder $src_builder=null)
	Consumers constructor. More...
	download (ResourceIdentification $identification)
	inline (ResourceIdentification $identification)
	stream (ResourceIdentification $identification)
	src (ResourceIdentification $identification)
	downloadCollection (ResourceCollectionIdentification $identification, ?string $zip_filename=null)
	downloadResources (array $identifications, ?string $zip_filename=null)
	flavourUrls (Flavour $flavour)
	containerZIP (ResourceIdentification $identification)
	This consumer can be used to obtain a StorageContainerResource as a ZIP. More...
	containerURI (ResourceIdentification $identification, string $start_file='index.html', float $valid_for_at_least_minutes=60.0)

Private Attributes
ConsumerFactory	$consumer_factory
ResourceBuilder	$resource_builder
CollectionBuilder	$collection_builder
SrcBuilder	$src_builder

Detailed Description

Definition at line 36 of file Consumers.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\Consumer\Consumers::__construct	(	ConsumerFactory	$consumer_factory,
		ResourceBuilder	$resource_builder,
		CollectionBuilder	$collection_builder,
		?SrcBuilder	$src_builder = null
	)

Consumers constructor.

Definition at line 46 of file Consumers.php.

References ILIAS\LegalDocuments\Consumer\Consumers\$collection_builder, ILIAS\LegalDocuments\Consumer\Consumers\$consumer_factory, and ILIAS\LegalDocuments\Consumer\Consumers\$resource_builder.

      {
        $this->consumer_factory = $consumer_factory;
        $this->resource_builder = $resource_builder;
        $this->collection_builder = $collection_builder;
        $this->src_builder = $src_builder ?? new InlineSrcBuilder();
    }

Member Function Documentation

containerURI()

ILIAS\LegalDocuments\Consumer\Consumers::containerURI	(	ResourceIdentification	$identification,
		string	$start_file = 'index.html',
		float	$valid_for_at_least_minutes = 60.0
	)

Definition at line 126 of file Consumers.php.

References ILIAS\ResourceStorage\Resource\CONTAINER.

     : ContainerURIConsumer {
        $resource = $this->resource_builder->get($identification);
        if ($resource->getType() !== ResourceType::CONTAINER || !$resource instanceof StorableContainerResource) {
            throw new \InvalidArgumentException('Expected StorableContainerResource');
        }
        return $this->consumer_factory->containerURI(
            $resource,
            $this->src_builder,
            ltrim($start_file, '/'),
            $valid_for_at_least_minutes
        );
    }

containerZIP()

ILIAS\LegalDocuments\Consumer\Consumers::containerZIP

(

ResourceIdentification

$identification

)

This consumer can be used to obtain a StorageContainerResource as a ZIP.

Definition at line 114 of file Consumers.php.

References ILIAS\ResourceStorage\Resource\CONTAINER.

                                                                        : ContainerZIPAccessConsumer
    {
        $resource = $this->resource_builder->get($identification);
        if ($resource->getType() !== ResourceType::CONTAINER || !$resource instanceof StorableContainerResource) {
            throw new \InvalidArgumentException('Expected StorableContainerResource');
        }

        return $this->consumer_factory->containerZIP(
            $resource
        );
    }

download()

ILIAS\LegalDocuments\Consumer\Consumers::download

(

ResourceIdentification

$identification

)

Definition at line 58 of file Consumers.php.

                                                                    : DownloadConsumer
    {
        return $this->consumer_factory->download($this->resource_builder->get($identification));
    }

downloadCollection()

ILIAS\LegalDocuments\Consumer\Consumers::downloadCollection	(	ResourceCollectionIdentification	$identification,
		?string	$zip_filename = null
	)

Definition at line 78 of file Consumers.php.

References ILIAS\LegalDocuments\Consumer\Consumers\downloadResources().

     : DownloadMultipleConsumer {
        return $this->downloadResources(
            iterator_to_array($this->collection_builder->getResourceIds($identification)),
            $zip_filename
        );
    }

Here is the call graph for this function:

downloadResources()

ILIAS\LegalDocuments\Consumer\Consumers::downloadResources	(	array	$identifications,
		?string	$zip_filename = null
	)

Definition at line 88 of file Consumers.php.

References $resources.

Referenced by ILIAS\LegalDocuments\Consumer\Consumers\downloadCollection().

     : DownloadMultipleConsumer {
        $resources = [];
        foreach ($identifications as $rid) {
            if (!$rid instanceof ResourceIdentification) {
                throw new \InvalidArgumentException('Expected ResourceIdentification');
            }
            $resources[] = $this->resource_builder->get($rid);
        }

        return $this->consumer_factory->downloadMultiple(
            $resources,
            $zip_filename
        );
    }

Here is the caller graph for this function:

flavourUrls()

ILIAS\LegalDocuments\Consumer\Consumers::flavourUrls

(

Flavour

$flavour

)

Definition at line 106 of file Consumers.php.

                                                 : FlavourURLs
    {
        return $this->consumer_factory->flavourUrl($flavour, $this->src_builder);
    }

inline()

ILIAS\LegalDocuments\Consumer\Consumers::inline

(

ResourceIdentification

$identification

)

Definition at line 63 of file Consumers.php.

                                                                  : InlineConsumer
    {
        return $this->consumer_factory->inline($this->resource_builder->get($identification));
    }

src()

ILIAS\LegalDocuments\Consumer\Consumers::src

(

ResourceIdentification

$identification

)

Definition at line 73 of file Consumers.php.

References ILIAS\LegalDocuments\Consumer\Consumers\$src_builder.

                                                               : SrcConsumer
    {
        return $this->consumer_factory->src($this->resource_builder->get($identification), $this->src_builder);
    }

stream()

ILIAS\LegalDocuments\Consumer\Consumers::stream

(

ResourceIdentification

$identification

)

Definition at line 68 of file Consumers.php.

                                                                  : FileStreamConsumer
    {
        return $this->consumer_factory->fileStream($this->resource_builder->get($identification));
    }

Field Documentation

$collection_builder

CollectionBuilder ILIAS\LegalDocuments\Consumer\Consumers::$collection_builder

private

Definition at line 40 of file Consumers.php.

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

$consumer_factory

ConsumerFactory ILIAS\LegalDocuments\Consumer\Consumers::$consumer_factory

private

Definition at line 38 of file Consumers.php.

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

$resource_builder

ResourceBuilder ILIAS\LegalDocuments\Consumer\Consumers::$resource_builder

private

Definition at line 39 of file Consumers.php.

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

$src_builder

SrcBuilder ILIAS\LegalDocuments\Consumer\Consumers::$src_builder

private

Definition at line 41 of file Consumers.php.

Referenced by ILIAS\LegalDocuments\Consumer\Consumers\src().

---

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

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