Collect files for downloading all media items. More...

Inheritance diagram for ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob:

Collaboration diagram for ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob:

Public Member Functions
	__construct ()

	getInputTypes ()

	getOutputType ()

	isStateless ()

	getExpectedTimeOfTaskInSeconds ()

	run (array $input, Observer $observer)

	collectMediaFiles (string $target_dir)

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns array returns the input array 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...

Protected Member Functions
	createDirectory ()

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

	extractType ($value)

Protected Attributes
int	$user_id = 0

int	$mcst_id = 0

int	$mcst_ref_id = 0

ilLanguage	$lng

string	$target_directory = ""

string	$temp_dir = ""

string	$sanitized_title = ""

ilObjMediaCast	$media_cast

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

Value	$output

Private Attributes
ilLogger	$logger = null

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

Collect files for downloading all media items.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 32 of file DownloadAllCollectFilesJob.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::__construct ( )

Definition at line 44 of file DownloadAllCollectFilesJob.php.

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

     {
         global $DIC;
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('mcst');
         $this->logger = $DIC->logger()->mcst();
 
         $this->sanitized_title = "images";
     }

Here is the call graph for this function:

Member Function Documentation

◆ collectMediaFiles()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::collectMediaFiles ( string $target_dir )

Definition at line 110 of file DownloadAllCollectFilesJob.php.

References Vendor\Package\$e.

Referenced by ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\run().

                                                          : void
     {
         $cnt = 0;
         foreach ($this->media_cast->getSortedItemsArray() as $item) {
             $mob = new \ilObjMediaObject($item["mob_id"]);
             $med = $mob->getMediaItem("Standard");
 
             $cnt++;
             $str_cnt = str_pad($cnt, 4, "0", STR_PAD_LEFT);
 
             if ($med->getLocationType() === "Reference") {
                 $resource = $med->getLocation();
                 copy($resource, $target_dir . DIRECTORY_SEPARATOR . $str_cnt . basename($resource));
             } else {
                 try {   // this skips broken objects
                     $stream = $med->getLocationStream();
                     file_put_contents(
                         $target_dir . DIRECTORY_SEPARATOR . $str_cnt . $med->getLocation(),
                         $stream->getContents()
                     );
                 } catch (\Exception $e) {
                 }
             }
         }
     }

Here is the caller graph for this function:

◆ createDirectory()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::createDirectory ( )

protected

Definition at line 97 of file DownloadAllCollectFilesJob.php.

References $path, ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\$sanitized_title, ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\$target_directory, ilFileUtils\ilTempnam(), and ilFileUtils\makeDirParents().

Referenced by ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\run().

                                         : string
     {
         // temp dir
         $this->temp_dir = \ilFileUtils::ilTempnam();
 
         // target dir
         $path = $this->temp_dir . DIRECTORY_SEPARATOR;
         $this->target_directory = $path . $this->sanitized_title;
         \ilFileUtils::makeDirParents($this->target_directory);
 
         return $this->target_directory;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExpectedTimeOfTaskInSeconds()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::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 73 of file DownloadAllCollectFilesJob.php.

◆ getInputTypes()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::getInputTypes ( )

Returns: Type[] A list of types that are taken as input.

Implements ILIAS\BackgroundTasks\Task.

Definition at line 54 of file DownloadAllCollectFilesJob.php.

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

◆ getOutputType()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::getOutputType ( )

Implements ILIAS\BackgroundTasks\Task.

Definition at line 63 of file DownloadAllCollectFilesJob.php.

                                    : \ILIAS\BackgroundTasks\Types\Type
     {
         return new SingleType(StringValue::class);
     }

◆ isStateless()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::isStateless ( )

Returns: bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached!

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 68 of file DownloadAllCollectFilesJob.php.

                                  : bool
     {
         return true;
     }

◆ run()

ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob::run	(	array	$input,
		Observer	$observer
	)

Parameters

	Value[]	$input This will be a list of Values hinted by getInputTypes.
Observer	$observer	Notify the bucket about your progress!

Returns: Value The returned Value must be of the type hinted by getOutputType.

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 78 of file DownloadAllCollectFilesJob.php.

References $out, ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\collectMediaFiles(), ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\createDirectory(), ILIAS\BackgroundTasks\Implementation\Values\ScalarValues\ScalarValue\getValue(), and ILIAS\Repository\logger().

                                                          : StringValue
     {
         $this->user_id = $input[0]->getValue();
         $this->mcst_ref_id = $input[1]->getValue();
 
         $this->logger->debug("Get Mediacast " . $this->mcst_ref_id);
         $this->media_cast = new \ilObjMediaCast($this->mcst_ref_id);
 
         $target_dir = $this->createDirectory();
 
         $this->logger->debug("Collect in " . $target_dir);
         $this->collectMediaFiles($target_dir);
         $this->logger->debug("Finished collecting.");
 
         $out = new StringValue();
         $out->setValue($target_dir);
         return $out;
     }