Inheritance diagram for FirstPageToTileImageMachine:

Collaboration diagram for FirstPageToTileImageMachine:

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

	processStream (FileInformation $information, FileStream $stream, FlavourDefinition $for_definition)

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 ()

Data Fields
const	ID = "be03e07e396a61f7d9b31a712f0913fe9c6cd43b009ce69d30aa0f10bd3500bd"

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

Private Attributes
const	FULL_QUALITY_SIZE_THRESHOLD = 100

ExtractPages	$extract_pages

CropRectangle	$crop

ilObjectTileImageFlavourDefinition	$definition = null

FileInformation	$information = null

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

Detailed Description

Author: Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns AutoloadingIssuesInspection

Definition at line 38 of file FirstPageToTileImageFlavourMachine.php.

Constructor & Destructor Documentation

◆ __construct()

FirstPageToTileImageMachine::__construct ( )

FlavourMachines must be able to be created without further dependencies.

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 50 of file FirstPageToTileImageFlavourMachine.php.

     {
         $this->extract_pages = new ExtractPages();
         $this->crop = new CropRectangle();
     }

Member Function Documentation

◆ canHandleDefinition()

FirstPageToTileImageMachine::canHandleDefinition ( FlavourDefinition $definition )

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

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 62 of file FirstPageToTileImageFlavourMachine.php.

                                                                       : bool
     {
         return $definition instanceof ilObjectTileImageFlavourDefinition;
     }

◆ cropImage()

FirstPageToTileImageMachine::cropImage	(	FileStream	$stream,
		int	$width
	)

protected

Definition at line 108 of file FirstPageToTileImageFlavourMachine.php.

Referenced by processStream().

       {
         $quality = $width <= 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 CropToRectangle(
                 false,
                 $width,
                 $this->definition->getRatio(),
                 $quality
             )
         )->current()->getStream();
     }

Here is the caller graph for this function:

◆ dependsOnEngine()

FirstPageToTileImageMachine::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 67 of file FirstPageToTileImageFlavourMachine.php.

                                      : ?string
     {
         return ImagickEngine::class;
     }

◆ getId()

FirstPageToTileImageMachine::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 57 of file FirstPageToTileImageFlavourMachine.php.

                            : string
     {
         return self::ID;
     }

◆ processStream()

FirstPageToTileImageMachine::processStream	(	FileInformation	$information,
		FileStream	$stream,
		FlavourDefinition	$for_definition
	)

Parameters

FileInformation	$information	of the original File.
FileStream	$stream	of the original File.
FlavourDefinition	$for_definition	the definition for which the stream should be processed.

Returns: Result[]| For each "thing" that the machine generates, a result can be returned. E.g. when extracting 5 images from a PDF, 5 results are returned (Generator).

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 72 of file FirstPageToTileImageFlavourMachine.php.

References $information, cropImage(), and null.

      : \Generator {
         $this->definition = $for_definition;
         $this->information = $information;
 
         $page_stream = $this->extract_pages->processStream(
             $this->information,
             $stream,
             new PagesToExtract(
                 false,
                 $this->definition->getWidths()['xl'],
                 1,
                 false,
                 100
             )
         )->current()?->getStream();
 
         if ($page_stream === null) {
             return;
         }
 
         $i = 0;
         foreach ($for_definition->getWidths() as $width) {
             yield new Result(
                 $for_definition,
                 $this->cropImage($page_stream, $width),
                 $i,
                 true
             );
             $i++;
         }
     }