ZipStructureMachine Class Reference

Inheritance diagram for ZipStructureMachine:

Collaboration diagram for ZipStructureMachine:

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...
	withEngine (Engine $engine)
	The demanded Engine will be passed here. More...
	getEngine ()
	processStream (FileInformation $information, FileStream $stream, FlavourDefinition $for_definition)

Detailed Description

Author

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

Definition at line 35 of file ZipStructureMachine.php.

Constructor & Destructor Documentation

__construct()

ZipStructureMachine::__construct

(

)

FlavourMachines must be able to be created without further dependencies.

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 37 of file ZipStructureMachine.php.

    {
    }

Member Function Documentation

canHandleDefinition()

ZipStructureMachine::canHandleDefinition

(

FlavourDefinition

$definition

)

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

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 46 of file ZipStructureMachine.php.

                                                                      : bool
    {
        return $definition instanceof ZipStructureDefinition;
    }

dependsOnEngine()

ZipStructureMachine::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 51 of file ZipStructureMachine.php.

                                     : ?string
    {
        return NoEngine::class;
    }

getEngine()

ZipStructureMachine::getEngine

(

)

Exceptions

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 61 of file ZipStructureMachine.php.

                               : Engine
    {
        return new NoEngine();
    }

getId()

ZipStructureMachine::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 41 of file ZipStructureMachine.php.

                           : string
    {
        return 'zip_structure_reader';
    }

processStream()

ZipStructureMachine::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 66 of file ZipStructureMachine.php.

References $data, and ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition\persist().

     : \Generator {
        if (!$for_definition instanceof ZipStructureDefinition) {
            throw new \InvalidArgumentException('Invalid definition');
        }
        $reader = new ZipReader($stream);

        $data = $reader->getStructure();

        yield new Result(
            $for_definition,
            Streams::ofString($for_definition->sleep($data)),
            0,
            $for_definition->persist()
        );
    }

Here is the call graph for this function:

withEngine()

ZipStructureMachine::withEngine

(

Engine

$engine

)

The demanded Engine will be passed here.

If the Machine does not depend on an Engine, a NullEngine

Implements ILIAS\ResourceStorage\Flavour\Machine\FlavourMachine.

Definition at line 56 of file ZipStructureMachine.php.

                                              : FlavourMachine
    {
        return $this;
    }

---

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

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