ilDownloadContainerFilesBackgroundTask Class Reference

Class ilDownloadContainerFilesBackgroundTask. More...

Collaboration diagram for ilDownloadContainerFilesBackgroundTask:

Public Member Functions
	__construct ($a_usr_id, $a_object_ref_ids, $a_initiated_by_folder_action)
	Constructor. More...
	setBucketTitle ($a_title)
	set bucket title. More...
	getBucketTitle ()
	return bucket title. More...
	run ()
	Run task. More...

Protected Attributes
	$user_id
	$object_ref_ids
	$initiated_by_folder_action = false
	$task_factory = null
	$bucket_title
	$has_files = false

Private Attributes
	$logger = null

Detailed Description

Class ilDownloadContainerFilesBackgroundTask.

Author

Lukas Zehnder lz@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 22 of file class.ilDownloadContainerFilesBackgroundTask.php.

Constructor & Destructor Documentation

__construct()

ilDownloadContainerFilesBackgroundTask::__construct	(		$a_usr_id,
			$a_object_ref_ids,
			$a_initiated_by_folder_action
	)

Constructor.

Parameters

type	$a_usr_id
	int[]	$a_object_ref_ids

Definition at line 67 of file class.ilDownloadContainerFilesBackgroundTask.php.

References $DIC.

    {
        global $DIC;
        $this->logger = $DIC->logger()->cal();
        $this->user_id = $a_usr_id;
        $this->object_ref_ids = $a_object_ref_ids;
        $this->initiated_by_folder_action = $a_initiated_by_folder_action;
        $this->task_factory = $DIC->backgroundTasks()->taskFactory();
        $this->lng = $DIC->language();
    }

Member Function Documentation

getBucketTitle()

ilDownloadContainerFilesBackgroundTask::getBucketTitle

(

)

return bucket title.

Returns

string

Definition at line 95 of file class.ilDownloadContainerFilesBackgroundTask.php.

References $bucket_title.

Referenced by run().

    {
        //TODO: fix ilUtil zip stuff
        // Error If name starts "-"
        // error massage from ilUtil->execQuoted = ["","zip error: Invalid command arguments (short option 'a' not supported)"]
        if (substr($this->bucket_title, 0, 1) === "-") {
            $this->bucket_title = ltrim($this->bucket_title, "-");
        }

        return $this->bucket_title;
    }

Here is the caller graph for this function:

run()

ilDownloadContainerFilesBackgroundTask::run

(

)

Run task.

Returns

bool

Definition at line 113 of file class.ilDownloadContainerFilesBackgroundTask.php.

References $GLOBALS, ilUtil\getASCIIFilename(), and getBucketTitle().

    {
        // This is our Bucket
        $this->logger->info('Started download container files background task');
        $bucket = new BasicBucket();
        $bucket->setUserId($this->user_id);
        $this->logger->debug('Created bucket and set the following user id: ' . $this->user_id);

        // Copy Definition
        $definition = new ilCopyDefinition();
        $normalized_name = ilUtil::getASCIIFilename($this->getBucketTitle());
        $definition->setTempDir($normalized_name);
        $definition->setObjectRefIds($this->object_ref_ids);
        $this->logger->debug('Created copy definition and added the following tempdir: ' . $normalized_name);

        // Collect all files by the definition and prevent duplicates
        $collect_job = $this->task_factory->createTask(ilCollectFilesJob::class, [$definition, $this->initiated_by_folder_action]);
        $this->logger->debug('Collected files based on the following object ids: ');
        $this->logger->dump($this->object_ref_ids);

        // Check the FileSize
        $file_size_job = $this->task_factory->createTask(ilCheckSumOfFileSizesJob::class, [$collect_job]);

        // Show problems with file-limit
        $file_size_interaction = $this->task_factory->createTask(ilSumOfFileSizesTooLargeInteraction::class, [$file_size_job]);
        $this->logger->debug('Determined the sum of all file sizes');

        // move files from source dir to target directory
        $copy_job = $this->task_factory->createTask(ilCopyFilesToTempDirectoryJob::class, [$file_size_interaction]);

        // Zip it
        $zip_job = $this->task_factory->createTask(ilZipJob::class, [$copy_job]);
        $this->logger->debug('Moved files from source- to target-directory');

        // Download
        $download_name = new StringValue();
        $download_name->setValue($normalized_name . '.zip');
        $download_interaction = $this->task_factory->createTask(ilDownloadZipInteraction::class, [$zip_job, $download_name]);
        $this->logger->debug('Created a download interaction with the following download name: ' . $download_name->getValue());

        // last task to bucket
        $bucket->setTask($download_interaction);
        $bucket->setTitle($this->getBucketTitle());
        $this->logger->debug('Added last task to bucket and set the following title: ' . $this->getBucketTitle());

        $task_manager = $GLOBALS['DIC']->backgroundTasks()->taskManager();
        $task_manager->run($bucket);
        $this->logger->debug('Ran bucket in task manager');

        return true;
    }

Here is the call graph for this function:

setBucketTitle()

ilDownloadContainerFilesBackgroundTask::setBucketTitle

(

$a_title

)

set bucket title.

Parameters

$a_title

Definition at line 84 of file class.ilDownloadContainerFilesBackgroundTask.php.

    {
        $this->bucket_title = $a_title;
    }

Field Documentation

$bucket_title

ilDownloadContainerFilesBackgroundTask::$bucket_title

protected

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

Referenced by getBucketTitle().

$has_files

ilDownloadContainerFilesBackgroundTask::$has_files = false

protected

Definition at line 58 of file class.ilDownloadContainerFilesBackgroundTask.php.

$initiated_by_folder_action

ilDownloadContainerFilesBackgroundTask::$initiated_by_folder_action = false

protected

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

$logger

ilDownloadContainerFilesBackgroundTask::$logger = null

private

Definition at line 28 of file class.ilDownloadContainerFilesBackgroundTask.php.

$object_ref_ids

ilDownloadContainerFilesBackgroundTask::$object_ref_ids

protected

Definition at line 36 of file class.ilDownloadContainerFilesBackgroundTask.php.

$task_factory

ilDownloadContainerFilesBackgroundTask::$task_factory = null

protected

Definition at line 46 of file class.ilDownloadContainerFilesBackgroundTask.php.

$user_id

ilDownloadContainerFilesBackgroundTask::$user_id

protected

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

---

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

• Services/Container/classes/BackgroundTasks/class.ilDownloadContainerFilesBackgroundTask.php