Description of class class. More...

Inheritance diagram for ilZipJob:

Collaboration diagram for ilZipJob:

Public Member Functions
	__construct ()
	Construct. More...

	getInputTypes ()

	getOutputType ()

	isStateless ()

	run (array $input, \ILIAS\BackgroundTasks\Observer $observer)

	getExpectedTimeOfTaskInSeconds ()
	Returns int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns array returns the input array More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)

	getOutput ()

	getInput ()

	getType ()

	unfoldTask ()
	Unfold the task. More...

	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...

	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Task\Job
	run (array $input, Observer $observer)

Private Attributes
ilLogger	$logger

ILIAS Filesystem Util Archive Archives	$archives

Additional Inherited Members
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'

const	MAIN_ABORT = 'bt_main_abort'

Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)

	extractType ($value)

Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []

ILIAS BackgroundTasks Value	$output

Detailed Description

Description of class class.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 30 of file class.ilZipJob.php.

Constructor & Destructor Documentation

◆ __construct()

ilZipJob::__construct ( )

Construct.

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

References $DIC, and ILIAS\Repository\logger().

     {
         global $DIC;
         $this->logger = $DIC->logger()->cal();
         $this->archives = $DIC->archives();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getExpectedTimeOfTaskInSeconds()

ilZipJob::getExpectedTimeOfTaskInSeconds ( )

Returns: int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 107 of file class.ilZipJob.php.

◆ getInputTypes()

ilZipJob::getInputTypes ( )

Implements ILIAS\BackgroundTasks\Task.

Definition at line 49 of file class.ilZipJob.php.

                                    : array
     {
         return
             [
                 new SingleType(StringValue::class),
             ];
     }

◆ getOutputType()

ilZipJob::getOutputType ( )

Implements ILIAS\BackgroundTasks\Task.

Definition at line 61 of file class.ilZipJob.php.

                                    : Type
     {
         return new SingleType(StringValue::class);
     }

◆ isStateless()

ilZipJob::isStateless ( )

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 70 of file class.ilZipJob.php.

                                  : bool
     {
         return true;
     }

◆ run()

ilZipJob::run	(	array	$input,
		\ILIAS\BackgroundTasks\Observer	$observer
	)

Todo:: use filsystem service

Definition at line 80 of file class.ilZipJob.php.

References ilFileUtils\delDir(), and ILIAS\Repository\logger().

                                                                                 : Value
     {
         $this->logger->debug('Start zipping input dir!');
         $this->logger->dump($input);
         $string = $input[0]->getValue();
         $tmpdir = rtrim($string, "/");
         $this->logger->debug('Zipping directory:' . $tmpdir);
         $zip_name = $tmpdir . '.zip';
 
         $zip = $this->archives->zip([]);
         $zip->addDirectory($tmpdir);
         $zip_stream = $zip->get();
         stream_copy_to_stream($zip_stream->detach(), fopen($zip_name, 'wb')); // we currently have to write to disk
 
         // delete temp directory
         ilFileUtils::delDir($tmpdir);
 
         $zip_file_name = new StringValue();
         $zip_file_name->setValue($zip_name);
 
         return $zip_file_name;
     }

Here is the call graph for this function:

Field Documentation

◆ $archives

ILIAS Filesystem Util Archive Archives ilZipJob::$archives

private

Definition at line 33 of file class.ilZipJob.php.

◆ $logger

ilLogger ilZipJob::$logger