ilDownloadZipInteraction Class Reference

Description of class class. More...

Inheritance diagram for ilDownloadZipInteraction:

Collaboration diagram for ilDownloadZipInteraction:

Public Member Functions
	__construct ()
	getInputTypes ()
	Returns Type[] A list of types that are taken as input. More...
	getRemoveOption ()
	getOutputType ()
	getOptions (array $input)
	interaction (array $input, Option $user_selected_option, Bucket $bucket)
	canBeSkipped (array $input)
	Decide whether the UserInteraction is presented to the user and he has to decide or user UserInteraction is skipped by the TaskManager. More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction
	getMessage (array $input)
	canBeSkipped (array $input)
	getSkippedValue (array $input)
	isFinal ()
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...

Data Fields
const	OPTION_DOWNLOAD = 'download'
const	OPTION_CANCEL = 'cancel'
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'

Private Attributes
ilLogger	$logger

Additional Inherited Members
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 35 of file class.ilDownloadZipInteraction.php.

Constructor & Destructor Documentation

__construct()

ilDownloadZipInteraction::__construct

(

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

canBeSkipped()

ilDownloadZipInteraction::canBeSkipped

(

array

$input

)

Decide whether the UserInteraction is presented to the user and he has to decide or user UserInteraction is skipped by the TaskManager.

You must return a valid Value then,

Parameters

Value[]

$input The input value of this task.

See also

getSkippedValue.

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 126 of file class.ilDownloadZipInteraction.php.

                                              : bool
    {
        return false;
    }

getInputTypes()

ilDownloadZipInteraction::getInputTypes

(

)

Returns

Type[] A list of types that are taken as input.

Implements ILIAS\BackgroundTasks\Task.

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

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

getOptions()

ilDownloadZipInteraction::getOptions

(

array

$input

)

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 82 of file class.ilDownloadZipInteraction.php.

                                            : array
    {
        return [
            new UserInteractionOption('download', self::OPTION_DOWNLOAD),
        ];
    }

getOutputType()

ilDownloadZipInteraction::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 73 of file class.ilDownloadZipInteraction.php.

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

getRemoveOption()

ilDownloadZipInteraction::getRemoveOption

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 64 of file class.ilDownloadZipInteraction.php.

                                     : Option
    {
        return new UserInteractionOption('remove', self::OPTION_CANCEL);
    }

interaction()

ilDownloadZipInteraction::interaction	(	array	$input,
		Option	$user_selected_option,
		Bucket	$bucket
	)

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

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

References $DIC, Vendor\Package\$e, $path, ilFileDelivery\deliverFileAttached(), ILIAS\BackgroundTasks\Task\UserInteraction\Option\getValue(), ILIAS\UI\Implementation\Component\Input\getValue(), and ILIAS\Repository\logger().

                                                                                           : Value
    {
        global $DIC;
        $zip_name = $input[1];
        $download_name = $input[0];

        $this->logger->debug('User interaction download zip ' . $input[0]->getValue() . ' as '
            . $input[1]->getValue());

        if ($user_selected_option->getValue() != self::OPTION_DOWNLOAD) {
            $this->logger->info('Download canceled');
            // delete zip file
            $filesystem = $DIC->filesystem()->temp();

            try {
                $path = LegacyPathHelper::createRelativePath($zip_name->getValue());
            } catch (InvalidArgumentException $e) {
                $path = null;
            }
            if (!is_null($path) && $filesystem->has($path)) {
                $filesystem->deleteDir(dirname($path));
            }

            return new ThunkValue();
        }

        $this->logger->info("Delivering File.");

        ilFileDelivery::deliverFileAttached($download_name->getValue(), $zip_name->getValue());

        return new ThunkValue();
    }

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilDownloadZipInteraction::$logger

private

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

OPTION_CANCEL

const ilDownloadZipInteraction::OPTION_CANCEL = 'cancel'

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

OPTION_DOWNLOAD

const ilDownloadZipInteraction::OPTION_DOWNLOAD = 'download'

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

---

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

• components/ILIAS/BackgroundTasks_/classes/UserInteractions/class.ilDownloadZipInteraction.php