ilMobMultiSrtUpload Class Reference

Handler class for multi srt upload. More...

Collaboration diagram for ilMobMultiSrtUpload:

Public Member Functions
	__construct (ilMobMultiSrtInt $a_multi_srt)
	getMultiSrtUploadDir ()
	Get directory for multi srt upload. More...
	uploadMultipleSubtitleFile (array $a_file)
	Upload multi srt file. More...
	clearMultiSrtDirectory ()
	Clear multi feedback directory. More...
	getMultiSrtFiles ()
	Get all srt files of srt multi upload. More...
	moveMultiSrtFiles ()
	Move all srt files that could be mapped to media objects. More...

Protected Attributes
ZipAdapter	$zip
ilMobMultiSrtInt	$multi_srt
ilLanguage	$lng
MetadataManager	$md

Detailed Description

Handler class for multi srt upload.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilMobMultiSrtUpload::__construct

(

ilMobMultiSrtInt

$a_multi_srt

)

Parameters

ilMobMultiSrtInt

$a_multi_srt

adapter implementation

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

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

      {
        global $DIC;

        $lng = $DIC->language();
        $this->zip = $DIC->mediaObjects()->internal()->domain()->resources()->zip();
        $this->md = $DIC->mediaObjects()->internal()->domain()->metadata();

        $this->lng = $lng;
        $this->multi_srt = $a_multi_srt;
    }

Here is the call graph for this function:

Member Function Documentation

clearMultiSrtDirectory()

ilMobMultiSrtUpload::clearMultiSrtDirectory

(

)

Clear multi feedback directory.

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

References ilFileUtils\delDir(), and getMultiSrtUploadDir().

                                            : void
    {
        ilFileUtils::delDir($this->getMultiSrtUploadDir());
    }

Here is the call graph for this function:

getMultiSrtFiles()

ilMobMultiSrtUpload::getMultiSrtFiles

(

)

Get all srt files of srt multi upload.

Definition at line 91 of file class.ilMobMultiSrtUpload.php.

References ilFileUtils\getDir(), and getMultiSrtUploadDir().

Referenced by moveMultiSrtFiles().

                                      : array
    {
        $items = array();

        $lang_codes = $this->md->getLOMLanguageCodes();

        $dir = $this->getMultiSrtUploadDir();
        $files = ilFileUtils::getDir($dir);
        foreach ($files as $k => $i) {
            // check directory
            if ($i["type"] == "file" && !in_array($k, array(".", ".."))) {
                if (pathinfo($k, PATHINFO_EXTENSION) == "vtt") {
                    $lang = "";
                    if (substr($k, strlen($k) - 7, 1) == "_") {
                        $lang = substr($k, strlen($k) - 6, 2);
                        if (!in_array($lang, $lang_codes)) {
                            $lang = "";
                        }
                    }
                    $items[] = array("filename" => $k, "lang" => $lang);
                }
            }
        }

        foreach ($this->multi_srt->getMobIds() as $mob) {
            $m = new ilObjMediaObject($mob);
            $mi = $m->getMediaItem("Standard");
            if ($mi->getLocationType() == "LocalFile" && is_int(strpos($mi->getFormat(), "video"))) {
                // $loc is e.g. "echo-hereweare.mp4", we not look for
                // "echo-hereweare_<langcode>.srt" files
                $loc = pathinfo($mi->getLocation(), PATHINFO_FILENAME);
                foreach ($items as $i => $item) {
                    if (substr($item["filename"], 0, strlen($loc)) == $loc &&
                        substr($item["filename"], strlen($loc), 1) == "_" &&
                        pathinfo($item["filename"], PATHINFO_EXTENSION) == "vtt") {
                        $l = substr($item["filename"], strlen($loc) + 1, 2);
                        if (in_array($l, $lang_codes)) {
                            $items[$i]["lang"] = $l;
                            $items[$i]["mob"] = $mob;
                            $items[$i]["mob_title"] = $m->getTitle();
                        }
                    }
                }
            }
        }

        return $items;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMultiSrtUploadDir()

ilMobMultiSrtUpload::getMultiSrtUploadDir

(

)

Get directory for multi srt upload.

Definition at line 53 of file class.ilMobMultiSrtUpload.php.

Referenced by clearMultiSrtDirectory(), getMultiSrtFiles(), moveMultiSrtFiles(), and uploadMultipleSubtitleFile().

                                          : string
    {
        return $this->multi_srt->getUploadDir();
    }

Here is the caller graph for this function:

moveMultiSrtFiles()

ilMobMultiSrtUpload::moveMultiSrtFiles

(

)

Move all srt files that could be mapped to media objects.

Definition at line 143 of file class.ilMobMultiSrtUpload.php.

References getMultiSrtFiles(), and getMultiSrtUploadDir().

                                       : int
    {
        $items = $this->getMultiSrtFiles();
        $cnt = 0;
        foreach ($items as $i) {
            if ($i["mob"] > 0 && $i["lang"] != "") {
                $mob = new ilObjMediaObject($i["mob"]);
                $mob->uploadSrtFile($this->getMultiSrtUploadDir() . "/" . $i["filename"], $i["lang"], "rename");
                $cnt++;
            }
        }
        return $cnt;
    }

Here is the call graph for this function:

uploadMultipleSubtitleFile()

ilMobMultiSrtUpload::uploadMultipleSubtitleFile

(

array

$a_file

)

Upload multi srt file.

Parameters

array

$a_file

file info array

Exceptions

ilException
ilMobSrtUploadException

Definition at line 66 of file class.ilMobMultiSrtUpload.php.

References ilFileUtils\delDir(), getMultiSrtUploadDir(), ILIAS\Repository\lng(), ilFileUtils\makeDirParents(), and ilFileUtils\moveUploadedFile().

     : void {
        if (!is_file($a_file["tmp_name"])) {
            throw new ilMobSrtUploadException($this->lng->txt("cont_srt_zip_file_could_not_be_uploaded"));
        }

        $dir = $this->getMultiSrtUploadDir();
        ilFileUtils::delDir($dir, true);
        ilFileUtils::makeDirParents($dir);
        ilFileUtils::moveUploadedFile($a_file["tmp_name"], "multi_vtt.zip", $dir . "/" . "multi_vtt.zip");
        $this->zip->unzipFile($dir . "/multi_vtt.zip");
    }

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilMobMultiSrtUpload::$lng

protected

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

Referenced by __construct().

$md

MetadataManager ilMobMultiSrtUpload::$md

protected

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

$multi_srt

ilMobMultiSrtInt ilMobMultiSrtUpload::$multi_srt

protected

Definition at line 30 of file class.ilMobMultiSrtUpload.php.

$zip

ZipAdapter ilMobMultiSrtUpload::$zip

protected

Definition at line 29 of file class.ilMobMultiSrtUpload.php.

---

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

• components/ILIAS/MediaObjects/SubTitles/class.ilMobMultiSrtUpload.php