FirstPageToTileImageFlavourDefinition Class Reference

Inheritance diagram for FirstPageToTileImageFlavourDefinition:

Collaboration diagram for FirstPageToTileImageFlavourDefinition:

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...
Public Member Functions inherited from ILIAS\ILIASObject\Properties\CoreProperties\TileImage\FlavourDefinition
	__construct ()
	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...
	getWidths ()
	getRatio ()
	getQuality ()
	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
const	ID = 'b9b2f16325492412304989a9b3e32479e612957582f60ed667af31e7b36e50ed'

Detailed Description

Definition at line 23 of file FirstPageToTileImageFlavourDefintion.php.

Member Function Documentation

getFlavourMachineId()

FirstPageToTileImageFlavourDefinition::getFlavourMachineId

(

)

Defines the ID of the machine that supports this definition.

The machine MUST exist.

Reimplemented from ILIAS\ILIASObject\Properties\CoreProperties\TileImage\FlavourDefinition.

Definition at line 34 of file FirstPageToTileImageFlavourDefintion.php.

                                         : string
    {
        return FirstPageToTileImageMachine::ID;
    }

References FirstPageToTileImageMachine\ID.

getId()

FirstPageToTileImageFlavourDefinition::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.

Reimplemented from ILIAS\ILIASObject\Properties\CoreProperties\TileImage\FlavourDefinition.

Definition at line 28 of file FirstPageToTileImageFlavourDefintion.php.

                           : string
    {
        return self::ID;
    }

References ID.

getInternalName()

FirstPageToTileImageFlavourDefinition::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.

Reimplemented from ILIAS\ILIASObject\Properties\CoreProperties\TileImage\FlavourDefinition.

Definition at line 40 of file FirstPageToTileImageFlavourDefintion.php.

                                     : string
    {
        return 'first_page_tile_image';
    }

Field Documentation

ID

const FirstPageToTileImageFlavourDefinition::ID = 'b9b2f16325492412304989a9b3e32479e612957582f60ed667af31e7b36e50ed'

private

Definition at line 25 of file FirstPageToTileImageFlavourDefintion.php.

Referenced by getId().

---

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

• components/ILIAS/File/classes/ObjectProperties/FirstPageToTileImageFlavourDefintion.php