ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Protected Attributes
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_lmlearning module

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

22 {
23 $this->lm = $a_lm;
24 }

Member Function Documentation

◆ clearMultiSrtDirectory()

ilLMMultiSrt::clearMultiSrtDirectory ( )

Clear multi feedback directory.

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

65 {
66 ilUtil::delDir($this->getMultiSrtUploadDir());
67 }
ilLMMultiSrt\getMultiSrtUploadDir
getMultiSrtUploadDir()
Get directory for multi srt upload.
Definition: class.ilLMMultiSrt.php:31
ilUtil\delDir
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
Definition: class.ilUtil.php:2553

References ilUtil\delDir(), and 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.

73 {
74 $items = array();
75
76 include_once("./Services/MetaData/classes/class.ilMDLanguageItem.php");
77 $lang_codes = ilMDLanguageItem::_getPossibleLanguageCodes();
78
79 $dir = $this->getMultiSrtUploadDir();
80 $files = ilUtil::getDir($dir);
81 foreach ($files as $k => $i)
82 {
83 // check directory
84 if ($i["type"] == "file" && !in_array($k, array(".", "..")))
85 {
86 if (pathinfo($k, PATHINFO_EXTENSION) == "srt")
87 {
88 $lang = "";
89 if (substr($k, strlen($k) - 7, 1) == "_")
90 {
91 $lang = substr($k, strlen($k) - 6, 2);
92 if (!in_array($lang, $lang_codes))
93 {
94 $lang = "";
95 }
96 }
97 $items[] = array("filename" => $k, "lang" => $lang);
98 }
99 }
100 }
101
102 // add mob information to items
103 // all pages
104 include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
105 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
106 $pages = ilLMPageObject::getPageList($this->lm->getId());
107 $mobs = array();
108 foreach ($pages as $page)
109 {
110 // all media objects
111 $pg_mobs = ilObjMediaObject::_getMobsOfObject("lm:pg", $page["obj_id"], 0, "");
112 foreach ($pg_mobs as $k => $pg_mob)
113 {
114 $mobs[$k] = $pg_mob;
115 }
116 }
117 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
118 foreach ($mobs as $mob)
119 {
120 $m = new ilObjMediaObject($mob);
121 $mi = $m->getMediaItem("Standard");
122 if ($mi->getLocationType() == "LocalFile" && is_int(strpos($mi->getFormat(), "video")))
123 {
124 // $loc is e.g. "echo-hereweare.mp4", we not look for
125 // "echo-hereweare_<langcode>.srt" files
126 $loc = pathinfo($mi->getLocation(), PATHINFO_FILENAME);
127 foreach ($items as $i => $item)
128 {
129 if (substr($item["filename"], 0, strlen($loc)) == $loc &&
130 substr($item["filename"], strlen($loc), 1) == "_" &&
131 pathinfo($item["filename"], PATHINFO_EXTENSION) == "srt")
132 {
133 $l = substr($item["filename"], strlen($loc)+1, 2);
134 if (in_array($l, $lang_codes))
135 {
136 $items[$i]["lang"] = $l;
137 $items[$i]["mob"] = $mob;
138 $items[$i]["mob_title"] = $m->getTitle();
139 }
140 }
141 }
142 }
143
144 }
145
146 return $items;
147 }
$l
global $l
Definition: afr.php:30
ilLMPageObject\getPageList
getPageList($lm_id)
static
Definition: class.ilLMPageObject.php:385
ilObjMediaObject
Class ilObjMediaObject.
Definition: class.ilObjMediaObject.php:27
ilObjMediaObject\_getMobsOfObject
_getMobsOfObject($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
get mobs of object
Definition: class.ilObjMediaObject.php:1054
ilUtil\getDir
static getDir($a_dir, $a_rec=false, $a_sub_dir="")
get directory
Definition: class.ilUtil.php:2600
$lang
$lang
Definition: inc.setup_header.php:116
$mobs
$mobs
Definition: imagemanager.php:67

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

Referenced by moveMultiSrtFiles().

+ 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.

32 {
33 return ilUtil::getDataDir()."/lm_data".
34 "/lm_".$this->lm->getId()."/srt_tmp";
35 }
ilUtil\getDataDir
static getDataDir()
get data directory (outside webspace)
Definition: class.ilUtil.php:1658

References ilUtil\getDataDir().

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

+ 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.

153 {
154 $items = $this->getMultiSrtFiles();
155 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
156 $cnt = 0;
157 foreach ($items as $i)
158 {
159 if ($i["mob"] > 0 && $i["lang"] != "")
160 {
161 $mob = new ilObjMediaObject($i["mob"]);
162 $mob->uploadSrtFile($this->getMultiSrtUploadDir()."/".$i["filename"], $i["lang"], "rename");
163 $cnt++;
164 }
165 }
166 return $cnt;
167 }
ilLMMultiSrt\getMultiSrtFiles
getMultiSrtFiles()
Get all srt files of srt multi upload.
Definition: class.ilLMMultiSrt.php:72

References getMultiSrtFiles(), and getMultiSrtUploadDir().

+ Here is the call graph for this function:

◆ uploadMultipleSubtitleFile()

ilLMMultiSrt::uploadMultipleSubtitleFile (   $a_file)

Upload multi srt file.

Parameters
array$a_filefile info array
Exceptions
ilLMException

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

45 {
46 global $lng, $ilUser;
47
48 include_once("./Modules/LearningModule/exceptions/class.ilLMException.php");
49 if (!is_file($a_file["tmp_name"]))
50 {
51 throw new ilLMException($lng->txt("cont_srt_zip_file_could_not_be_uploaded"));
52 }
53
54 $dir = $this->getMultiSrtUploadDir();
55 ilUtil::delDir($dir, true);
56 ilUtil::makeDirParents($dir);
57 ilUtil::moveUploadedFile($a_file["tmp_name"], "multi_srt.zip", $dir."/"."multi_srt.zip");
58 ilUtil::unzip($dir."/multi_srt.zip", true);
59 }
ilLMException
Base exception class for learning modules.
Definition: class.ilLMException.php:14
ilUtil\moveUploadedFile
static moveUploadedFile($a_file, $a_name, $a_target, $a_raise_errors=true, $a_mode="move_uploaded")
move uploaded file
Definition: class.ilUtil.php:4158
ilUtil\unzip
static unzip($a_file, $overwrite=false, $a_flat=false)
unzip file
Definition: class.ilUtil.php:1755
ilUtil\makeDirParents
static makeDirParents($a_dir)
Create a new directory and all parent directories.
Definition: class.ilUtil.php:2482
$lng
global $lng
Definition: privfeed.php:40
$ilUser
global $ilUser
Definition: imgupload.php:15

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

+ 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: