ILIAS
Release_4_0_x_branch Revision 61816
|
Class ilObjLanguage. More...
Public Member Functions | |
ilObjLanguage ($a_id=0, $a_call_by_reference=false) | |
Constructor. | |
getKey () | |
get language key | |
getStatus () | |
get language status | |
isSystemLanguage () | |
check if language is system language | |
isUserLanguage () | |
check if language is system language | |
isInstalled () | |
Check language object status, and return true if language is installed. | |
isLocal () | |
Check language object status, and return true if a local language file is installed. | |
install ($scope= '') | |
install current language | |
uninstall () | |
uninstall current language | |
flush ($a_mode= 'all') | |
remove language data from database | |
getLocalChanges ($a_min_date="", $a_max_date="") | |
get locally changed language entries | |
_getLastLocalChange ($a_key) | |
get the date of the last local change | |
insert ($scope= '') | |
insert language data from file into database | |
resetUserLanguage ($lang_key) | |
search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english). | |
cut_header ($content) | |
remove lang-file haeder information from '$content' This function seeks for a special keyword where the language information starts. | |
optimizeData () | |
optimizes the db-table langdata | |
check ($scope= '') | |
Validate the logical structure of a lang file. | |
Public Member Functions inherited from ilObject | |
ilObject ($a_id=0, $a_reference=true) | |
Constructor public. | |
withReferences () | |
determines wehter objects are referenced or not (got ref ids or not) | |
read ($a_force_db=false) | |
read object data from db into object | |
getId () | |
get object id public | |
setId ($a_id) | |
set object id public | |
setRefId ($a_id) | |
set reference id public | |
getRefId () | |
get reference id public | |
getType () | |
get object type public | |
setType ($a_type) | |
set object type public | |
getPresentationTitle () | |
get presentation title Normally same as title Overwritten for sessions | |
getTitle () | |
get object title public | |
getUntranslatedTitle () | |
get untranslated object title public | |
setTitle ($a_title) | |
set object title | |
getDescription () | |
get object description | |
setDescription ($a_desc) | |
set object description | |
getLongDescription () | |
get object long description (stored in object_description) | |
getImportId () | |
get import id | |
setImportId ($a_import_id) | |
set import id | |
_lookupObjIdByImportId ($a_import_id) | |
getOwner () | |
get object owner | |
getOwnerName () | |
_lookupOwnerName ($a_owner_id) | |
lookup owner name for owner id | |
setOwner ($a_owner) | |
set object owner | |
getCreateDate () | |
get create date public | |
getLastUpdateDate () | |
get last update date public | |
getDiskUsage () | |
Gets the disk usage of the object in bytes. | |
setObjDataRecord ($a_record) | |
set object_data record (note: this method should only be called from the ilObjectFactory class) | |
create () | |
create | |
update () | |
update object in db | |
MDUpdateListener ($a_element) | |
Meta data update listener. | |
createMetaData () | |
create meta data entry | |
updateMetaData () | |
update meta data entry | |
deleteMetaData () | |
delete meta data entry | |
updateOwner () | |
update owner of object in db | |
_getIdForImportId ($a_import_id) | |
get current object id for import id (static) | |
_getAllReferences ($a_id) | |
get all reference ids of object | |
_lookupOwner ($a_id) | |
lookup object owner | |
_lookupDescription ($a_id) | |
lookup object description | |
_lookupLastUpdate ($a_id, $a_as_string=false) | |
lookup last update | |
_getLastUpdateOfObjects ($a_objs) | |
Get last update for a set of media objects. | |
_setDeletedDate ($a_ref_id) | |
only called in ilTree::saveSubTree | |
_resetDeletedDate ($a_ref_id) | |
only called in ilObjectGUI::insertSavedNodes | |
_lookupDeletedDate ($a_ref_id) | |
only called in ilObjectGUI::insertSavedNodes | |
_writeTitle ($a_obj_id, $a_title) | |
write title to db (static) | |
_writeDescription ($a_obj_id, $a_desc) | |
write description to db (static) | |
_writeImportId ($a_obj_id, $a_import_id) | |
write import id to db (static) | |
_isInTrash ($a_ref_id) | |
checks wether object is in trash | |
_hasUntrashedReference ($a_obj_id) | |
checks wether an object has at least one reference that is not in trash | |
_lookupObjectId ($a_ref_id) | |
lookup object id | |
_getObjectsDataForType ($a_type, $a_omit_trash=false) | |
get all objects of a certain type | |
putInTree ($a_parent_ref) | |
maybe this method should be in tree object!? | |
setPermissions ($a_parent_ref) | |
set permissions of object | |
createReference () | |
creates reference for object | |
countReferences () | |
count references of object | |
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!! | |
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) public | |
createRoleFolder () | |
creates a local role folder | |
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. | |
setRegisterMode ($a_bool) | |
isUserRegistered ($a_user_id=0) | |
requireRegistration () | |
getXMLZip () | |
getHTMLDirectory () | |
cloneObject ($a_target_id, $a_copy_id=0) | |
Clone object permissions, put in tree ... | |
appendCopyInfo ($a_target_id, $a_copy_id) | |
Prepend Copy info if object with same name exists in that container. | |
cloneDependencies ($a_target_id, $a_copy_id) | |
Clone object dependencies. | |
cloneMetaData ($target_obj) | |
Copy meta data. |
Static Public Member Functions | |
static | refreshAll () |
Refresh all installed languages. | |
static | _deleteLangData ($a_lang_key, $a_keep_local_change) |
Delete languge data. | |
static | replaceLangModule ($a_key, $a_module, $a_array) |
Replace language module array. | |
static | replaceLangEntry ($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null) |
Replace lang entry. | |
static | updateLangEntry ($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null) |
Replace lang entry. | |
static | countUsers ($a_lang) |
Count number of users that use a language. | |
Static Public Member Functions inherited from ilObject | |
static | _lookupTitle ($a_id) |
lookup object title | |
static | _getIdsForTitle ($title, $type= '', $partialmatch=false) |
static | _lookupObjId ($a_id) |
static | _lookupType ($a_id, $a_reference=false) |
lookup object type | |
_exists ($a_id, $a_reference=false) | |
checks if an object exists in object_data | |
static | _getObjectsByType ($a_obj_type="", $a_owner="") |
Get objects by type. | |
static | _prepareCloneSelection ($a_ref_ids, $new_type) |
Prepare copy wizard object selection. | |
static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
Get icon for repository item. |
Data Fields | |
$separator | |
$comment_separator | |
$lang_default | |
$lang_user | |
$lang_path | |
$key | |
$status | |
Data Fields inherited from ilObject | |
$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 |
Class ilObjLanguage.
Definition at line 14 of file class.ilObjLanguage.php.
|
static |
Delete languge data.
string | lang key |
Definition at line 280 of file class.ilObjLanguage.php.
References $ilDB.
Referenced by flush(), and ilObjLanguageExt\importLanguageFile().
ilObjLanguage::_getLastLocalChange | ( | $a_key | ) |
get the date of the last local change
string | language key |
Definition at line 353 of file class.ilObjLanguage.php.
References $ilDB, $q, $result, $row, and DB_FETCHMODE_ASSOC.
Referenced by ilLanguageTableGUI\fillRow().
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).
string | $scope | empty (global) or "local" |
Definition at line 662 of file class.ilObjLanguage.php.
References $key, $lang_path, $n, cut_header(), and ilStr\isUtf8().
Referenced by install().
|
static |
Count number of users that use a language.
Definition at line 736 of file class.ilObjLanguage.php.
References $ilDB, and ilObject\$lng.
Referenced by ilLanguageTableGUI\fillRow().
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
string | $content | expecting an ILIAS lang-file |
Definition at line 627 of file class.ilObjLanguage.php.
References $key.
Referenced by check(), ilObjLanguageFolder\checkAllLanguages(), and insert().
ilObjLanguage::flush | ( | $a_mode = 'all' | ) |
remove language data from database
string | "all" or "keep_local" |
Definition at line 300 of file class.ilObjLanguage.php.
References $ilDB, and _deleteLangData().
Referenced by install(), and uninstall().
ilObjLanguage::getKey | ( | ) |
get language key
Definition at line 63 of file class.ilObjLanguage.php.
References $key.
Referenced by install().
ilObjLanguage::getLocalChanges | ( | $a_min_date = "" , |
|
$a_max_date = "" |
|||
) |
get locally changed language entries
string | minimum change date "yyyy-mm-dd hh:mm:ss" |
string | maximum change date "yyyy-mm-dd hh:mm:ss" |
Definition at line 320 of file class.ilObjLanguage.php.
References $ilDB, $q, $result, $row, and DB_FETCHMODE_ASSOC.
Referenced by insert().
ilObjLanguage::getStatus | ( | ) |
get language status
Definition at line 73 of file class.ilObjLanguage.php.
References $status.
Referenced by isInstalled(), and isLocal().
ilObjLanguage::ilObjLanguage | ( | $a_id = 0 , |
|
$a_call_by_reference = false |
|||
) |
Constructor.
public
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.
References ilObject\$desc, ilObject\$lng, ilObject\$title, and ilObject\ilObject().
Referenced by ilObjLanguageExt\ilObjLanguageExt(), and refreshAll().
ilObjLanguage::insert | ( | $scope = '' | ) |
insert language data from file into database
string | $scope | empty (global) or "local" |
Definition at line 378 of file class.ilObjLanguage.php.
References $ilDB, $key, $lang_path, $q, $query, $row, cut_header(), getLocalChanges(), replaceLangEntry(), replaceLangModule(), and updateLangEntry().
Referenced by install().
ilObjLanguage::install | ( | $scope = '' | ) |
install current language
string | $scope | empty (global) or "local" |
Definition at line 146 of file class.ilObjLanguage.php.
References check(), flush(), getKey(), insert(), isInstalled(), isLocal(), optimizeData(), ilObject\setDescription(), and ilObject\update().
ilObjLanguage::isInstalled | ( | ) |
Check language object status, and return true if language is installed.
Definition at line 110 of file class.ilObjLanguage.php.
References getStatus().
Referenced by install(), and ilObjLanguageExt\setLocal().
ilObjLanguage::isLocal | ( | ) |
Check language object status, and return true if a local language file is installed.
Definition at line 128 of file class.ilObjLanguage.php.
References getStatus().
Referenced by install().
ilObjLanguage::isSystemLanguage | ( | ) |
check if language is system language
Definition at line 81 of file class.ilObjLanguage.php.
ilObjLanguage::isUserLanguage | ( | ) |
check if language is system language
Definition at line 92 of file class.ilObjLanguage.php.
ilObjLanguage::optimizeData | ( | ) |
optimizes the db-table langdata
Definition at line 645 of file class.ilObjLanguage.php.
References $ilDB.
Referenced by install().
|
static |
Refresh all installed languages.
Definition at line 216 of file class.ilObjLanguage.php.
References $lang, ilObject\_getObjectsByType(), ilPluginSlot\getAllSlots(), ilPlugin\getPluginObject(), and ilObjLanguage().
Referenced by ilObjLanguageFolderGUI\refreshObject().
|
staticfinal |
Replace lang entry.
Definition at line 551 of file class.ilObjLanguage.php.
References $ilDB.
Referenced by ilObjLanguageExt\_saveValues(), insert(), and ilPlugin\updateLanguages().
|
staticfinal |
Replace language module array.
Definition at line 530 of file class.ilObjLanguage.php.
References $ilDB.
Referenced by ilObjLanguageExt\_saveValues(), insert(), and ilPlugin\updateLanguages().
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
string | $lang_key | international language key (2 digits) |
Definition at line 608 of file class.ilObjLanguage.php.
Referenced by uninstall().
ilObjLanguage::uninstall | ( | ) |
uninstall current language
Definition at line 198 of file class.ilObjLanguage.php.
References $key, flush(), resetUserLanguage(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().
|
staticfinal |
Replace lang entry.
Definition at line 589 of file class.ilObjLanguage.php.
References $ilDB.
Referenced by insert().
ilObjLanguage::$comment_separator |
Definition at line 24 of file class.ilObjLanguage.php.
ilObjLanguage::$key |
Definition at line 29 of file class.ilObjLanguage.php.
Referenced by ilObjLanguageExt\_saveValues(), check(), cut_header(), ilObjLanguageExt\getCommentedValues(), getKey(), ilObjLanguageExt\importLanguageFile(), insert(), and uninstall().
ilObjLanguage::$lang_default |
Definition at line 25 of file class.ilObjLanguage.php.
ilObjLanguage::$lang_path |
Definition at line 27 of file class.ilObjLanguage.php.
Referenced by check(), ilObjLanguageExt\getLangPath(), and insert().
ilObjLanguage::$lang_user |
Definition at line 26 of file class.ilObjLanguage.php.
ilObjLanguage::$separator |
Definition at line 23 of file class.ilObjLanguage.php.
ilObjLanguage::$status |
Definition at line 30 of file class.ilObjLanguage.php.
Referenced by getStatus().