ILIAS\ResourceStorage\Flavours\DummyDefinition Class Reference

Inheritance diagram for ILIAS\ResourceStorage\Flavours\DummyDefinition:

Collaboration diagram for ILIAS\ResourceStorage\Flavours\DummyDefinition:

Public Member Functions
	__construct (string $id, string $machine_id, bool $persists=false)
	getId ()
	getFlavourMachineId ()
	Defines the ID of the machine that supports this definition. More...
	getInternalName ()
	This defines the speaky internal name of the definition, as the consumer would like to use it, e.g. More...
	getVariantName ()
	If a definition can be used in several variants (e.g. More...
	persist ()
	Define whether the generated flavor and the respective streams should be persisted, or whether they should only be generated and used in-memory. More...

Private Attributes
string	$id
string	$machine_id
bool	$persists = false

Detailed Description

Definition at line 26 of file DummyDefinition.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ResourceStorage\Flavours\DummyDefinition::__construct	(	string	$id,
		string	$machine_id,
		bool	$persists = false
	)

Definition at line 32 of file DummyDefinition.php.

References ILIAS\ResourceStorage\Flavours\DummyDefinition\$id, ILIAS\ResourceStorage\Flavours\DummyDefinition\$machine_id, and ILIAS\ResourceStorage\Flavours\DummyDefinition\$persists.

    {
        $this->id = $id;
        $this->machine_id = $machine_id;
        $this->persists = $persists;
    }

Member Function Documentation

getFlavourMachineId()

ILIAS\ResourceStorage\Flavours\DummyDefinition::getFlavourMachineId

(

)

Defines the ID of the machine that supports this definition.

The machine MUST exist.

Implements ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition.

Definition at line 44 of file DummyDefinition.php.

References ILIAS\ResourceStorage\Flavours\DummyDefinition\$machine_id.

                                         : string
    {
        return $this->machine_id;
    }

getId()

ILIAS\ResourceStorage\Flavours\DummyDefinition::getId

(

)

Returns

string max. 64 characters, MUST be unique and NOT a class-related magic-constant. E.g. you can generate a random one with $ php -r"echo hash('sha256', uniqid());" | pbcopy in your shell and paste string in your getId() implementation.

If you ever change the ID, existing - maybe persisted - flavours created based on this definition will not be found anymore and have to be regenerated.

Implements ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition.

Definition at line 39 of file DummyDefinition.php.

References ILIAS\ResourceStorage\Flavours\DummyDefinition\$id.

                           : string
    {
        return $this->id;
    }

getInternalName()

ILIAS\ResourceStorage\Flavours\DummyDefinition::getInternalName

(

)

This defines the speaky internal name of the definition, as the consumer would like to use it, e.g.

to be able to distinguish between several flavors.

Implements ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition.

Definition at line 49 of file DummyDefinition.php.

                                     : string
    {
        return 'foo';
    }

getVariantName()

ILIAS\ResourceStorage\Flavours\DummyDefinition::getVariantName

(

)

If a definition can be used in several variants (e.g.

configurable size of a thumbnail), such variants must be distinguishable. For example, a variant name may contain "{height}x{width}" if these are configurable values.

The Variant-Name MUST be less than 768 characters long!

Implements ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition.

Definition at line 54 of file DummyDefinition.php.

                                    : ?string
    {
        return null;
    }

persist()

ILIAS\ResourceStorage\Flavours\DummyDefinition::persist

(

)

Define whether the generated flavor and the respective streams should be persisted, or whether they should only be generated and used in-memory.

Implements ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition.

Definition at line 59 of file DummyDefinition.php.

References ILIAS\ResourceStorage\Flavours\DummyDefinition\$persists.

                             : bool
    {
        return $this->persists;
    }

Field Documentation

$id

string ILIAS\ResourceStorage\Flavours\DummyDefinition::$id

private

Definition at line 28 of file DummyDefinition.php.

Referenced by ILIAS\ResourceStorage\Flavours\DummyDefinition\__construct(), and ILIAS\ResourceStorage\Flavours\DummyDefinition\getId().

$machine_id

string ILIAS\ResourceStorage\Flavours\DummyDefinition::$machine_id

private

Definition at line 29 of file DummyDefinition.php.

Referenced by ILIAS\ResourceStorage\Flavours\DummyDefinition\__construct(), and ILIAS\ResourceStorage\Flavours\DummyDefinition\getFlavourMachineId().

$persists

bool ILIAS\ResourceStorage\Flavours\DummyDefinition::$persists = false

private

Definition at line 30 of file DummyDefinition.php.

Referenced by ILIAS\ResourceStorage\Flavours\DummyDefinition\__construct(), and ILIAS\ResourceStorage\Flavours\DummyDefinition\persist().

---

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

• tests/ResourceStorage/Flavours/DummyDefinition.php