Inheritance diagram for ilUserProfilePictureMachine:

Collaboration diagram for ilUserProfilePictureMachine:

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
	processStream (FileInformation $information, FileStream $stream, FlavourDefinition $for_definition)

Data Fields
const	ID = "a3c77dec93b5303f4340767b9a445ad591f6025a9ca7edbf24fa8ab23a851eae"

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

	makeGreyScale (FileStream $stream)

Private Attributes
const	FULL_QUALITY_SIZE_THRESHOLD = 100

CropSquare	$crop

MakeGreyScale	$grey

ilUserProfilePictureDefinition	$definition = null

FileInformation	$information = null

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

Detailed Description

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

Definition at line 37 of file class.ilUserProfilePictureMachine.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserProfilePictureMachine::__construct ( )

FlavourMachines must be able to be created without further dependencies.

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 47 of file class.ilUserProfilePictureMachine.php.

     {
         $this->crop = new CropSquare();
         $this->grey = new MakeGreyScale();
     }

Member Function Documentation

◆ canHandleDefinition()

ilUserProfilePictureMachine::canHandleDefinition ( FlavourDefinition $definition )

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

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 59 of file class.ilUserProfilePictureMachine.php.

                                                                       : bool
     {
         return $definition instanceof ilUserProfilePictureDefinition;
     }

◆ cropImage()

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

protected

Definition at line 93 of file class.ilUserProfilePictureMachine.php.

Referenced by dependsOnEngine().

      : ?FileStream {
         $quality = $size <= self::FULL_QUALITY_SIZE_THRESHOLD
             ? 100 // we take 100% jpeg quality for small resultions
             : $this->definition->getQuality();
 
 
         return $this->crop->processStream(
             $this->information,
             $stream,
             new CropToSquare(
                 false,
                 $size,
                 $quality
             )
         )->current()?->getStream();
     }

Here is the caller graph for this function:

◆ dependsOnEngine()

ilUserProfilePictureMachine::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 64 of file class.ilUserProfilePictureMachine.php.

References $information, cropImage(), null, and ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine\processStream().

                                      : ?string
     {
         return GDEngine::class;
     }

Here is the call graph for this function:

◆ getId()

ilUserProfilePictureMachine::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 54 of file class.ilUserProfilePictureMachine.php.

                            : string
     {
         return self::ID;
     }

◆ makeGreyScale()

ilUserProfilePictureMachine::makeGreyScale ( FileStream $stream )

protected

Definition at line 113 of file class.ilUserProfilePictureMachine.php.

      : ?FileStream {
         return $this->grey->processStream(
             $this->information,
             $stream,
             new ToGreyScale(
                 false,
                 $this->definition->getQuality()
             )
         )->current()?->getStream();
     }