ilCalendarDownloadZipInteraction Class Reference

Description of class class. More...

Inheritance diagram for ilCalendarDownloadZipInteraction:

Collaboration diagram for ilCalendarDownloadZipInteraction:

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

Protected Attributes
const	OPTION_DOWNLOAD = 'download'
const	OPTION_CANCEL = 'cancel'
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []
Value	$output

Private Attributes
ilLogger	$logger

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 (array $values)
	extractType ($value)

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 36 of file class.ilCalendarDownloadZipInteraction.php.

Constructor & Destructor Documentation

__construct()

ilCalendarDownloadZipInteraction::__construct

(

)

Definition at line 43 of file class.ilCalendarDownloadZipInteraction.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

getInputTypes()

ilCalendarDownloadZipInteraction::getInputTypes

(

)

Returns

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

Implements ILIAS\BackgroundTasks\Task.

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

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

getOptions()

ilCalendarDownloadZipInteraction::getOptions

(

array

$input

)

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 79 of file class.ilCalendarDownloadZipInteraction.php.

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

getOutputType()

ilCalendarDownloadZipInteraction::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 71 of file class.ilCalendarDownloadZipInteraction.php.

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

getRemoveOption()

ilCalendarDownloadZipInteraction::getRemoveOption

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 63 of file class.ilCalendarDownloadZipInteraction.php.

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

interaction()

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

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 89 of file class.ilCalendarDownloadZipInteraction.php.

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

                                                                                           : 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));
            }

            // @todo what kind of value is desired
            return $download_name;
        }

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

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

        // @todo what kind of value is desired
        return $download_name;
    }

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilCalendarDownloadZipInteraction::$logger

private

Definition at line 41 of file class.ilCalendarDownloadZipInteraction.php.

OPTION_CANCEL

const ilCalendarDownloadZipInteraction::OPTION_CANCEL = 'cancel'

protected

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

OPTION_DOWNLOAD

const ilCalendarDownloadZipInteraction::OPTION_DOWNLOAD = 'download'

protected

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

---

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

• components/ILIAS/Calendar/classes/BackgroundTasks/class.ilCalendarDownloadZipInteraction.php