Inheritance diagram for ilExDownloadSubmissionsZipInteraction:

Collaboration diagram for ilExDownloadSubmissionsZipInteraction:

Public Member Functions
	__construct ()

	getInputTypes ()
	Returns Type[] A list of types that are taken as input. More...

	getRemoveOption ()
	@inheritDoc More...

	getOutputType ()
	@inheritDoc More...

	getOptions (array $input)
	@inheritDoc More...

	interaction (array $input, Option $user_selected_option, Bucket $bucket)
	@inheritDoc More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction
	getMessage (array $input)
	@inheritDoc More...

	canBeSkipped (array $input)
	@inheritDoc More...

	getSkippedValue (array $input)

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

	getType ()

	getInputTypes ()

	getOutputType ()

	getOutput ()

	setInput (array $values)

	getInput ()

	unfoldTask ()

	getRemoveOption ()

	getAbortOption ()

	getOptions (array $input)

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

	getSkippedValue (array $input)

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

	getMessage (array $input)

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
	$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
	$input = []

	$output

Detailed Description

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 15 of file class.ilExDownloadSubmissionsZipInteraction.php.

Constructor & Destructor Documentation

◆ __construct()

ilExDownloadSubmissionsZipInteraction::__construct ( )

Definition at line 26 of file class.ilExDownloadSubmissionsZipInteraction.php.

    {
        $this->logger = $GLOBALS['DIC']->logger()->exc();
    }

References $GLOBALS.

Member Function Documentation

◆ getInputTypes()

ilExDownloadSubmissionsZipInteraction::getInputTypes ( )

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

Implements ILIAS\BackgroundTasks\Task.

Definition at line 35 of file class.ilExDownloadSubmissionsZipInteraction.php.

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

◆ getOptions()

ilExDownloadSubmissionsZipInteraction::getOptions ( array $input )

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 65 of file class.ilExDownloadSubmissionsZipInteraction.php.

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

◆ getOutputType()

ilExDownloadSubmissionsZipInteraction::getOutputType ( )

@inheritDoc

Implements ILIAS\BackgroundTasks\Task.

Definition at line 56 of file class.ilExDownloadSubmissionsZipInteraction.php.

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

◆ getRemoveOption()

ilExDownloadSubmissionsZipInteraction::getRemoveOption ( )

@inheritDoc

Reimplemented from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask.

Definition at line 47 of file class.ilExDownloadSubmissionsZipInteraction.php.

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

◆ interaction()

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

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 76 of file class.ilExDownloadSubmissionsZipInteraction.php.

    {
        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 $input;
        }
 
        $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 $input;
    }