ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction Class Reference

Inheritance diagram for ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction:

Collaboration diagram for ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction:

Public Member Functions
	__construct ()
	getInputTypes ()
	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...

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 = null

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

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 34 of file DownloadAllZipInteraction.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::__construct

(

)

Definition at line 41 of file DownloadAllZipInteraction.php.

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

    {
        global $DIC;

        $this->logger = $DIC->logger()->mcst();
    }

Here is the call graph for this function:

Member Function Documentation

getInputTypes()

ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::getInputTypes

(

)

Returns

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

Implements ILIAS\BackgroundTasks\Task.

Definition at line 48 of file DownloadAllZipInteraction.php.

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

getOptions()

ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::getOptions

(

array

$input

)

Parameters

Value[]

$input The input value of this task.

Returns

Option[] Options are buttons the user can press on this interaction.

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 67 of file DownloadAllZipInteraction.php.

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

getOutputType()

ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 62 of file DownloadAllZipInteraction.php.

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

getRemoveOption()

ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::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();

Implements ILIAS\BackgroundTasks\Task.

Definition at line 57 of file DownloadAllZipInteraction.php.

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

interaction()

ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::interaction	(	array	$input,
		Option	$user_selected_option,
		Bucket	$bucket
	)

Parameters

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 74 of file DownloadAllZipInteraction.php.

References $DIC, Vendor\Package\$e, $path, ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath(), ilFileDelivery\deliverFileAttached(), ILIAS\BackgroundTasks\Task\UserInteraction\Option\getValue(), and ILIAS\Repository\logger().

     : \ILIAS\BackgroundTasks\Value {
        global $DIC;
        $download_name = $input[0]; //directory name.
        $zip_name = $input[1]; // zip job

        $this->logger->debug("Interaction -> input[0] download name MUST BE FULL PATH=> " . $download_name->getValue());
        $this->logger->debug("Interaction -> input[1] zip name MUST BE THE NAME WITHOUT EXTENSION. => " . $zip_name->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.");


        $zip_name = $zip_name->getValue();

        $ending = substr($zip_name, -4);
        if ($ending != ".zip") {
            $zip_name .= ".zip";
            $this->logger->info("Add .zip extension");
        }

        //Download_name->getValue should return the complete path to the file
        //Zip name is just an string
        \ilFileDelivery::deliverFileAttached($download_name->getValue(), $zip_name);

        return new ThunkValue();
    }

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::$logger = null

private

Definition at line 39 of file DownloadAllZipInteraction.php.

OPTION_CANCEL

const ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::OPTION_CANCEL = 'cancel'

Definition at line 37 of file DownloadAllZipInteraction.php.

OPTION_DOWNLOAD

const ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction::OPTION_DOWNLOAD = 'download'

Definition at line 36 of file DownloadAllZipInteraction.php.

---

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

• Modules/MediaCast/BackgroundTasks/DownloadAllZipInteraction.php