ilLMMultiSrt Class Reference

Handler class for multi srt upload in learning modules. More...

Collaboration diagram for ilLMMultiSrt:

Public Member Functions
	__construct (ilObjLearningModule $a_lm)
	Construcotr. More...
	getMultiSrtUploadDir ()
	Get directory for multi srt upload. More...
	uploadMultipleSubtitleFile ($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
	$lm

Detailed Description

Handler class for multi srt upload in learning modules.

Author

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

Version

$Id$

Definition at line 12 of file class.ilLMMultiSrt.php.

Constructor & Destructor Documentation

__construct()

ilLMMultiSrt::__construct

(

ilObjLearningModule

$a_lm

)

Construcotr.

Parameters

ilObjLearningModule

$a_lm

learning module

Definition at line 21 of file class.ilLMMultiSrt.php.

        {
                $this->lm = $a_lm;
        }

Member Function Documentation

clearMultiSrtDirectory()

ilLMMultiSrt::clearMultiSrtDirectory

(

)

Clear multi feedback directory.

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

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

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

Here is the call graph for this function:

getMultiSrtFiles()

ilLMMultiSrt::getMultiSrtFiles

(

)

Get all srt files of srt multi upload.

Definition at line 72 of file class.ilLMMultiSrt.php.

References $files, $l, $lang, $mobs, ilObjMediaObject\_getMobsOfObject(), ilMDLanguageItem\_getPossibleLanguageCodes(), array, ilUtil\getDir(), getMultiSrtUploadDir(), and ilLMPageObject\getPageList().

Referenced by moveMultiSrtFiles().

        {
                $items = array();

                include_once("./Services/MetaData/classes/class.ilMDLanguageItem.php");
                $lang_codes = ilMDLanguageItem::_getPossibleLanguageCodes();

                $dir = $this->getMultiSrtUploadDir();
                $files = ilUtil::getDir($dir);
                foreach ($files as $k => $i)
                {
                        // check directory
                        if ($i["type"] == "file" && !in_array($k, array(".", "..")))
                        {
                                if (pathinfo($k, PATHINFO_EXTENSION) == "srt")
                                {
                                        $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);
                                }
                        }
                }

                // add mob information to items
                // all pages
                include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $pages = ilLMPageObject::getPageList($this->lm->getId());
                $mobs = array();
                foreach ($pages as $page)
                {
                        // all media objects
                        $pg_mobs = ilObjMediaObject::_getMobsOfObject("lm:pg", $page["obj_id"], 0, "");
                        foreach ($pg_mobs as $k => $pg_mob)
                        {
                                $mobs[$k] = $pg_mob;
                        }
                }
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                foreach ($mobs 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) == "srt")
                                        {
                                                $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()

ilLMMultiSrt::getMultiSrtUploadDir

(

)

Get directory for multi srt upload.

Returns

string diretory

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

References ilUtil\getDataDir().

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

        {
                return ilUtil::getDataDir()."/lm_data".
                        "/lm_".$this->lm->getId()."/srt_tmp";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

moveMultiSrtFiles()

ilLMMultiSrt::moveMultiSrtFiles

(

)

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

Definition at line 152 of file class.ilLMMultiSrt.php.

References getMultiSrtFiles(), and getMultiSrtUploadDir().

        {
                $items = $this->getMultiSrtFiles();
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $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()

ilLMMultiSrt::uploadMultipleSubtitleFile

(

$a_file

)

Upload multi srt file.

Parameters

array

$a_file

file info array

Exceptions

ilLMException

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

References $ilUser, $lng, ilUtil\delDir(), getMultiSrtUploadDir(), ilUtil\makeDirParents(), ilUtil\moveUploadedFile(), and ilUtil\unzip().

        {
                global $lng, $ilUser;

                include_once("./Modules/LearningModule/exceptions/class.ilLMException.php");
                if (!is_file($a_file["tmp_name"]))
                {
                        throw new ilLMException($lng->txt("cont_srt_zip_file_could_not_be_uploaded"));
                }

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

Here is the call graph for this function:

Field Documentation

$lm

ilLMMultiSrt::$lm

protected

Definition at line 14 of file class.ilLMMultiSrt.php.

---

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

• Modules/LearningModule/classes/class.ilLMMultiSrt.php