ilBadgePictureMachine Class Reference

Inheritance diagram for ilBadgePictureMachine:

Collaboration diagram for ilBadgePictureMachine:

Public Member Functions
	__construct ()
	FlavourMachines must be able to be created without further dependencies. More...
	getId ()
	canHandleDefinition (FlavourDefinition $definition)
	Check if a corresponding configuration can be processed by this Machine. More...
	dependsOnEngine ()
	Return the class name of the Engine that is required for this Machine to work. More...
Public Member Functions inherited from ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\AbstractMachine
	__construct ()
	FlavourMachines must be able to be created without further dependencies. More...
	withEngine (Engine $engine)
	The demanded Engine will be passed here. More...
	getEngine ()
Public Member Functions inherited from ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine
	__construct ()
	FlavourMachines must be able to be created without further dependencies. More...
	getId ()
	canHandleDefinition (FlavourDefinition $definition)
	Check if a corresponding configuration can be processed by this Machine. More...
	dependsOnEngine ()
	Return the class name of the Engine that is required for this Machine to work. More...
	withEngine (Engine $engine)
	The demanded Engine will be passed here. More...
	getEngine ()
	processStream (FileInformation $information, FileStream $stream, FlavourDefinition $for_definition)

Data Fields
const	ID = 'badge_image_resize_machine'

Protected Member Functions
	cropImage (FileStream $stream, int $size)

Private Attributes
const	FULL_QUALITY_SIZE_THRESHOLD = 100
CropSquare	$crop
ilBadgePictureDefinition	$definition = null
FileInformation	$information = null
ExtractPages	$extract_pages

Additional Inherited Members
Protected Attributes inherited from ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\AbstractMachine
Engine	$engine = null

Detailed Description

Definition at line 34 of file class.ilBadgePictureMachine.php.

Constructor & Destructor Documentation

__construct()

ilBadgePictureMachine::__construct

(

)

FlavourMachines must be able to be created without further dependencies.

Reimplemented from ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\AbstractMachine.

Definition at line 46 of file class.ilBadgePictureMachine.php.

    {
        parent::__construct();
        $this->crop = new CropSquare();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

canHandleDefinition()

ilBadgePictureMachine::canHandleDefinition

(

FlavourDefinition

$definition

)

Check if a corresponding configuration can be processed by this Machine.

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 57 of file class.ilBadgePictureMachine.php.

                                                                      : bool
    {
        return $definition instanceof ilBadgePictureDefinition;
    }

References $definition.

cropImage()

ilBadgePictureMachine::cropImage ( FileStream  $stream, int  $size  )

protected

Definition at line 88 of file class.ilBadgePictureMachine.php.

     : ?Stream {
        $quality = $size <= self::FULL_QUALITY_SIZE_THRESHOLD
            ? 100
            : $this->definition->getQuality();
 
        return $this->crop->processStream(
            $this->information,
            $stream,
            new CropToSquare(
                false,
                $size,
                $quality
            )
        )->current()->getStream();
    }

dependsOnEngine()

ilBadgePictureMachine::dependsOnEngine

(

)

Return the class name of the Engine that is required for this Machine to work.

Returning null will result in a NullEngine passed to the Machine.

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 62 of file class.ilBadgePictureMachine.php.

                                     : ?string
    {
        return ImagickEngine::class;
    }

getId()

ilBadgePictureMachine::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, FlavourDefinitions may no longer process anything with your machine that previously designated you as the processing machine.

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 52 of file class.ilBadgePictureMachine.php.

                           : string
    {
        return self::ID;
    }

References ID.

Field Documentation

$crop

CropSquare ilBadgePictureMachine::$crop

private

Definition at line 41 of file class.ilBadgePictureMachine.php.

$definition

ilBadgePictureDefinition ilBadgePictureMachine::$definition = null

private

Definition at line 42 of file class.ilBadgePictureMachine.php.

Referenced by canHandleDefinition().

$extract_pages

ExtractPages ilBadgePictureMachine::$extract_pages

private

Definition at line 44 of file class.ilBadgePictureMachine.php.

$information

FileInformation ilBadgePictureMachine::$information = null

private

Definition at line 43 of file class.ilBadgePictureMachine.php.

FULL_QUALITY_SIZE_THRESHOLD

const ilBadgePictureMachine::FULL_QUALITY_SIZE_THRESHOLD = 100

private

Definition at line 39 of file class.ilBadgePictureMachine.php.

ID

const ilBadgePictureMachine::ID = 'badge_image_resize_machine'

Definition at line 38 of file class.ilBadgePictureMachine.php.

Referenced by ilBadgePictureDefinition\getFlavourMachineId(), and getId().

---

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

• components/ILIAS/Badge/classes/Flavours/class.ilBadgePictureMachine.php