ILIAS\ResourceStorage\Flavour\FlavourBuilder Class Reference

Collaboration diagram for ILIAS\ResourceStorage\Flavour\FlavourBuilder:

Public Member Functions
	__construct (private readonly FlavourRepository $flavour_resource_repository, private readonly Factory $flavour_machine_factory, private readonly ResourceBuilder $resource_builder, private readonly StorageHandlerFactory $storage_handler_factory, private readonly StreamAccess $stream_access, private readonly Subject $events)
	has (ResourceIdentification $identification, FlavourDefinition $definition)
	get (ResourceIdentification $rid, FlavourDefinition $definition, bool $force_building=false)
	delete (ResourceIdentification $rid, FlavourDefinition $definition)
	testDefinition (ResourceIdentification $rid, FlavourDefinition $definition)

Data Fields
const	VARIANT_NAME_MAX_LENGTH = 768

Protected Member Functions
	runMachine (ResourceIdentification $rid, FlavourDefinition $definition, Flavour $flavour)

Private Member Functions
	build (ResourceIdentification $rid, FlavourDefinition $definition)
	read (ResourceIdentification $rid, FlavourDefinition $definition, bool $force_building=false)
	new (FlavourDefinition $definition, ResourceIdentification $rid)
	hasFlavourStreams (Flavour $flavour)
	storeFlavourStreams (Flavour $flavour, array $streams)
	populateFlavourWithExistingStreams (Flavour $flavour)
	checkDefinitionForMachine (FlavourDefinition $definition, FlavourMachine $machine)
	checkDefinition (FlavourDefinition $definition)
	getCurrentRevision (Flavour $flavour)
	getResource (ResourceIdentification $rid)
	getResourceOfFlavour (Flavour $flavour)
	getStorageHandler (Flavour $flavour)

Private Attributes
array	$current_revision_cache = []
array	$resources_cache = []

Detailed Description

Author

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

Definition at line 45 of file FlavourBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::__construct	(	private readonly FlavourRepository	$flavour_resource_repository,
		private readonly Factory	$flavour_machine_factory,
		private readonly ResourceBuilder	$resource_builder,
		private readonly StorageHandlerFactory	$storage_handler_factory,
		private readonly StreamAccess	$stream_access,
		private readonly Subject	$events
	)

Definition at line 51 of file FlavourBuilder.php.

      {
    }

Member Function Documentation

build()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::build ( ResourceIdentification  $rid, FlavourDefinition  $definition  )

private

Definition at line 92 of file FlavourBuilder.php.

     : Flavour {
        $flavour = $this->new($definition, $rid);
        $flavour = $this->runMachine($rid, $definition, $flavour);
 
        if ($definition->persist()) {
            $this->flavour_resource_repository->store($flavour);
            $flavour = $this->populateFlavourWithExistingStreams($flavour);
        }
 
        return $flavour;
    }

checkDefinition()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::checkDefinition ( FlavourDefinition  $definition )

private

Definition at line 203 of file FlavourBuilder.php.

                                                                   : void
    {
        if ($definition->getVariantName() === null) {
            return;
        }
        if (strlen($definition->getVariantName()) > self::VARIANT_NAME_MAX_LENGTH) {
            throw new \InvalidArgumentException("FlavourDefinition variant name too long");
        }
    }

References ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition\getVariantName().

Here is the call graph for this function:

checkDefinitionForMachine()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::checkDefinitionForMachine ( FlavourDefinition  $definition, FlavourMachine  $machine  )

private

Definition at line 196 of file FlavourBuilder.php.

                                                                                                      : void
    {
        if (!$machine->canHandleDefinition($definition)) {
            throw new \InvalidArgumentException("FlavourDefinition not supported by machine");
        }
    }

References ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine\canHandleDefinition().

Here is the call graph for this function:

delete()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::delete	(	ResourceIdentification	$rid,
		FlavourDefinition	$definition
	)

Definition at line 139 of file FlavourBuilder.php.

     : bool {
        $current_revision = $this->getResource($rid)->getCurrentRevision();
        $revision_number = $current_revision->getVersionNumber();
 
        if ($this->flavour_resource_repository->has($rid, $revision_number, $definition)) {
            $flavour = $this->flavour_resource_repository->get($rid, $revision_number, $definition);
            $this->flavour_resource_repository->delete($flavour);
            $storage = $this->getStorageHandler($flavour);
            $storage->deleteFlavour($current_revision, $flavour);
 
            return true;
        }
 
        return false;
    }

get()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::get	(	ResourceIdentification	$rid,
		FlavourDefinition	$definition,
		bool	$force_building = false
	)

Exceptions

ResourceNotFoundException

Definition at line 76 of file FlavourBuilder.php.

     : Flavour {
        $this->checkDefinition($definition);
        if (!$this->resource_builder->has($rid)) {
            throw new ResourceNotFoundException($rid->serialize());
        }
        if ($this->has($rid, $definition)) {
            return $this->read($rid, $definition, $force_building);
        }
 
        return $this->build($rid, $definition);
    }

References ILIAS\GlobalScreen\has(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

getCurrentRevision()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::getCurrentRevision ( Flavour  $flavour )

private

Definition at line 306 of file FlavourBuilder.php.

                                                         : Revision
    {
        $rid = $flavour->getResourceId()->serialize();
        if (isset($this->current_revision_cache[$rid])) {
            // return $this->current_revision_cache[$rid]; // we are currently not able to cache this seriously,
            // since there might be situations where the revision changes in the meantime
        }
        return $this->current_revision_cache[$rid] = $this->getResourceOfFlavour($flavour)->getCurrentRevision();
    }

References ILIAS\ResourceStorage\Flavour\Flavour\getResourceId().

Here is the call graph for this function:

getResource()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::getResource ( ResourceIdentification  $rid )

private

Definition at line 316 of file FlavourBuilder.php.

                                                             : StorableResource
    {
        $rid_string = $rid->serialize();
        return $this->resources_cache[$rid_string] ?? ($this->resources_cache[$rid_string] = $this->resource_builder->get(
            $rid
        ));
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

getResourceOfFlavour()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::getResourceOfFlavour ( Flavour  $flavour )

private

Definition at line 324 of file FlavourBuilder.php.

                                                           : StorableResource
    {
        return $this->getResource($flavour->getResourceID());
    }

getStorageHandler()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::getStorageHandler ( Flavour  $flavour )

private

Definition at line 329 of file FlavourBuilder.php.

                                                        : StorageHandler
    {
        return $this->storage_handler_factory->getHandlerForResource($this->getResourceOfFlavour($flavour));
    }

has()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::has	(	ResourceIdentification	$identification,
		FlavourDefinition	$definition
	)

Definition at line 61 of file FlavourBuilder.php.

     : bool {
        $this->checkDefinition($definition);
        return $this->flavour_resource_repository->has(
            $identification,
            $this->getResource($identification)->getCurrentRevision()->getVersionNumber(),
            $definition
        );
    }

hasFlavourStreams()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::hasFlavourStreams ( Flavour  $flavour )

private

Definition at line 160 of file FlavourBuilder.php.

                                                        : bool
    {
        return $this->getStorageHandler($flavour)->hasFlavour(
            $this->getCurrentRevision($flavour),
            $flavour
        );
    }

new()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::new ( FlavourDefinition  $definition, ResourceIdentification  $rid  )

private

Definition at line 130 of file FlavourBuilder.php.

                                                                                    : Flavour
    {
        return new Flavour(
            $definition,
            $rid,
            $this->getResource($rid)->getCurrentRevision()->getVersionNumber()
        );
    }

populateFlavourWithExistingStreams()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::populateFlavourWithExistingStreams ( Flavour  $flavour )

private

Definition at line 179 of file FlavourBuilder.php.

                                                                         : Flavour
    {
        $handler = $this->getStorageHandler($flavour);
        $identification = $flavour->getResourceId();
        $revision = $this->getCurrentRevision($flavour);
        foreach (
            $handler->getFlavourStreams(
                $revision,
                $flavour
            ) as $index => $file_stream
        ) {
            $flavour = $this->stream_access->populateFlavour($flavour, $file_stream, $index);
        }
        return $flavour;
    }

References $handler, and ILIAS\ResourceStorage\Flavour\Flavour\getResourceId().

Here is the call graph for this function:

read()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::read ( ResourceIdentification  $rid, FlavourDefinition  $definition, bool  $force_building = false  )

private

Definition at line 107 of file FlavourBuilder.php.

     : Flavour {
        $current_revision = $this->getResource($rid)->getCurrentRevision();
        $flavour = $this->flavour_resource_repository->get(
            $rid,
            $current_revision->getVersionNumber(),
            $definition
        );
 
        if ($force_building || !$this->hasFlavourStreams($flavour)) {
            // ensure deletion of old streams
            $storage = $this->getStorageHandler($flavour);
            $storage->deleteFlavour($current_revision, $flavour);
            // run Machine
            return $this->runMachine($rid, $definition, $flavour);
        }
 
        return $this->populateFlavourWithExistingStreams($flavour);
    }

runMachine()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::runMachine ( ResourceIdentification  $rid, FlavourDefinition  $definition, Flavour  $flavour  )

protected

Definition at line 242 of file FlavourBuilder.php.

     : Flavour {
        $revision = $this->getCurrentRevision($flavour);
 
        // Get Orignal Stream of Resource/Revision
        $handler = $this->getStorageHandler($flavour);
        try {
            $stream = $this->resource_builder->extractStream($revision);
            $stream->rewind();
        } catch (\Throwable) {
            // error while reading file stream, cannot process
            $this->events->notify(Event::FLAVOUR_BUILD_FAILED, new FlavourData($rid, $definition, $flavour, $t));
            return $flavour;
        }
 
        // Get Machine
        $machine = $this->flavour_machine_factory->get($definition);
        $this->checkDefinitionForMachine($definition, $machine);
 
        // Run Machine and get Streams
        $storable_streams = [];
        try {
            foreach (
                $machine->processStream(
                    $revision->getInformation(),
                    $stream,
                    $definition
                ) as $result
            ) {
                $generated_stream = $result->getStream();
                if ($result->isStoreable()) {
                    // Collect Streams to store persistently
                    $storable_streams[$result->getIndex()] = $generated_stream;
                }
 
                $cloned_stream = Streams::ofString((string) $generated_stream);
 
                $flavour = $this->stream_access->populateFlavour(
                    $flavour,
                    $cloned_stream,
                    $result->getIndex()
                );
            }
        } catch (\Throwable $t) {
            // error while processing stream, cannot process
            $this->events->notify(Event::FLAVOUR_BUILD_FAILED, new FlavourData($rid, $definition, $flavour, $t));
            return $flavour;
        }
 
        // Store Streams persistently if needed
        if ($definition->persist()) {
            $this->storeFlavourStreams($flavour, $storable_streams);
        }
 
        $this->events->notify(Event::FLAVOUR_BUILD_SUCCESS, new FlavourData($rid, $definition, $flavour));
 
        return $flavour;
    }

storeFlavourStreams()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::storeFlavourStreams ( Flavour  $flavour, array  $streams  )

private

Definition at line 168 of file FlavourBuilder.php.

                                                                          : void
    {
        $storable = new StorableFlavourDecorator($flavour);
        $storable->setStreams($streams);
 
        $this->getStorageHandler($flavour)->storeFlavour(
            $this->getCurrentRevision($flavour),
            $storable
        );
    }

testDefinition()

ILIAS\ResourceStorage\Flavour\FlavourBuilder::testDefinition	(	ResourceIdentification	$rid,
		FlavourDefinition	$definition
	)

Definition at line 213 of file FlavourBuilder.php.

     : bool {
        try {
            $this->checkDefinition($definition);
            $machine = $this->flavour_machine_factory->get($definition);
            $this->checkDefinitionForMachine($definition, $machine);
        } catch (\Throwable) {
            return false;
        }
        if ($machine instanceof NullMachine) {
            return false;
        }
        $engine = $machine->getEngine();
        if (!$engine->isRunning()) {
            return false;
        }
        $current_revision = $this->getResource($rid)->getCurrentRevision();
        $suffix = $current_revision->getInformation()->getSuffix();
        $size = $current_revision->getInformation()->getSize();
        if ($size > $engine->getSizeLimitInBytes()) {
            return false;
        }
 
        return $engine->supports($suffix);
    }

Field Documentation

$current_revision_cache

array ILIAS\ResourceStorage\Flavour\FlavourBuilder::$current_revision_cache = []

private

Definition at line 48 of file FlavourBuilder.php.

$resources_cache

array ILIAS\ResourceStorage\Flavour\FlavourBuilder::$resources_cache = []

private

Definition at line 49 of file FlavourBuilder.php.

VARIANT_NAME_MAX_LENGTH

const ILIAS\ResourceStorage\Flavour\FlavourBuilder::VARIANT_NAME_MAX_LENGTH = 768

Definition at line 47 of file FlavourBuilder.php.

---

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

• components/ILIAS/ResourceStorage/src/Flavour/FlavourBuilder.php