ilObjLanguage Class Reference
Class ilObjLanguage. More...
Inheritance diagram for ilObjLanguage:
Collaboration diagram for ilObjLanguage:
Public Member Functions | |
| ilObjLanguage ($a_id=0, $a_call_by_reference=false) | |
| Constructor. More... | |
| getKey () | |
| get language key More... | |
| getStatus () | |
| get language status More... | |
| isSystemLanguage () | |
| check if language is system language More... | |
| isUserLanguage () | |
| check if language is system language More... | |
| isInstalled () | |
| Check language object status, and return true if language is installed. More... | |
| isLocal () | |
| Check language object status, and return true if a local language file is installed. More... | |
| install ($scope='') | |
| install current language More... | |
| uninstall () | |
| uninstall current language More... | |
| refresh () | |
| refresh current language More... | |
| flush ($a_mode='all') | |
| remove language data from database More... | |
| getLocalChanges ($a_min_date="", $a_max_date="") | |
| get locally changed language entries More... | |
| _getLastLocalChange ($a_key) | |
| get the date of the last local change More... | |
| insert ($scope='') | |
| insert language data from file into database More... | |
| resetUserLanguage ($lang_key) | |
| search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english). More... | |
| cut_header ($content) | |
| remove lang-file haeder information from '$content' This function seeks for a special keyword where the language information starts. More... | |
| optimizeData () | |
| optimizes the db-table langdata More... | |
| check ($scope='') | |
| Validate the logical structure of a lang file. More... | |
| Public Member Functions inherited from ilObject | |
| ilObject ($a_id=0, $a_reference=true) | |
| Constructor @access public. More... | |
| withReferences () | |
| determines wehter objects are referenced or not (got ref ids or not) More... | |
| read ($a_force_db=false) | |
| read object data from db into object More... | |
| getId () | |
| get object id @access public More... | |
| setId ($a_id) | |
| set object id @access public More... | |
| setRefId ($a_id) | |
| set reference id @access public More... | |
| getRefId () | |
| get reference id @access public More... | |
| getType () | |
| get object type @access public More... | |
| setType ($a_type) | |
| set object type @access public More... | |
| getPresentationTitle () | |
| get presentation title Normally same as title Overwritten for sessions More... | |
| getTitle () | |
| get object title @access public More... | |
| getUntranslatedTitle () | |
| get untranslated object title @access public More... | |
| setTitle ($a_title) | |
| set object title More... | |
| getDescription () | |
| get object description More... | |
| setDescription ($a_desc) | |
| set object description More... | |
| getLongDescription () | |
| get object long description (stored in object_description) More... | |
| getImportId () | |
| get import id More... | |
| setImportId ($a_import_id) | |
| set import id More... | |
| getOwner () | |
| get object owner More... | |
| getOwnerName () | |
| _lookupOwnerName ($a_owner_id) | |
| lookup owner name for owner id More... | |
| setOwner ($a_owner) | |
| set object owner More... | |
| getCreateDate () | |
| get create date @access public More... | |
| getLastUpdateDate () | |
| get last update date @access public More... | |
| getDiskUsage () | |
| setObjDataRecord ($a_record) | |
| set object_data record (note: this method should only be called from the ilObjectFactory class) More... | |
| create () | |
| create More... | |
| update () | |
| update object in db More... | |
| MDUpdateListener ($a_element) | |
| Meta data update listener. More... | |
| createMetaData () | |
| create meta data entry More... | |
| updateMetaData () | |
| update meta data entry More... | |
| deleteMetaData () | |
| delete meta data entry More... | |
| updateOwner () | |
| update owner of object in db More... | |
| _getIdForImportId ($a_import_id) | |
| get current object id for import id (static) More... | |
| _lookupOwner ($a_id) | |
| lookup object owner More... | |
| _lookupLastUpdate ($a_id, $a_as_string=false) | |
| lookup last update More... | |
| _getLastUpdateOfObjects ($a_objs) | |
| Get last update for a set of media objects. More... | |
| _setDeletedDate ($a_ref_id) | |
| only called in ilTree::saveSubTree More... | |
| _resetDeletedDate ($a_ref_id) | |
| only called in ilObjectGUI::insertSavedNodes More... | |
| _lookupDeletedDate ($a_ref_id) | |
| only called in ilObjectGUI::insertSavedNodes More... | |
| _writeTitle ($a_obj_id, $a_title) | |
| write title to db (static) More... | |
| _writeDescription ($a_obj_id, $a_desc) | |
| write description to db (static) More... | |
| _writeImportId ($a_obj_id, $a_import_id) | |
| write import id to db (static) More... | |
| _isInTrash ($a_ref_id) | |
| checks wether object is in trash More... | |
| _hasUntrashedReference ($a_obj_id) | |
| checks wether an object has at least one reference that is not in trash More... | |
| _getObjectsDataForType ($a_type, $a_omit_trash=false) | |
| get all objects of a certain type More... | |
| putInTree ($a_parent_ref) | |
| maybe this method should be in tree object!? More... | |
| setPermissions ($a_parent_ref) | |
| set permissions of object More... | |
| setParentRolePermissions ($a_parent_ref) | |
| Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More... | |
| createReference () | |
| creates reference for object More... | |
| countReferences () | |
| count references of object More... | |
| 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More... | |
| applyDidacticTemplate ($a_tpl_id) | |
| Apply template. More... | |
| notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
| notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More... | |
| setRegisterMode ($a_bool) | |
| isUserRegistered ($a_user_id=0) | |
| requireRegistration () | |
| getXMLZip () | |
| getHTMLDirectory () | |
| cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
| Clone object permissions, put in tree ... More... | |
| appendCopyInfo ($a_target_id, $a_copy_id) | |
| Prepend Copy info if object with same name exists in that container. More... | |
| cloneDependencies ($a_target_id, $a_copy_id) | |
| Clone object dependencies. More... | |
| cloneMetaData ($target_obj) | |
| Copy meta data. More... | |
| _lookupCreationDate ($a_id) | |
| Lookup creation date. More... | |
| getPossibleSubObjects ($a_filter=true) | |
| get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More... | |
Static Public Member Functions | |
| static | getInstalledLanguages () |
| Get the language objects of the installed languages. More... | |
| static | refreshAll () |
| Refresh all installed languages. More... | |
| static | refreshPlugins ($a_lang_keys=null) |
| static | _deleteLangData ($a_lang_key, $a_keep_local_change=false) |
| Delete languge data. More... | |
| static | replaceLangEntry ($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null, $a_remarks=null) |
| Replace lang entry. More... | |
| static | updateLangEntry ($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null, $a_remarks=null) |
| Replace lang entry. More... | |
| static | deleteLangEntry ($a_module, $a_identifier, $a_lang_key) |
| Delete lang entry. More... | |
| static | countUsers ($a_lang) |
| Count number of users that use a language. More... | |
| Static Public Member Functions inherited from ilObject | |
| static | _lookupObjIdByImportId ($a_import_id) |
| static | _lookupImportId ($a_obj_id) |
| static | _getAllReferences ($a_id) |
| get all reference ids of object More... | |
| static | _lookupTitle ($a_id) |
| lookup object title More... | |
| static | _getIdsForTitle ($title, $type='', $partialmatch=false) |
| static | _lookupDescription ($a_id) |
| lookup object description More... | |
| static | _lookupObjId ($a_id) |
| static | setDeletedDates ($a_ref_ids) |
| Set deleted date @global type $ilDB. More... | |
| static | _lookupType ($a_id, $a_reference=false) |
| lookup object type More... | |
| static | _lookupObjectId ($a_ref_id) |
| lookup object id More... | |
| static | _exists ($a_id, $a_reference=false, $a_type=null) |
| checks if an object exists in object_data@access public More... | |
| static | _getObjectsByType ($a_obj_type="", $a_owner="") |
| Get objects by type. More... | |
| static | _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true) |
| Prepare copy wizard object selection. More... | |
| static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
| Get icon for repository item. More... | |
| static | collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0) |
| Collect deletion dependencies. More... | |
| static | getDeletionDependencies ($a_obj_id) |
| Get deletion dependencies. More... | |
| static | getLongDescriptions (array $a_obj_ids) |
| Get long description data. More... | |
| static | getAllOwnedRepositoryObjects ($a_user_id) |
| Get all ids of objects user owns. More... | |
| static | fixMissingTitles ($a_type, array &$a_obj_title_map) |
| Try to fix missing object titles. More... | |
| static | hasAutoRating ($a_type, $a_ref_id) |
| Check if auto rating is active for parent group/course. More... | |
Data Fields | |
| $separator | |
| $comment_separator | |
| $lang_default | |
| $lang_user | |
| $lang_path | |
| $key | |
| $status | |
| Data Fields inherited from ilObject | |
| const | TITLE_LENGTH = 255 |
| max length of object title More... | |
| const | DESC_LENGTH = 128 |
| $ilias | |
| $lng | |
| $id | |
| $ref_id | |
| $type | |
| $title | |
| $untranslatedTitle | |
| $desc | |
| $long_desc | |
| $owner | |
| $create_date | |
| $last_update | |
| $import_id | |
| $register = false | |
| $referenced | |
| $objectList | |
| $max_title | |
| $max_desc | |
| $add_dots | |
| $obj_data_record | |
| object_data record More... | |
Detailed Description
Member Function Documentation
◆ _deleteLangData()
|
static |
Delete languge data.
- Parameters
-
string lang key
Definition at line 328 of file class.ilObjLanguage.php.
329 {
330 global $ilDB;
331 if (!$a_keep_local_change)
332 {
335 }
336 else
337 {
340 " AND local_change IS NULL");
341 }
342 }
References $ilDB.
Referenced by flush(), and ilObjLanguageExt\importLanguageFile().
Here is the caller graph for this function:
◆ _getLastLocalChange()
| ilObjLanguage::_getLastLocalChange | ( | $a_key | ) |
get the date of the last local change
- Parameters
-
string language key
- Returns
- array change_date "yyyy-mm-dd hh:mm:ss"
Definition at line 401 of file class.ilObjLanguage.php.
402 {
403 global $ilDB;
404
405 $q = sprintf("SELECT MAX(local_change) last_change FROM lng_data ".
406 "WHERE lang_key = %s AND local_change IS NOT NULL",
409
411 {
413 }
414 else
415 {
416 return "";
417 }
418 }
References $ilDB, $result, $row, and DB_FETCHMODE_ASSOC.
Referenced by ilLanguageTableGUI\fillRow().
Here is the caller graph for this function:
◆ check()
| ilObjLanguage::check | ( | $scope = '' | ) |
Validate the logical structure of a lang file.
This function checks if a lang file exists, the file has a header, and each lang-entry consists of exactly three elements (module, identifier, value).
- Returns
- string system message
- Parameters
-
string $scope empty (global) or "local"
Definition at line 818 of file class.ilObjLanguage.php.
819 {
820 include_once("./Services/Utilities/classes/class.ilStr.php");
821
822 if (!empty($scope))
823 {
824 if ($scope == 'global')
825 {
826 $scope = '';
827 }
828 else
829 {
830 $scopeExtension = '.' . $scope;
831 }
832 }
833
835 if ($scope == "local")
836 {
837 $path = $this->cust_lang_path;
838 }
839
840 $tmpPath = getcwd();
841
842 // dir check
844 {
846 }
847
848 chdir($path);
849
850 // compute lang-file name format
851 $lang_file = "ilias_" . $this->key . ".lang" . $scopeExtension;
852
853 // file check
854 if (!is_file($lang_file))
855 {
857 }
858
859 // header check
860 $content = $this->cut_header(file($lang_file));
861 if ($content === false)
862 {
864 }
865
866 // check (counting) elements of each lang-entry
867 $line = 0;
869 {
870 $separated = explode($this->separator, trim($val));
871 $num = count($separated);
872 ++$n;
873 if ($num != 3)
874 {
875 $line = $n + 36;
876 $this->ilias->raiseError("Wrong parameter count in ".$lang_file." in line $line (Value: $val)! Please check your language file!",$this->ilias->error_obj->MESSAGE);
877 }
879 {
880 $this->ilias->raiseError("Non UTF8 character found in ".$lang_file." in line $line (Value: $val)! Please check your language file!",$this->ilias->error_obj->MESSAGE);
881 }
882 }
883
884 chdir($tmpPath);
885
886 // no error occured
887 return true;
888 }
cut_header($content)
remove lang-file haeder information from '$content' This function seeks for a special keyword where t...
Definition: class.ilObjLanguage.php:782
redirection script todo: (a better solution should control the processing via a xml file)
References $key, $lang_path, $n, $path, cut_header(), and ilStr\isUtf8().
Referenced by install(), and refresh().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ countUsers()
|
static |
Count number of users that use a language.
Definition at line 893 of file class.ilObjLanguage.php.
894 {
896
898 " ON ud.usr_id = up.usr_id ".
900 " AND up.keyword = ".$ilDB->quote("language", "text"));
901 $rec = $ilDB->fetchAssoc($set);
902
903 // add users with no usr_pref set to default language
905 {
908 " WHERE up.value IS NULL ");
909 $rec2 = $ilDB->fetchAssoc($set2);
910 }
911
912 return (int) $rec["cnt"] + (int) $rec2["cnt"];
913 }
References $ilDB, and ilObject\$lng.
Referenced by ilLanguageTableGUI\fillRow().
Here is the caller graph for this function:
◆ cut_header()
| ilObjLanguage::cut_header | ( | $content | ) |
remove lang-file haeder information from '$content' This function seeks for a special keyword where the language information starts.
if found it returns the plain language information, otherwise returns false
- Parameters
-
string $content expecting an ILIAS lang-file
- Returns
- string $content content without header info OR false if no valid header was found
Definition at line 782 of file class.ilObjLanguage.php.
783 {
785 {
786 if (trim($val) == "<!-- language file start -->")
787 {
788
790 }
791 }
792
793 return false;
794 }
References $key.
Referenced by check(), ilObjLanguageFolder\checkAllLanguages(), and insert().
Here is the caller graph for this function:
◆ deleteLangEntry()
|
staticfinal |
Delete lang entry.
Definition at line 743 of file class.ilObjLanguage.php.
744 {
745 global $ilDB;
746
748 "WHERE module = %s AND identifier = %s AND lang_key = %s ",
752
753 return true;
754 }
References $ilDB.
Referenced by ilObjLanguageExt\_deleteValues().
Here is the caller graph for this function:
◆ flush()
| ilObjLanguage::flush | ( | $a_mode = 'all' | ) |
remove language data from database
- Parameters
-
string "all" or "keep_local"
Definition at line 348 of file class.ilObjLanguage.php.
349 {
350 global $ilDB;
351
353
354 if ($a_mode == 'all')
355 {
358 }
359 }
static _deleteLangData($a_lang_key, $a_keep_local_change=false)
Delete languge data.
Definition: class.ilObjLanguage.php:328
References $ilDB, and _deleteLangData().
Referenced by install(), refresh(), and uninstall().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getInstalledLanguages()
|
static |
Get the language objects of the installed languages.
- Returns
- self[]
Definition at line 62 of file class.ilObjLanguage.php.
63 {
64 $objects = array();
67 {
69 if ($langObj->isInstalled())
70 {
71 $objects[] = $langObj;
72 }
73 else
74 {
75 unset($langObj);
76 }
77 }
78 return $objects;
79 }
ilObjLanguage($a_id=0, $a_call_by_reference=false)
Constructor.
Definition: class.ilObjLanguage.php:40
static _getObjectsByType($a_obj_type="", $a_owner="")
Get objects by type.
Definition: class.ilObject.php:1649
References $lang, ilObject\_getObjectsByType(), and ilObjLanguage().
Referenced by ilPlugin\updateLanguages().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getKey()
| ilObjLanguage::getKey | ( | ) |
get language key
- Returns
- string language key
Definition at line 87 of file class.ilObjLanguage.php.
References $key.
Referenced by install(), and refresh().
Here is the caller graph for this function:
◆ getLocalChanges()
| ilObjLanguage::getLocalChanges | ( | $a_min_date = "", |
|
$a_max_date = "" |
|||
| ) |
get locally changed language entries
- Parameters
-
string minimum change date "yyyy-mm-dd hh:mm:ss" string maximum change date "yyyy-mm-dd hh:mm:ss"
- Returns
- array [module][identifier] => value
Definition at line 368 of file class.ilObjLanguage.php.
369 {
370 global $ilDB;
371
372 if ($a_min_date == "")
373 {
374 $a_min_date = "1980-01-01 00:00:00";
375 }
376 if ($a_max_date == "")
377 {
378 $a_max_date = "2200-01-01 00:00:00";
379 }
380
381 $q = sprintf("SELECT * FROM lng_data WHERE lang_key = %s ".
382 "AND local_change >= %s AND local_change <= %s",
386
387 $changes = array();
389 {
391 }
392 return $changes;
393 }
References $ilDB, $result, $row, and DB_FETCHMODE_ASSOC.
Referenced by insert().
Here is the caller graph for this function:
◆ getStatus()
| ilObjLanguage::getStatus | ( | ) |
get language status
- Returns
- string language status
Definition at line 97 of file class.ilObjLanguage.php.
98 {
100 }
References $status.
Referenced by isInstalled(), isLocal(), and refresh().
Here is the caller graph for this function:
◆ ilObjLanguage()
| ilObjLanguage::ilObjLanguage | ( | $a_id = 0, |
|
$a_call_by_reference = false |
|||
| ) |
Constructor.
@access public
- Parameters
-
integer reference_id or object_id boolean treat the id as reference_id (true) or object_id (false)
Definition at line 40 of file class.ilObjLanguage.php.
41 {
42 global $lng;
43
44 $this->type = "lng";
45 $this->ilObject($a_id,$a_call_by_reference);
46
47 $this->type = "lng";
48 $this->key = $this->title;
49 $this->status = $this->desc;
50 $this->lang_default = $lng->lang_default;
51 $this->lang_user = $lng->lang_user;
52 $this->lang_path = $lng->lang_path;
53 $this->cust_lang_path = $lng->cust_lang_path;
54 $this->separator = $lng->separator;
55 $this->comment_separator = $lng->comment_separator;
56 }
References ilObject\$desc, ilObject\$lng, ilObject\$title, and ilObject\ilObject().
Referenced by getInstalledLanguages(), ilObjLanguageExt\ilObjLanguageExt(), and refreshAll().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ insert()
| ilObjLanguage::insert | ( | $scope = '' | ) |
insert language data from file into database
- Parameters
-
string $scope empty (global) or "local"
Definition at line 451 of file class.ilObjLanguage.php.
452 {
453 global $ilDB;
454
455 if (!empty($scope))
456 {
457 if ($scope == 'global')
458 {
459 $scope = '';
460 }
461 else
462 {
463 $scopeExtension = '.' . $scope;
464 }
465 }
466
468 if ($scope == "local")
469 {
470 $path = $this->cust_lang_path;
471 }
472
474 if (is_file($lang_file))
475 {
476 // initialize the array for updating lng_modules below
477 $lang_array = array();
478 $lang_array["common"] = array();
479
480 // remove header first
482 {
483 if (empty($scope))
484 {
485 // reset change date for a global file
486 // get all local changes for a global file
487 $change_date = null;
488 $local_changes = $this->getLocalChanges();
489 }
490 else if ($scope == 'local')
491 {
492 // set the change date to import time for a local file
493 // get the modification date of the local file
494 // get the newer local changes for a local file
495 $change_date = date("Y-m-d H:i:s",time());
496 $min_date = date("Y-m-d H:i:s", filemtime($lang_file));
497 $local_changes = $this->getLocalChanges($min_date);
498 }
499
501 {
502 // split the line of the language file
503 // [0]: module
504 // [1]: identifier
505 // [2]: value
506 // [3]: comment (optional)
507 $separated = explode($this->separator,trim($val));
508 $pos = strpos($separated[2], $this->comment_separator);
509 if ($pos !== false)
510 {
511 $separated[3] = substr($separated[2], $pos + strlen($this->comment_separator));
512 $separated[2] = substr($separated[2] , 0 , $pos);
513 }
514
515 // check if the value has a local change
516 $local_value = $local_changes[$separated[0]][$separated[1]];
517
518 if (empty($scope))
519 {
520 // import of a global language file
521
522 if ($local_value != "" and $local_value != $separated[2])
523 {
524 // keep an existing and different local calue
525 $lang_array[$separated[0]][$separated[1]] = $local_value;
526 }
527 else
528 {
529 // check for double entries in global file
530 if ($double_checker[$separated[0]][$separated[1]][$this->key])
531 {
533 $this->ilias->error_obj->MESSAGE);
534 }
536
537 // insert a new value if no local value exists
538 // reset local change date if the values are equal
539 ilObjLanguage::replaceLangEntry($separated[0], $separated[1],
540 $this->key, $separated[2], $change_date, $separated[3]);
541
542 $lang_array[$separated[0]][$separated[1]] = $separated[2];
543 }
544 }
545 else if ($scope == 'local')
546 {
547 // import of a local language file
548
549 if ($local_value != "")
550 {
551 // keep a locally changed value that is newer than the file
552 $lang_array[$separated[0]][$separated[1]] = $local_value;
553 }
554 else
555 {
556 // insert a new value if no global value exists
557 // (local files may have additional entries for customizations)
558 // set the change date to the import date
559 ilObjLanguage::replaceLangEntry($separated[0], $separated[1],
560 $this->key, $separated[2], $change_date, $separated[3]);
561
562 $lang_array[$separated[0]][$separated[1]] = $separated[2];
563 }
564 }
565 }
566
567 $ld = "";
568 if (empty($scope))
569 {
570 $ld = "installed";
571 }
572 else if ($scope == 'local')
573 {
574 $ld = "installed_local";
575 }
576 if ($ld)
577 {
579 "description = ".$ilDB->quote($ld, "text").", " .
580 "last_update = ".$ilDB->now()." " .
581 "WHERE title = ".$ilDB->quote($this->key, "text")." " .
582 "AND type = 'lng'";
584 }
585 }
586
587 foreach($lang_array as $module => $lang_arr)
588 {
589 if ($scope == "local")
590 {
591 $q = "SELECT * FROM lng_modules WHERE ".
592 " lang_key = ".$ilDB->quote($this->key, "text").
593 " AND module = ".$ilDB->quote($module, "text");
594 $set = $ilDB->query($q);
597 if (is_array($arr2))
598 {
599 $lang_arr = array_merge($arr2, $lang_arr);
600 }
601 }
602 ilObjLanguage::replaceLangModule($this->key, $module, $lang_arr);
603 }
604 }
605 }
getLocalChanges($a_min_date="", $a_max_date="")
get locally changed language entries
Definition: class.ilObjLanguage.php:368
static replaceLangEntry($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null, $a_remarks=null)
Replace lang entry.
Definition: class.ilObjLanguage.php:648
References $ilDB, $key, $lang_path, $path, $query, $row, cut_header(), getLocalChanges(), and replaceLangEntry().
Referenced by install(), and refresh().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ install()
| ilObjLanguage::install | ( | $scope = '' | ) |
install current language
- Returns
- string installed language key
- Parameters
-
string $scope empty (global) or "local"
Definition at line 170 of file class.ilObjLanguage.php.
171 {
172 if (!empty($scope))
173 {
174 if ($scope == 'global')
175 {
176 $scope = '';
177 }
178 else
179 {
180 $scopeExtension = '.' . $scope;
181 }
182 }
183
186 {
188 {
189 // lang-file is ok. Flush data in db and...
190 if (empty($scope))
191 {
193 }
194
195 // ...re-insert data from lang-file
196 $this->insert($scope);
197
198 // update information in db-table about available/installed languages
199 if (empty($scope))
200 {
201 $newDesc = 'installed';
202 }
203 else if ($scope == 'local')
204 {
205 $newDesc = 'installed_local';
206 }
207 $this->setDescription($newDesc);
208 $this->update();
209 $this->optimizeData();
211 }
212 }
213 return "";
214 }
isInstalled()
Check language object status, and return true if language is installed.
Definition: class.ilObjLanguage.php:134
isLocal()
Check language object status, and return true if a local language file is installed.
Definition: class.ilObjLanguage.php:152
insert($scope='')
insert language data from file into database
Definition: class.ilObjLanguage.php:451
check($scope='')
Validate the logical structure of a lang file.
Definition: class.ilObjLanguage.php:818
References check(), flush(), getKey(), insert(), isInstalled(), isLocal(), optimizeData(), ilObject\setDescription(), and ilObject\update().
Here is the call graph for this function:
◆ isInstalled()
| ilObjLanguage::isInstalled | ( | ) |
Check language object status, and return true if language is installed.
- Returns
- boolean true if installed
Definition at line 134 of file class.ilObjLanguage.php.
135 {
137 {
138 return true;
139 }
140 else
141 {
142 return false;
143 }
144 }
References getStatus().
Referenced by install(), refresh(), and ilObjLanguageExt\setLocal().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isLocal()
| ilObjLanguage::isLocal | ( | ) |
Check language object status, and return true if a local language file is installed.
- Returns
- boolean true if local language is installed
Definition at line 152 of file class.ilObjLanguage.php.
153 {
155 {
156 return true;
157 }
158 else
159 {
160 return false;
161 }
162 }
References getStatus().
Referenced by install(), and refresh().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isSystemLanguage()
| ilObjLanguage::isSystemLanguage | ( | ) |
check if language is system language
Definition at line 105 of file class.ilObjLanguage.php.
106 {
107 if ($this->key == $this->lang_default)
108 return true;
109 else
110 return false;
111 }
◆ isUserLanguage()
| ilObjLanguage::isUserLanguage | ( | ) |
check if language is system language
Definition at line 116 of file class.ilObjLanguage.php.
117 {
118 if ($this->key == $this->lang_user)
119 {
120 return true;
121 }
122 else
123 {
124 return false;
125 }
126 }
◆ optimizeData()
| ilObjLanguage::optimizeData | ( | ) |
optimizes the db-table langdata
- Returns
- boolean true on success
Definition at line 801 of file class.ilObjLanguage.php.
References $ilDB.
Referenced by install(), and refresh().
Here is the caller graph for this function:
◆ refresh()
| ilObjLanguage::refresh | ( | ) |
refresh current language
- Returns
- bool
Definition at line 242 of file class.ilObjLanguage.php.
243 {
245 {
247 {
249 $this->insert();
252 $this->update();
253 $this->optimizeData();
254
256 {
258 {
262 $this->update();
263 $this->optimizeData();
264 }
265 }
266 return true;
267 }
268 }
269 return false;
270 }
References check(), flush(), getKey(), getStatus(), insert(), isInstalled(), isLocal(), optimizeData(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().
Here is the call graph for this function:
◆ refreshAll()
|
static |
Refresh all installed languages.
Definition at line 275 of file class.ilObjLanguage.php.
276 {
278 $refreshed = array();
279
281 {
283 if ($langObj->refresh())
284 {
285 $refreshed[] = $langObj->getKey();
286 }
287 unset($langObj);
288 }
289
290 self::refreshPlugins($refreshed);
291 }
static refreshPlugins($a_lang_keys=null)
Definition: class.ilObjLanguage.php:298
References $lang, ilObject\_getObjectsByType(), ilObjLanguage(), and refreshPlugins().
Referenced by ilObjLanguageFolderGUI\refreshObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ refreshPlugins()
|
static |
Definition at line 298 of file class.ilObjLanguage.php.
299 {
300 global $ilPluginAdmin;
301
302 // refresh languages of activated plugins
303 include_once("./Services/Component/classes/class.ilPluginSlot.php");
304 $slots = ilPluginSlot::getAllSlots();
305 foreach ($slots as $slot)
306 {
307 $act_plugins = $ilPluginAdmin->getActivePluginsForSlot($slot["component_type"],
308 $slot["component_name"], $slot["slot_id"]);
309 foreach ($act_plugins as $plugin)
310 {
311 include_once("./Services/Component/classes/class.ilPlugin.php");
313 $slot["component_name"], $slot["slot_id"], $plugin);
314 if (is_object($pl))
315 {
316 $pl->updateLanguages($a_lang_keys);
317 }
318 }
319 }
320 }
static getPluginObject($a_ctype, $a_cname, $a_slot_id, $a_pname)
Get plugin object.
Definition: class.ilPlugin.php:1001
References ilPluginSlot\getAllSlots(), and ilPlugin\getPluginObject().
Referenced by refreshAll(), and ilObjLanguageFolderGUI\refreshSelectedObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ replaceLangEntry()
|
staticfinal |
Replace lang entry.
Definition at line 648 of file class.ilObjLanguage.php.
650 {
651 global $ilDB;
652
653 ilGlobalCache::flushAll();
654
655 if (isset($a_remarks))
656 {
657 $a_remarks = substr($a_remarks, 0, 250);
658 }
659 if ($a_remarks == '')
660 {
661 unset($a_remarks);
662 }
663
664 if (isset($a_value))
665 {
666 $a_value = substr($a_value, 0, 4000);
667 }
668 if ($a_value == '')
669 {
670 unset($a_value);
671 }
672
673 $ilDB->replace(
674 'lng_data',
675 array(
676 'module' => array('text',$a_module),
677 'identifier' => array('text',$a_identifier),
678 'lang_key' => array('text',$a_lang_key)
679 ),
680 array(
681 'value' => array('text',$a_value),
682 'local_change' => array('timestamp',$a_local_change),
683 'remarks' => array('text', $a_remarks)
684 )
685 );
686 return true;
687
688 /*
689 $ilDB->manipulate(sprintf("DELETE FROM lng_data WHERE module = %s AND ".
690 "identifier = %s AND lang_key = %s",
691 $ilDB->quote($a_module, "text"), $ilDB->quote($a_identifier, "text"),
692 $ilDB->quote($a_lang_key, "text")));
693
694
695 $ilDB->manipulate(sprintf("INSERT INTO lng_data " .
696 "(module, identifier, lang_key, value, local_change) " .
697 "VALUES (%s,%s,%s,%s,%s)",
698 $ilDB->quote($a_module, "text"), $ilDB->quote($a_identifier, "text"),
699 $ilDB->quote($a_lang_key, "text"), $ilDB->quote($a_value, "text"),
700 $ilDB->quote($a_local_change, "timestamp")));
701 */
702 }
References $ilDB.
Referenced by ilObjLanguageExt\_saveValues(), insert(), ilObjLanguageExtGUI\saveNewEntryObject(), and ilPlugin\updateLanguages().
Here is the caller graph for this function:
◆ resetUserLanguage()
| ilObjLanguage::resetUserLanguage | ( | $lang_key | ) |
search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english).
A message is sent to all affected users
- Parameters
-
string $lang_key international language key (2 digits)
Definition at line 763 of file class.ilObjLanguage.php.
764 {
765 global $ilDB;
766
768 "value = ".$ilDB->quote($this->lang_default, "text")." " .
769 "WHERE keyword = ".$ilDB->quote('language', "text")." ".
770 "AND value = ".$ilDB->quote($lang_key, "text");
772 }
Referenced by uninstall().
Here is the caller graph for this function:
◆ uninstall()
| ilObjLanguage::uninstall | ( | ) |
uninstall current language
- Returns
- string uninstalled language key
Definition at line 222 of file class.ilObjLanguage.php.
223 {
224 if ((substr($this->status, 0, 9) == "installed") && ($this->key != $this->lang_default) && ($this->key != $this->lang_user))
225 {
227 $this->setTitle($this->key);
229 $this->update();
230 $this->resetUserLanguage($this->key);
231
233 }
234 return "";
235 }
resetUserLanguage($lang_key)
search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to d...
Definition: class.ilObjLanguage.php:763
References $key, flush(), resetUserLanguage(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().
Here is the call graph for this function:
◆ updateLangEntry()
|
staticfinal |
Replace lang entry.
Definition at line 707 of file class.ilObjLanguage.php.
709 {
710 global $ilDB;
711
712 if (isset($a_remarks))
713 {
714 $a_remarks = substr($a_remarks, 0, 250);
715 }
716 if ($a_remarks == '')
717 {
718 unset($a_remarks);
719 }
720
721 if (isset($a_value))
722 {
723 $a_value = substr($a_value, 0, 4000);
724 }
725 if ($a_value == '')
726 {
727 unset($a_value);
728 }
729
731 "SET value = %s, local_change = %s, remarks = %s ".
732 "WHERE module = %s AND identifier = %s AND lang_key = %s ",
737 }
References $ilDB.
Field Documentation
◆ $comment_separator
| ilObjLanguage::$comment_separator |
Definition at line 24 of file class.ilObjLanguage.php.
◆ $key
| ilObjLanguage::$key |
Definition at line 29 of file class.ilObjLanguage.php.
Referenced by ilObjLanguageExt\_deleteValues(), ilObjLanguageExt\_saveValues(), check(), cut_header(), getKey(), ilObjLanguageExt\importLanguageFile(), insert(), and uninstall().
◆ $lang_default
| ilObjLanguage::$lang_default |
Definition at line 25 of file class.ilObjLanguage.php.
◆ $lang_path
| ilObjLanguage::$lang_path |
Definition at line 27 of file class.ilObjLanguage.php.
Referenced by check(), ilObjLanguageExt\getLangPath(), and insert().
◆ $lang_user
| ilObjLanguage::$lang_user |
Definition at line 26 of file class.ilObjLanguage.php.
◆ $separator
| ilObjLanguage::$separator |
Definition at line 23 of file class.ilObjLanguage.php.
◆ $status
| ilObjLanguage::$status |
Definition at line 30 of file class.ilObjLanguage.php.
Referenced by getStatus().
The documentation for this class was generated from the following file:
- Services/Language/classes/class.ilObjLanguage.php
