ILIAS\ResourceStorage\Flavour\Flavours Class Reference

Collaboration diagram for ILIAS\ResourceStorage\Flavour\Flavours:

Public Member Functions
	__construct (protected FlavourBuilder $flavour_builder, protected ResourceBuilder $resource_builder)
	get (ResourceIdentification $rid, FlavourDefinition $flavour_definition)
	@description Use get() to get a Flavour for the FlavourDefinition for a ResourceIdentification. More...
	ensure (ResourceIdentification $rid, FlavourDefinition $flavour_definition)
	@description Actually like get(), but without return and can be used to create Flavour before you want to get them. More...
	has (ResourceIdentification $rid, FlavourDefinition $flavour_definition)
	@description This can be used to ask whether a Flavor already exists for the FlavourDefinition for a certain IRSS ResourceIdentification. More...
	remove (ResourceIdentification $rid, FlavourDefinition $flavour_definition)
	@description You don't need a flavor anymore or you want to delete it because you explicitly want to regenerate it? Use delete for this More...
	possible (ResourceIdentification $rid, FlavourDefinition $flavour_definition)
	@description Hereby you can check in advance, if there is a Machine and an Engine for your FlavourDefinition, which can generate the Flavour you want. More...

Detailed Description

Author

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

Definition at line 30 of file Flavours.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Flavour\Flavours::__construct	(	protected FlavourBuilder	$flavour_builder,
		protected ResourceBuilder	$resource_builder
	)

Definition at line 32 of file Flavours.php.

    {
    }

Referenced by ILIAS\ResourceStorage\Flavours\FlavourMachineTest\createSVGColorChangeDefinition().

Here is the caller graph for this function:

Member Function Documentation

ensure()

ILIAS\ResourceStorage\Flavour\Flavours::ensure	(	ResourceIdentification	$rid,
		FlavourDefinition	$flavour_definition
	)

@description Actually like get(), but without return and can be used to create Flavour before you want to get them.

Definition at line 53 of file Flavours.php.

                                                                                              : void
    {
        if ($this->flavour_builder->has($rid, $flavour_definition)) {
            return;
        }
        $this->flavour_builder->get($rid, $flavour_definition, true);
    }

get()

ILIAS\ResourceStorage\Flavour\Flavours::get	(	ResourceIdentification	$rid,
		FlavourDefinition	$flavour_definition
	)

@description Use get() to get a Flavour for the FlavourDefinition for a ResourceIdentification.

If the Flavour already exists you will get it, if not it will be created and returned directly.

Take into account that a Flavour can come back without Tokens for accessing the streams of the Flavour, namely if the Flavour does not contain any Streams. You will usually use the flavor with the Consumers of the IRSS anyway, so you don't have to worry about that.

Definition at line 45 of file Flavours.php.

                                                                                           : Flavour
    {
        return $this->flavour_builder->get($rid, $flavour_definition, false);
    }

has()

ILIAS\ResourceStorage\Flavour\Flavours::has	(	ResourceIdentification	$rid,
		FlavourDefinition	$flavour_definition
	)

@description This can be used to ask whether a Flavor already exists for the FlavourDefinition for a certain IRSS ResourceIdentification.

Definition at line 65 of file Flavours.php.

                                                                                           : bool
    {
        return $this->flavour_builder->has($rid, $flavour_definition);
    }

Referenced by ILIAS\ResourceStorage\Flavour\Flavours\remove().

Here is the caller graph for this function:

possible()

ILIAS\ResourceStorage\Flavour\Flavours::possible	(	ResourceIdentification	$rid,
		FlavourDefinition	$flavour_definition
	)

@description Hereby you can check in advance, if there is a Machine and an Engine for your FlavourDefinition, which can generate the Flavour you want.

Definition at line 87 of file Flavours.php.

                                                                                                : bool
    {
        return $this->flavour_builder->testDefinition($rid, $flavour_definition);
    }

remove()

ILIAS\ResourceStorage\Flavour\Flavours::remove	(	ResourceIdentification	$rid,
		FlavourDefinition	$flavour_definition
	)

@description You don't need a flavor anymore or you want to delete it because you explicitly want to regenerate it? Use delete for this

Definition at line 75 of file Flavours.php.

                                                                                              : void
    {
        if ($this->has($rid, $flavour_definition)) {
            $this->flavour_builder->delete($rid, $flavour_definition);
        }
    }

References ILIAS\ResourceStorage\Flavour\Flavours\has().

Here is the call graph for this function:

---

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

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