ilExDownloadSubmissionsZipInteraction Class Reference

Inheritance diagram for ilExDownloadSubmissionsZipInteraction:

Collaboration diagram for ilExDownloadSubmissionsZipInteraction:

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'

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

Additional Inherited Members
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)
	extractType ($value)

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilExDownloadSubmissionsZipInteraction::__construct

(

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

getInputTypes()

ilExDownloadSubmissionsZipInteraction::getInputTypes

(

)

Returns

[]

Implements ILIAS\BackgroundTasks\Task.

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

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

getOptions()

ilExDownloadSubmissionsZipInteraction::getOptions

(

array

$input

)

Returns

[]

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

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

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

getOutputType()

ilExDownloadSubmissionsZipInteraction::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

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

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

getRemoveOption()

ilExDownloadSubmissionsZipInteraction::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 56 of file class.ilExDownloadSubmissionsZipInteraction.php.

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

interaction()

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

Parameters

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

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

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

     : 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($download_name->getValue());
            } catch (InvalidArgumentException $e) {
                $path = null;
            }
            $this->logger->debug("Path: " . $path);
            try {
                if (!is_null($path) && $filesystem->has($path)) {
                    $this->logger->debug("Delete dir: " . dirname($path));
                    $filesystem->deleteDir(dirname($path));
                }
            } catch (Exception $e) {
            }

            return $download_name;
        }

        $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
        $this->logger->debug("Deliver: " . $download_name->getValue());
        $this->logger->debug("As: " . $zip_name);
        ilFileDelivery::deliverFileAttached($download_name->getValue(), $zip_name);

        return $download_name;
    }

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilExDownloadSubmissionsZipInteraction::$logger

protected

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

OPTION_CANCEL

const ilExDownloadSubmissionsZipInteraction::OPTION_CANCEL = 'cancel'

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

OPTION_DOWNLOAD

const ilExDownloadSubmissionsZipInteraction::OPTION_DOWNLOAD = 'download'

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

---

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

• components/ILIAS/Exercise/classes/BackgroundTasks/class.ilExDownloadSubmissionsZipInteraction.php