Description of class class. More...

Inheritance diagram for ilCalendarCopyFilesToTempDirectoryJob:

Collaboration diagram for ilCalendarCopyFilesToTempDirectoryJob:

Public Member Functions
	__construct ()
	Constructor. More...

	getInputTypes ()
	@inheritDoc More...

	getOutputType ()
	@inheritDoc More...

	isStateless ()
	@inheritDoc More...

	run (array $input, Observer $observer)
	@inheritDoc More...

	getExpectedTimeOfTaskInSeconds ()
	Returns int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns Value[] More...

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 ()

	run (array $input, Observer $observer)

	isStateless ()

	getInput ()

	getExpectedTimeOfTaskInSeconds ()

Protected Member Functions
	createUniqueTempDirectory ()

	createTargetDirectory (string $a_tmpdir)

	copyFiles (string $tmpdir, ilCalendarRessourceStorageCopyDefinition $definition)
	Copy files. More...

	copyWithRId (string $tmpdir, array $copy_task)

	copyWithAbsolutePath (string $tmpdir, array $copy_task)

Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes (array $values)

	extractType ($value)

Protected Attributes
string	$target_directory

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

Value	$output

Private Attributes
ilLogger	$logger

ILIAS ResourceStorage Services	$irss

Additional Inherited Members
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'

const	MAIN_ABORT = 'bt_main_abort'

Detailed Description

Description of class class.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarCopyFilesToTempDirectoryJob::__construct ( )

Constructor.

Definition at line 44 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

    {
        global $DIC;
 
        $this->irss = $DIC->resourceStorage();
        $this->logger = $DIC->logger()->cal();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ copyFiles()

ilCalendarCopyFilesToTempDirectoryJob::copyFiles	(	string	$tmpdir,
		ilCalendarRessourceStorageCopyDefinition	$definition
	)

protected

Copy files.

Definition at line 134 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

                                                                                                      : void
    {
        foreach ($definition->getCopyDefinitions() as $copy_task) {
            if(!is_null($copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_RESSOURCE_ID])) {
                $this->copyWithRId($tmpdir, $copy_task);
            } else {
                $this->copyWithAbsolutePath($tmpdir, $copy_task);
            }
        }
    }

References ilCalendarRessourceStorageCopyDefinition\COPY_RESSOURCE_ID, copyWithAbsolutePath(), copyWithRId(), and ilCalendarRessourceStorageCopyDefinition\getCopyDefinitions().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyWithAbsolutePath()

ilCalendarCopyFilesToTempDirectoryJob::copyWithAbsolutePath	(	string	$tmpdir,
		array	$copy_task
	)

protected

Definition at line 166 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

    {
        $absolute_path = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_ABSOLUTE_PATH];
        $target_dir = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_TARGET_DIR];
 
        if (!file_exists($absolute_path)) {
            $this->logger->notice('Cannot find file: ' . $absolute_path);
            return;
        }
 
        $this->logger->debug('Creating directory: ' . $tmpdir . '/' . dirname($target_dir));
        ilFileUtils::makeDirParents($tmpdir . '/' . dirname($target_dir));
        $this->logger->debug('Copying from: ' . $absolute_path . ' to ' . $tmpdir . '/' . $target_dir);
 
        copy($absolute_path, $tmpdir . '/' . $target_dir);
    }

References ilCalendarRessourceStorageCopyDefinition\COPY_ABSOLUTE_PATH, ilCalendarRessourceStorageCopyDefinition\COPY_TARGET_DIR, ILIAS\Repository\logger(), and ilFileUtils\makeDirParents().

Referenced by copyFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyWithRId()

ilCalendarCopyFilesToTempDirectoryJob::copyWithRId	(	string	$tmpdir,
		array	$copy_task
	)

protected

Definition at line 145 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

    {
        $target_dir = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_TARGET_DIR];
        $rid = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_RESSOURCE_ID];
        $resource_identification = $this->irss->manage()->find($rid);
 
        if(is_null($resource_identification)) {
            $this->logger->notice('Cannot ressource identification of rid: ' . $rid);
            return;
        }
 
        $this->logger->debug('Creating directory: ' . $tmpdir . '/' . dirname($target_dir));
        ilFileUtils::makeDirParents($tmpdir . '/' . dirname($target_dir));
        $this->logger->debug('Copying ressource with id: ' . $rid . ' to ' . $tmpdir . '/' . $target_dir);
 
        file_put_contents(
            $tmpdir . '/' . $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_TARGET_DIR],
            $this->irss->consume()->stream($resource_identification)->getStream()
        );
    }

References ilCalendarRessourceStorageCopyDefinition\COPY_RESSOURCE_ID, ilCalendarRessourceStorageCopyDefinition\COPY_TARGET_DIR, ILIAS\Repository\logger(), and ilFileUtils\makeDirParents().

Referenced by copyFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTargetDirectory()

ilCalendarCopyFilesToTempDirectoryJob::createTargetDirectory ( string $a_tmpdir )

protected

Definition at line 123 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

                                                              : string
    {
        $final_dir = $a_tmpdir . "/" . $this->target_directory;
        ilFileUtils::makeDirParents($final_dir);
        $this->logger->info('New final directory: ' . $final_dir);
        return $final_dir;
    }

References $target_directory, ILIAS\Repository\logger(), and ilFileUtils\makeDirParents().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createUniqueTempDirectory()

ilCalendarCopyFilesToTempDirectoryJob::createUniqueTempDirectory ( )

protected

Returns: string absolute path to new temp directory

Todo:: refactor to new file system access Create unique temp directory

Definition at line 115 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

                                                  : string
    {
        $tmpdir = ilFileUtils::ilTempnam();
        ilFileUtils::makeDirParents($tmpdir);
        $this->logger->info('New temp directory: ' . $tmpdir);
        return $tmpdir;
    }

References ilFileUtils\ilTempnam(), ILIAS\Repository\logger(), and ilFileUtils\makeDirParents().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExpectedTimeOfTaskInSeconds()

ilCalendarCopyFilesToTempDirectoryJob::getExpectedTimeOfTaskInSeconds ( )

Returns: int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 186 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

◆ getInputTypes()

ilCalendarCopyFilesToTempDirectoryJob::getInputTypes ( )

@inheritDoc

Implements ILIAS\BackgroundTasks\Task.

Definition at line 55 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

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

◆ getOutputType()

ilCalendarCopyFilesToTempDirectoryJob::getOutputType ( )

@inheritDoc

Todo:: output should be file type

Implements ILIAS\BackgroundTasks\Task.

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

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

◆ isStateless()

ilCalendarCopyFilesToTempDirectoryJob::isStateless ( )

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 75 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

                                 : bool
    {
        return true;
    }

◆ run()

ilCalendarCopyFilesToTempDirectoryJob::run	(	array	$input,
		Observer	$observer
	)

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 83 of file class.ilCalendarCopyFilesToTempDirectoryJob.php.

                                                         : Value
    {
        $cal_copy_def = $input[0];
 
        $this->logger->info('Called copy files job');
 
        $this->target_directory = $cal_copy_def->getTempDir();
        //$this->target_directory = $input[1]->getValue();
 
        // create temp directory
        $tmpdir = $this->createUniqueTempDirectory();
        $targetdir = $this->createTargetDirectory($tmpdir);
 
        // copy files from source to temp directory
        //$this->copyFiles($targetdir, $input[0]);
        $this->copyFiles($targetdir, $cal_copy_def);
 
        // zip
 
        // return zip file name
        $this->logger->debug('Returning new tempdirectory: ' . $targetdir);
 
        $out = new StringValue();
        $out->setValue($targetdir);
        return $out;
    }

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, $out, copyFiles(), createTargetDirectory(), createUniqueTempDirectory(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Field Documentation

◆ $irss

ILIAS ResourceStorage Services ilCalendarCopyFilesToTempDirectoryJob::$irss

private

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

◆ $logger

ilLogger ilCalendarCopyFilesToTempDirectoryJob::$logger

private

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

◆ $target_directory

string ilCalendarCopyFilesToTempDirectoryJob::$target_directory

protected

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

Referenced by createTargetDirectory().

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

components/ILIAS/Calendar/classes/BackgroundTasks/class.ilCalendarCopyFilesToTempDirectoryJob.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ copyFiles()

◆ copyWithAbsolutePath()

◆ copyWithRId()

◆ createTargetDirectory()

◆ createUniqueTempDirectory()

◆ getExpectedTimeOfTaskInSeconds()

◆ getInputTypes()

◆ getOutputType()

◆ isStateless()

◆ run()

Field Documentation

◆ $irss

◆ $logger

◆ $target_directory