ilDownloadWorkspaceFolderBackgroundTask Class Reference

Background task for downloads. More...

Collaboration diagram for ilDownloadWorkspaceFolderBackgroundTask:

Public Member Functions
	__construct (int $a_usr_id, array $a_object_wsp_ids, bool $a_initiated_by_folder_action=false)
	Constructor. More...
	setBucketTitle ($a_title)
	set bucket title. More...
	getBucketTitle ()
	return bucket title. More...
	run ()
	Run task. More...

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

Private Attributes
	$logger = null

Detailed Description

Background task for downloads.

Author

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

Definition at line 13 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

Constructor & Destructor Documentation

__construct()

ilDownloadWorkspaceFolderBackgroundTask::__construct	(	int	$a_usr_id,
		array	$a_object_wsp_ids,
		bool	$a_initiated_by_folder_action = false
	)

Constructor.

Parameters

int	$a_usr_id
	int[]	$a_object_wsp_ids
bool	$a_initiated_by_folder_action

Definition at line 59 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

References $DIC, and ilLoggerFactory\getLogger().

    {
        global $DIC;
        $this->logger = ilLoggerFactory::getLogger("pwsp");
        $this->user_id = $a_usr_id;
        $this->object_wsp_ids = $a_object_wsp_ids;
        $this->initiated_by_folder_action = $a_initiated_by_folder_action;
        $this->task_factory = $DIC->backgroundTasks()->taskFactory();
        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

getBucketTitle()

ilDownloadWorkspaceFolderBackgroundTask::getBucketTitle

(

)

return bucket title.

Returns

string

Definition at line 87 of file class.ilDownloadWorkspaceFolderBackgroundTask.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()

ilDownloadWorkspaceFolderBackgroundTask::run

(

)

Run task.

Returns

bool

Definition at line 105 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

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

    {
        // This is our Bucket
        $this->logger->info('Started download workspace 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 ilWorkspaceCopyDefinition();
        $normalized_name = ilUtil::getASCIIFilename($this->getBucketTitle());
        $definition->setTempDir($normalized_name);
        $definition->setObjectWspIds($this->object_wsp_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(ilCollectWorkspaceFilesJob::class, [$definition, $this->initiated_by_folder_action]);
        $this->logger->debug('Collected files based on the following object ids: ');
        $this->logger->dump($this->object_wsp_ids);

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

        // Show problems with file-limit
        $file_size_interaction = $this->task_factory->createTask(ilSumOfWorkspaceFileSizesTooLargeInteraction::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(ilCopyWorkspaceFilesToTempDirectoryJob::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()

ilDownloadWorkspaceFolderBackgroundTask::setBucketTitle

(

$a_title

)

set bucket title.

Parameters

$a_title

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

    {
        $this->bucket_title = $a_title;
    }

Field Documentation

$bucket_title

ilDownloadWorkspaceFolderBackgroundTask::$bucket_title

protected

Definition at line 43 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

Referenced by getBucketTitle().

$has_files

ilDownloadWorkspaceFolderBackgroundTask::$has_files = false

protected

Definition at line 49 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

$initiated_by_folder_action

ilDownloadWorkspaceFolderBackgroundTask::$initiated_by_folder_action = false

protected

Definition at line 33 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

$logger

ilDownloadWorkspaceFolderBackgroundTask::$logger = null

private

Definition at line 19 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

$object_wsp_ids

ilDownloadWorkspaceFolderBackgroundTask::$object_wsp_ids

protected

Definition at line 27 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

$task_factory

ilDownloadWorkspaceFolderBackgroundTask::$task_factory = null

protected

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

$user_id

ilDownloadWorkspaceFolderBackgroundTask::$user_id

protected

Definition at line 23 of file class.ilDownloadWorkspaceFolderBackgroundTask.php.

---

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

• Modules/WorkspaceFolder/BackgroundTask/classes/class.ilDownloadWorkspaceFolderBackgroundTask.php