ilDownloadFilesBackgroundTask Class Reference

Description of class class. More...

Collaboration diagram for ilDownloadFilesBackgroundTask:

Public Member Functions
	__construct ($a_usr_id)
	ilDownloadFilesBackgroundTask constructor. More...
	setEvents (array $a_events)
	getEvents ()
	setBucketTitle (string $a_title)
	getBucketTitle ()
	run ()

Protected Attributes
ilLanguage	$lng
ilObjUser	$user
TaskFactory	$task_factory

Private Member Functions
	collectFiles (ilCalendarRessourceStorageCopyDefinition $def)

Private Attributes
ilLogger	$logger
int	$user_id
array	$events = []
string	$bucket_title
bool	$has_files = false
ilGlobalTemplateInterface	$main_tpl

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 29 of file class.ilDownloadFilesBackgroundTask.php.

Constructor & Destructor Documentation

__construct()

ilDownloadFilesBackgroundTask::__construct

(

$a_usr_id

)

ilDownloadFilesBackgroundTask constructor.

Parameters

$a_usr_id

Exceptions

ilDatabaseException

| DomainException

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

References $DIC, $user, ilObjectFactory\getInstanceByObjId(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\Repository\user().

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();

        $this->logger = $DIC->logger()->cal();
        $this->user_id = $a_usr_id;
        $this->task_factory = $DIC->backgroundTasks()->taskFactory();
        $this->lng = $DIC->language();

        $user = ilObjectFactory::getInstanceByObjId($a_usr_id, false);
        if (!$user instanceof ilObjUser) {
            throw new DomainException('Invalid or deleted user id given: ' . $this->user_id);
        }
        $this->user = $user;
    }

Here is the call graph for this function:

Member Function Documentation

collectFiles()

ilDownloadFilesBackgroundTask::collectFiles ( ilCalendarRessourceStorageCopyDefinition  $def )

private

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

References ilCalendarRessourceStorageCopyDefinition\addCopyDefinition(), ilCalendarRessourceStorageCopyDefinition\addCopyDefinitionRId(), ilFileUtils\getASCIIFilename(), getEvents(), ilAppointmentFileHandlerFactory\getInstance(), ilCalendarCategory\getInstanceByCategoryId(), IL_CAL_FKT_DATE, IL_CAL_UNIX, ILIAS\Repository\logger(), ilCalendarCategory\TYPE_OBJ, and ILIAS\Repository\user().

Referenced by run().

                                                                                : void
    {
        //filter here the objects, don't repeat the object Id
        $object_ids = [];
        foreach ($this->getEvents() as $event) {
            $start = new ilDateTime($event['dstart'], IL_CAL_UNIX);
            $cat = ilCalendarCategory::getInstanceByCategoryId($event['category_id']);
            $obj_id = $cat->getObjId();

            $this->logger->debug('Handling event: ' . $event['event']->getPresentationTitle());
            //22295 If the object type is exc then we need all the assignments.Otherwise we will get only one.
            if (
                $cat->getType() != \ilCalendarCategory::TYPE_OBJ ||
                $cat->getObjType() == 'exc' ||
                !in_array($obj_id, $object_ids)
            ) {
                $this->logger->debug('New obj_id..');
                $object_ids[] = $obj_id;

                $folder_date = $start->get(IL_CAL_FKT_DATE, 'Y-m-d', $this->user->getTimeZone());

                if ($event['fullday']) {
                    $folder_app = ilFileUtils::getASCIIFilename($event['event']->getPresentationTitle(false));   //title formalized
                } else {
                    $start_time = $start->get(IL_CAL_FKT_DATE, 'H.i', $this->user->getTimeZone());

                    $end = new ilDateTime($event['dend'], IL_CAL_UNIX);
                    $end_time = $end->get(IL_CAL_FKT_DATE, 'H.i', $this->user->getTimeZone());

                    if ($start_time != $end_time) {
                        $start_time .= (' - ' . $end_time);
                    }
                    $folder_app = $start_time . ' ' .
                        ilFileUtils::getASCIIFilename($event['event']->getPresentationTitle(false));   //title formalized
                }

                $this->logger->debug("collecting files...event title = " . $folder_app);
                $file_handler = ilAppointmentFileHandlerFactory::getInstance($event);
                $this->logger->debug('Current file handler: ' . get_class($file_handler));

                if ($files = $file_handler->getFiles()) {
                    $this->has_files = true;
                }

                $this->logger->dump($files);
                foreach ($files as $idx => $file_property) {
                    $this->logger->debug('Filename:' . $file_property->getFileName());
                    $ressource = '';
                    $target = $folder_date . '/' . $folder_app . '/' . $file_property->getFileName();
                    if (!is_null($file_property->getFileRId())) {
                        $this->logger->debug('Ressource Id: ' . $file_property->getFileRId());
                        $ressource = $file_property->getFileRId();
                        $def->addCopyDefinitionRId($file_property->getFileRId(), $target);
                    } else {
                        $this->logger->debug('Absolute Path: ' . $file_property->getAbsolutePath());
                        $ressource = $file_property->getAbsolutePath();
                        $def->addCopyDefinition($file_property->getAbsolutePath(), $target);
                    }
                    $this->logger->debug(
                        'Added new copy definition: ' .
                        $folder_date . '/' . $folder_app . '/' . $file_property->getFileName() . ' => ' .
                        $ressource
                    );
                }
            } else {
                $this->logger->info('Ignoring obj_id: ' . $obj_id . ' already processed.');
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBucketTitle()

ilDownloadFilesBackgroundTask::getBucketTitle

(

)

Returns

string

Todo:

see comments

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

References $bucket_title.

Referenced by run().

                                    : string
    {
        //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:

getEvents()

ilDownloadFilesBackgroundTask::getEvents

(

)

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

References $events.

Referenced by collectFiles().

                               : array
    {
        return $this->events;
    }

Here is the caller graph for this function:

run()

ilDownloadFilesBackgroundTask::run

(

)

Definition at line 94 of file class.ilDownloadFilesBackgroundTask.php.

References $GLOBALS, collectFiles(), ilFileUtils\getASCIIFilename(), getBucketTitle(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

                         : bool
    {
        $definition = new ilCalendarRessourceStorageCopyDefinition();
        $normalized_name = ilFileUtils::getASCIIFilename($this->getBucketTitle());
        $definition->setTempDir($normalized_name);

        $this->collectFiles($definition);

        if (!$this->has_files) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt("cal_down_no_files"), true);
            return false;
        }

        $bucket = new BasicBucket();
        $bucket->setUserId($this->user_id);

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

        $download_name = new StringValue();

        $this->logger->debug("Normalized name = " . $normalized_name);
        $download_name->setValue($normalized_name . '.zip');

        $download_interaction = $this->task_factory->createTask(
            ilCalendarDownloadZipInteraction::class,
            [$zip_job, $download_name]
        );

        // last task to bucket
        $bucket->setTask($download_interaction);

        $bucket->setTitle($this->getBucketTitle());

        $task_manager = $GLOBALS['DIC']->backgroundTasks()->taskManager();
        $task_manager->run($bucket);
        return true;
    }

Here is the call graph for this function:

setBucketTitle()

ilDownloadFilesBackgroundTask::setBucketTitle

(

string

$a_title

)

Definition at line 74 of file class.ilDownloadFilesBackgroundTask.php.

Referenced by ilCalendarViewGUI\downloadFiles(), and ilAppointmentPresentationGUI\downloadFiles().

                                                   : void
    {
        $this->bucket_title = $a_title;
    }

Here is the caller graph for this function:

setEvents()

ilDownloadFilesBackgroundTask::setEvents

(

array

$a_events

)

Definition at line 64 of file class.ilDownloadFilesBackgroundTask.php.

                                              : void
    {
        $this->events = $a_events;
    }

Field Documentation

$bucket_title

string ilDownloadFilesBackgroundTask::$bucket_title

private

Definition at line 38 of file class.ilDownloadFilesBackgroundTask.php.

Referenced by getBucketTitle().

$events

array ilDownloadFilesBackgroundTask::$events = []

private

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

Referenced by getEvents().

$has_files

bool ilDownloadFilesBackgroundTask::$has_files = false

private

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

$lng

ilLanguage ilDownloadFilesBackgroundTask::$lng

protected

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

$logger

ilLogger ilDownloadFilesBackgroundTask::$logger

private

Definition at line 31 of file class.ilDownloadFilesBackgroundTask.php.

$main_tpl

ilGlobalTemplateInterface ilDownloadFilesBackgroundTask::$main_tpl

private

Definition at line 40 of file class.ilDownloadFilesBackgroundTask.php.

$task_factory

TaskFactory ilDownloadFilesBackgroundTask::$task_factory

protected

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

$user

ilObjUser ilDownloadFilesBackgroundTask::$user

protected

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

Referenced by __construct().

$user_id

int ilDownloadFilesBackgroundTask::$user_id

private

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

---

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

• components/ILIAS/Calendar/classes/BackgroundTasks/class.ilDownloadFilesBackgroundTask.php