ZipStructureDefinition Class Reference

Inheritance diagram for ZipStructureDefinition:

Collaboration diagram for ZipStructureDefinition:

Public Member Functions
	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...
	sleep (array $data)
	wake (string $data)

Detailed Description

Author

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

Definition at line 27 of file ZipStructureDefinition.php.

Member Function Documentation

getFlavourMachineId()

ZipStructureDefinition::getFlavourMachineId

(

)

Defines the ID of the machine that supports this definition.

The machine MUST exist.

Implements ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition.

Definition at line 34 of file ZipStructureDefinition.php.

                                         : string
    {
        return 'zip_structure_reader';
    }

getId()

ZipStructureDefinition::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 29 of file ZipStructureDefinition.php.

                           : string
    {
        return 'a6ac86ca80c33ac3e5bfd4fc8da30f05a888e4cfb17fda479ba9b6f08b1f33ba';
    }

getInternalName()

ZipStructureDefinition::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 39 of file ZipStructureDefinition.php.

                                     : string
    {
        return 'Container Structure';
    }

getVariantName()

ZipStructureDefinition::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 44 of file ZipStructureDefinition.php.

References null.

                                    : ?string
    {
        return null;
    }

persist()

ZipStructureDefinition::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 49 of file ZipStructureDefinition.php.

                             : bool
    {
        return true;
    }

sleep()

ZipStructureDefinition::sleep

(

array

$data

)

Definition at line 54 of file ZipStructureDefinition.php.

                                      : string
    {
        return json_encode($data);
    }

wake()

ZipStructureDefinition::wake

(

string

$data

)

Definition at line 59 of file ZipStructureDefinition.php.

                                      : array
    {
        return json_decode($data, true);
    }

---

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

• components/ILIAS/ResourceStorage/classes/Container/Flavour/ZipStructureDefinition.php