ilObjLanguageFolder Class Reference
Class ilObjLanguageFolder contains all function to manage language support for ILIAS3 install, uninstall, checkfiles .... More...
Inheritance diagram for ilObjLanguageFolder:
Collaboration diagram for ilObjLanguageFolder:
Public Member Functions | |
| __construct (int $a_id, bool $a_call_by_reference=true) | |
| Constructor $a_id reference_id or object_id $a_call_by_reference treat the id as reference_id (true) or object_id (false) More... | |
| getLanguages () | |
| gather all information about available languages More... | |
| addNewLanguages (array $a_languages) | |
| add new languages More... | |
| removeLanguages (array $a_languages) | |
| remove languages which are not installed AND has no lang-file More... | |
| checkAllLanguages () | |
| validate the logical structure of a lang-file More... | |
| Public Member Functions inherited from ilObject | |
| getObjectProperties () | |
| flushObjectProperties () | |
| withReferences () | |
| determines whether objects are referenced or not (got ref ids or not) More... | |
| processAutoRating () | |
| read () | |
| getId () | |
| setId (int $id) | |
| setRefId (int $ref_id) | |
| getRefId () | |
| getType () | |
| setType (string $type) | |
| getPresentationTitle () | |
| get presentation title Normally same as title Overwritten for sessions More... | |
| getTitle () | |
| getUntranslatedTitle () | |
| Get untranslated object title WebDAV needs to access the untranslated title of an object. More... | |
| setTitle (string $title) | |
| getDescription () | |
| setDescription (string $description) | |
| getLongDescription () | |
| get object long description (stored in object_description) More... | |
| getImportId () | |
| setImportId (string $import_id) | |
| setOfflineStatus (bool $status) | |
| getOfflineStatus () | |
| supportsOfflineHandling () | |
| getOwner () | |
| getOwnerName () | |
| get full name of object owner More... | |
| setOwner (int $usr_id) | |
| getCreateDate () | |
| Get create date in YYYY-MM-DD HH-MM-SS format. More... | |
| getLastUpdateDate () | |
| Get last update date in YYYY-MM-DD HH-MM-SS format. More... | |
| create () | |
| note: title, description and type should be set when this function is called More... | |
| update () | |
| MDUpdateListener (string $element) | |
| Metadata update listener. More... | |
| createMetaData () | |
| updateMetaData () | |
| deleteMetaData () | |
| updateOwner () | |
| update owner of object in db More... | |
| putInTree (int $parent_ref_id) | |
| maybe this method should be in tree object!? More... | |
| setPermissions (int $parent_ref_id) | |
| setParentRolePermissions (int $parent_ref_id) | |
| Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More... | |
| createReference () | |
| creates reference for object More... | |
| countReferences () | |
| delete () | |
| delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More... | |
| initDefaultRoles () | |
| init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More... | |
| applyDidacticTemplate (int $tpl_id) | |
| getXMLZip () | |
| getHTMLDirectory () | |
| appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id) | |
| Prepend Copy info if object with same name exists in that container. More... | |
| cloneDependencies (int $target_id, int $copy_id) | |
| Clone object dependencies. More... | |
| cloneMetaData (ilObject $target_obj) | |
| Copy meta data. More... | |
| selfOrParentWithRatingEnabled () | |
| getPossibleSubObjects (bool $filter=true) | |
| get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More... | |
Data Fields | |
| string | $lang_default |
| indicator for the system language this language must not be deleted More... | |
| string | $lang_user |
| language that is in use by current user this language must not be deleted More... | |
| string | $lang_path |
| path to language files relative path is taken from ini file and added to absolute path of ilias More... | |
| string | $separator |
| separator value between module,identivier & value More... | |
| array | $languages |
| contians all informations about languages More... | |
| Data Fields inherited from ilObject | |
| const | TITLE_LENGTH = 255 |
| const | DESC_LENGTH = 128 |
| const | LONG_DESC_LENGTH = 4000 |
| const | TABLE_OBJECT_DATA = "object_data" |
| array | $objectList |
| string | $untranslatedTitle |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilObject | |
| static | _lookupObjIdByImportId (string $import_id) |
| Get (latest) object id for an import id. More... | |
| static | _lookupImportId (int $obj_id) |
| static | _lookupOwnerName (int $owner_id) |
| Lookup owner name for owner id. More... | |
| static | _getIdForImportId (string $import_id) |
| static | _getAllReferences (int $id) |
| get all reference ids for object ID More... | |
| static | _lookupTitle (int $obj_id) |
| static | lookupOfflineStatus (int $obj_id) |
| Lookup offline status using objectDataCache. More... | |
| static | _lookupOwner (int $obj_id) |
| Lookup owner user ID for object ID. More... | |
| static | _getIdsForTitle (string $title, string $type='', bool $partial_match=false) |
| static | _lookupDescription (int $obj_id) |
| static | _lookupLastUpdate (int $obj_id, bool $formatted=false) |
| static | _getLastUpdateOfObjects (array $obj_ids) |
| static | _lookupObjId (int $ref_id) |
| static | _setDeletedDate (int $ref_id, int $deleted_by) |
| static | setDeletedDates (array $ref_ids, int $user_id) |
| static | _resetDeletedDate (int $ref_id) |
| static | _lookupDeletedDate (int $ref_id) |
| static | _writeTitle (int $obj_id, string $title) |
| write title to db (static) More... | |
| static | _writeDescription (int $obj_id, string $desc) |
| write description to db (static) More... | |
| static | _writeImportId (int $obj_id, string $import_id) |
| write import id to db (static) More... | |
| static | _lookupType (int $id, bool $reference=false) |
| static | _isInTrash (int $ref_id) |
| static | _hasUntrashedReference (int $obj_id) |
| checks whether an object has at least one reference that is not in trash More... | |
| static | _lookupObjectId (int $ref_id) |
| static | _getObjectsDataForType (string $type, bool $omit_trash=false) |
| get all objects of a certain type More... | |
| static | _exists (int $id, bool $reference=false, ?string $type=null) |
| checks if an object exists in object_data More... | |
| static | _getObjectsByType (string $obj_type="", ?int $owner=null) |
| static | _prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true) |
| Prepare copy wizard object selection. More... | |
| static | getIconForType (string $type) |
| static | _getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false) |
| Get icon for repository item. More... | |
| static | collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0) |
| Collect deletion dependencies. More... | |
| static | getDeletionDependencies (int $obj_id) |
| Get deletion dependencies. More... | |
| static | getLongDescriptions (array $obj_ids) |
| static | getAllOwnedRepositoryObjects (int $user_id) |
| static | fixMissingTitles ($type, array &$obj_title_map) |
| Try to fix missing object titles. More... | |
| static | _lookupCreationDate (int $obj_id) |
| static | _getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null) |
| Protected Member Functions inherited from ilObject | |
| doMDUpdateListener (string $a_element) | |
| beforeMDUpdateListener (string $a_element) | |
| doCreateMetaData () | |
| beforeCreateMetaData () | |
| doUpdateMetaData () | |
| beforeUpdateMetaData () | |
| doDeleteMetaData () | |
| beforeDeleteMetaData () | |
| handleAutoRating () | |
| hasAutoRating () | |
| Protected Attributes inherited from ilObject | |
| ilLogger | $obj_log |
| ILIAS | $ilias |
| ilObjectDefinition | $obj_definition |
| ilDBInterface | $db |
| ilLogger | $log |
| ilErrorHandling | $error |
| ilTree | $tree |
| ilAppEventHandler | $app_event_handler |
| ilRbacAdmin | $rbac_admin |
| ilRbacReview | $rbac_review |
| ilObjUser | $user |
| ilLanguage | $lng |
| LOMServices | $lom_services |
| bool | $call_by_reference |
| int | $max_title = self::TITLE_LENGTH |
| int | $max_desc = self::DESC_LENGTH |
| bool | $add_dots = true |
| int | $ref_id = null |
| string | $type = "" |
| string | $title = "" |
| string | $desc = "" |
| string | $long_desc = "" |
| int | $owner = 0 |
| string | $create_date = "" |
| string | $last_update = "" |
| string | $import_id = "" |
| bool | $register = false |
Detailed Description
Class ilObjLanguageFolder contains all function to manage language support for ILIAS3 install, uninstall, checkfiles ....
- Version
- $Id$
Definition at line 31 of file class.ilObjLanguageFolder.php.
Constructor & Destructor Documentation
◆ __construct()
| ilObjLanguageFolder::__construct | ( | int | $a_id, |
| bool | $a_call_by_reference = true |
||
| ) |
Constructor $a_id reference_id or object_id $a_call_by_reference treat the id as reference_id (true) or object_id (false)
Definition at line 68 of file class.ilObjLanguageFolder.php.
69 {
70 $this->type = "lngf";
71 parent::__construct($a_id, $a_call_by_reference);
72
73 $this->lang_path = $this->lng->lang_path;
74 $this->lang_default = $this->lng->lang_default;
75 $this->lang_user = $this->lng->lang_user;
76 $this->separator = $this->lng->separator;
77 }
References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().
Here is the call graph for this function:
Member Function Documentation
◆ addNewLanguages()
| ilObjLanguageFolder::addNewLanguages | ( | array | $a_languages | ) |
add new languages
This functions checks in $languages for languages with the attribute 'new' and insert these languages in db-table 'languages'
Definition at line 176 of file class.ilObjLanguageFolder.php.
176 : array
177 {
178 if (count($a_languages) > 0) {
179 foreach ($a_languages as $lang_key => $lang_data) {
180 if (isset($lang_data["info"]) && $lang_data["info"] === "new_language") {
182 $lngObj->setTitle($lang_key);
183 $lngObj->setDescription("not_installed");
184 $lngObj->create();
185
186 // must get OOP through the whole class some time
187 // (no arrays with db fields! this class doesn't know anything about table object!)
188 $a_languages[$lang_key] = array("obj_id" => $lngObj->getId(),
189 "type" => $lngObj->getType(),
190 "description" => $lngObj->getDescription(),
191 "desc" => $lngObj->getDescription(),
192 "owner" => $lngObj->getOwner(),
193 "create_date" => $lngObj->getCreateDate(),
194 "last_update" => $lngObj->getLastUpdateDate());
195
196 $a_languages[$lang_key]["info"] = "new_language";
197 unset($lngObj); // better: the objects should be resident in an member array of this class
198 }
199 }
200 }
201
202 return $a_languages;
203 }
Referenced by getLanguages().
Here is the caller graph for this function:
◆ checkAllLanguages()
| ilObjLanguageFolder::checkAllLanguages | ( | ) |
validate the logical structure of a lang-file
This function is similar to function checkLanguage() (see below) but checks for all lang-files and outputs more helpful information.
Return system message
Definition at line 239 of file class.ilObjLanguageFolder.php.
239 : string
240 {
241 // set path to directory where lang-files reside
242 $d = dir($this->lang_path);
243 $tmpPath = getcwd();
244 chdir($this->lang_path);
245
246 // for giving a message when no lang-file was found
247 $found = false;
248
249 $output = '';
250 // get available lang-files
252 if (is_file($entry) && (preg_match("~(^ilias_.{2}\.lang$)~", $entry))) {
253 // textmeldung, wenn langfile gefunden wurde
255 $content = file($entry);
256 $lines_full = count($content);
257 $found = true;
258 $error_param = false;
259 $error_double = false;
260 $double_checker = [];
261
263 $lines_cut = count($content);
264 foreach ($content as $key => $val) {
265 $separated = explode($this->separator, trim($val));
266 $num = count($separated);
267 $line = $key + $lines_full - $lines_cut + 1;
268
269 if ($num !== 3) {
270 $error_param = true;
271
273
274 switch ($num) {
275 case 1:
276 if (empty($separated[0])) {
278 } else {
281 }
282 break;
283
284 case 2:
288 break;
289
290 default:
294 $output .= "<br/>" . $this->lng->txt("err_over_3_param") . " " . $this->lng->txt("check_langfile");
295 break;
296 }
297 continue;
298 }
299 if ($double_checker[strtolower($separated[0])][strtolower($separated[1])] ?? false) {
300 $error_double = true;
301
302 $output .= "<br/><b/>" . $this->lng->txt("err_in_line") . " " . $double_checker[strtolower($separated[0])][strtolower($separated[1])] . " " . $this->lng->txt("and") . " " . $line . " !</b> ";
306 }
307 $double_checker[strtolower($separated[0])][strtolower($separated[1])] = $line;
308 }
309
310 if ($error_param || $error_double) {
311 $reason = "";
312 if ($error_param) {
314 }
315 if ($error_double) {
317 }
319 } else {
321 }
322 } else {
323 $output .= "<br/>" . $this->lng->txt("file_not_valid") . " " . $this->lng->txt("err_wrong_header");
324 }
325 }
326 }
327
328 $d->close();
329
330 if (!$found) {
332 }
333
334 chdir($tmpPath);
335 return $output;
336 }
static cut_header(array $content)
remove lang-file haeder information from '$content' This function seeks for a special keyword where t...
Definition: class.ilObjLanguage.php:639
References Vendor\Package\$d, ilObjLanguage\cut_header(), and ILIAS\Repository\lng().
Here is the call graph for this function:
◆ getLanguages()
| ilObjLanguageFolder::getLanguages | ( | ) |
gather all information about available languages
This function builds an array with the following structure: $languages[lang_key][long][installed][update][info]
lang_key: string international language key (2 digits, i.e. de,en,dk...) long: string full language name in the chosen user language installed: boolean is the language installed (true) or not (false)? update: int contains the timestamp of last db-modification info: string optional information. valid is: 'notfound','new'
Returns $languages status information about available languages
Definition at line 93 of file class.ilObjLanguageFolder.php.
93 : array
94 {
96
97 // set path to directory where lang-files reside
98 $d = dir($this->lang_path);
99 $tmpPath = getcwd();
100 chdir($this->lang_path);
101
102 $languages = [];
103
104 // get available lang-files
106 if (is_file($entry) && (preg_match("~(^ilias_.{2}\.lang$)~", $entry))) {
107 $lang_key = substr($entry, 6, 2);
109 }
110 }
111
112 $language = array();
113 $tmp_array = array_keys($languages);
114 $lang_keys = array();
115
116 // now get languages from database
119 // set values
122 $lang_keys[] = $lang_key;
123
126
127 // determine default language and language of current user
128 if ($lang_key === $this->lang_user) {
130 }
131
132 if ($lang_key === $this->lang_default) {
134 }
135
136 // check if files are missing
137 if (count($tmp_array) > 0 && !in_array($lang_key, $tmp_array, true)) {
139 }
140 }
141 }
142
143 // compute new languages
145 if (!in_array($lang_key, $lang_keys, true)) {
146 $languages[$lang_key] = array();
148 //$languages[$lang_key]["desc"] = "not_installed";
149 }
150 }
151
152 chdir($tmpPath);
153
154 // Insert languages with files new found into table language
156
157 // Remove from array & db languages which are not installed and no lang-files
159
160 // setting language's full names
163 }
164
165 $this->languages = $languages;
166
168 }
array $languages
contians all informations about languages
Definition: class.ilObjLanguageFolder.php:61
removeLanguages(array $a_languages)
remove languages which are not installed AND has no lang-file
Definition: class.ilObjLanguageFolder.php:213
static _getObjectsByType(string $obj_type="", ?int $owner=null)
Definition: class.ilObject.php:1490
References Vendor\Package\$d, $lang, $languages, ilObject\_getObjectsByType(), addNewLanguages(), ILIAS\Repository\lng(), and removeLanguages().
Here is the call graph for this function:
◆ removeLanguages()
| ilObjLanguageFolder::removeLanguages | ( | array | $a_languages | ) |
remove languages which are not installed AND has no lang-file
This function removes only the entry in db-table 'languages' and in the array $languages. Does not uninstall a language (see: function flushLanguage())
Return $languages updated status information about available languages
Definition at line 213 of file class.ilObjLanguageFolder.php.
213 : array
214 {
215 foreach ($a_languages as $lang_key => $lang_data) {
216 if ($lang_data["desc"] === "not_installed" && $lang_data["info"] === "file_not_found") {
217 // update languages array
218 unset($a_languages[$lang_key]);
219
220 // update object_data table
221 $query = "DELETE FROM object_data " .
222 "WHERE type = " . $this->db->quote("lng", "text") . " " .
223 "AND title = " . $this->db->quote($lang_key, "text");
224 $this->db->manipulate($query);
225 }
226 }
227
228 return $a_languages;
229 }
Referenced by getLanguages().
Here is the caller graph for this function:
Field Documentation
◆ $lang_default
| string ilObjLanguageFolder::$lang_default |
indicator for the system language this language must not be deleted
Definition at line 37 of file class.ilObjLanguageFolder.php.
◆ $lang_path
| string ilObjLanguageFolder::$lang_path |
path to language files relative path is taken from ini file and added to absolute path of ilias
Definition at line 51 of file class.ilObjLanguageFolder.php.
◆ $lang_user
| string ilObjLanguageFolder::$lang_user |
language that is in use by current user this language must not be deleted
Definition at line 44 of file class.ilObjLanguageFolder.php.
◆ $languages
| array ilObjLanguageFolder::$languages |
contians all informations about languages
Definition at line 61 of file class.ilObjLanguageFolder.php.
Referenced by getLanguages().
◆ $separator
| string ilObjLanguageFolder::$separator |
separator value between module,identivier & value
Definition at line 56 of file class.ilObjLanguageFolder.php.
The documentation for this class was generated from the following file:
- components/ILIAS/Language/classes/class.ilObjLanguageFolder.php
