ILIAS
release_4-3 Revision
|
Class ilObjLanguageExt. More...
Public Member Functions | |
ilObjLanguageExt ($a_id=0, $a_call_by_reference=false) | |
Constructor. | |
getGlobalLanguageFile () | |
Read and get the global language file as an object. | |
setLocal ($a_local=true) | |
Set the local status of the language. | |
getLongDescription () | |
Get the full language description. | |
getLangPath () | |
Get the language files path. | |
getCustLangPath () | |
Get the customized language files path. | |
getAllRemarks () | |
Get all remarks from the database. | |
getAllValues ($a_modules=array(), $a_pattern= '') | |
Get all values from the database. | |
getChangedValues ($a_modules=array(), $a_pattern= '') | |
Get only the changed values from the database which differ from the original language file. | |
getUnchangedValues ($a_modules=array(), $a_pattern= '') | |
Get only the unchanged values from the database which are equal to the original language file. | |
getAddedValues ($a_modules=array(), $a_pattern= '') | |
Get only the entries which don't exist in the global language file. | |
getCommentedValues ($a_modules=array(), $a_pattern= '') | |
Get all values from the database for wich the global language file has a comment. | |
getMergedValues () | |
Get the local values merged into the values of the global language file. | |
getMergedRemarks () | |
Get the local remarks merged into the remarks of the global language file. | |
importLanguageFile ($a_file, $a_mode_existing= 'keepnew') | |
Import a language file into the ilias database. | |
Public Member Functions inherited from ilObjLanguage | |
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 | |
getImportId () | |
get import id | |
setImportId ($a_import_id) | |
set 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) | |
_lookupOwner ($a_id) | |
lookup object owner | |
_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 | |
_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 | |
applyDidacticTemplate ($a_tpl_id) | |
Apply template. | |
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, $a_omit_tree=false) | |
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. | |
_lookupCreationDate ($a_id) | |
Lookup creation date. |
Static Public Member Functions | |
static | _getModules ($a_lang_key) |
Get all modules of a language. | |
static | _getRemarks ($a_lang_key, $a_all_changed=false) |
Get all remarks of a language. | |
static | _getValues ($a_lang_key, $a_modules=array(), $a_topics=array(), $a_pattern= '', $a_state= '') |
Get the translations of specified topics. | |
static | _saveValues ($a_lang_key, $a_values=array(), $a_remarks=array()) |
Save a set of translation in the database. | |
static | _deleteValues ($a_lang_key, $a_values=array()) |
Delete a set of translation in the database. | |
Static Public Member Functions inherited from ilObjLanguage | |
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, $a_remarks=null) |
Replace lang entry. | |
static | updateLangEntry ($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null, $a_remarks=null) |
Replace lang entry. | |
static | deleteLangEntry ($a_module, $a_identifier, $a_lang_key) |
Delete lang entry. | |
static | countUsers ($a_lang) |
Count number of users that use a language. | |
Static Public Member Functions inherited from ilObject | |
static | _lookupObjIdByImportId ($a_import_id) |
static | _getAllReferences ($a_id) |
get all reference ids of object | |
static | _lookupTitle ($a_id) |
lookup object title | |
static | _getIdsForTitle ($title, $type= '', $partialmatch=false) |
static | _lookupDescription ($a_id) |
lookup object description | |
static | _lookupObjId ($a_id) |
static | _lookupType ($a_id, $a_reference=false) |
lookup object type | |
static | _lookupObjectId ($a_ref_id) |
lookup object id | |
_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, $show_path=true) |
Prepare copy wizard object selection. | |
static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
Get icon for repository item. | |
static | collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0) |
Collect deletion dependencies. | |
static | getDeletionDependencies ($a_obj_id) |
Get deletion dependencies. | |
static | getLongDescriptions (array $a_obj_ids) |
Get long description data. | |
static | getAllOwnedRepositoryObjects ($a_user_id) |
Get all ids of objects user owns. |
Additional Inherited Members | |
Data Fields inherited from ilObjLanguage | |
$separator | |
$comment_separator | |
$lang_default | |
$lang_user | |
$lang_path | |
$key | |
$status |
|
static |
Delete a set of translation in the database.
static
string | language key |
array | module.separator.topic => value |
Definition at line 468 of file class.ilObjLanguageExt.php.
References ilObjLanguage\$key, ilObject\$lng, $row, ilObjLanguage\deleteLangEntry(), and ilObjLanguage\replaceLangModule().
Referenced by ilObjLanguageExtGUI\maintainObject().
|
static |
Get all modules of a language.
static
string | language key |
Definition at line 286 of file class.ilObjLanguageExt.php.
References DB_FETCHMODE_ASSOC.
Referenced by ilObjLanguageExtGUI\statisticsObject(), and ilObjLanguageExtGUI\viewObject().
|
static |
Get all remarks of a language.
static
string | language key |
boolean | include empty remarks for local changes |
Definition at line 310 of file class.ilObjLanguageExt.php.
References ilObject\$lng, $result, and $row.
Referenced by getAllRemarks(), getMergedRemarks(), and ilObjLanguageExtGUI\viewObject().
|
static |
Get the translations of specified topics.
static
string | language key |
array | list of modules |
array | list of topics |
array | search pattern |
string | local change state ('changed', 'unchanged', '') |
Definition at line 349 of file class.ilObjLanguageExt.php.
References ilObject\$lng, and DB_FETCHMODE_ASSOC.
Referenced by getAddedValues(), getAllValues(), getChangedValues(), getCommentedValues(), getMergedValues(), getUnchangedValues(), and ilObjLanguageExtGUI\viewObject().
|
static |
Save a set of translation in the database.
static
string | language key |
array | module.separator.topic => value |
array | module.separator.topic => remarks |
Definition at line 401 of file class.ilObjLanguageExt.php.
References ilObjLanguage\$key, ilObject\$lng, $row, ilLanguageFile\_getGlobalLanguageFile(), ilObjLanguage\replaceLangEntry(), and ilObjLanguage\replaceLangModule().
Referenced by importLanguageFile(), and ilObjLanguageExtGUI\saveObject().
ilObjLanguageExt::getAddedValues | ( | $a_modules = array() , |
|
$a_pattern = '' |
|||
) |
Get only the entries which don't exist in the global language file.
array | list of modules |
array | search pattern |
Definition at line 144 of file class.ilObjLanguageExt.php.
References _getValues(), and getGlobalLanguageFile().
ilObjLanguageExt::getAllRemarks | ( | ) |
Get all remarks from the database.
Definition at line 92 of file class.ilObjLanguageExt.php.
References _getRemarks().
ilObjLanguageExt::getAllValues | ( | $a_modules = array() , |
|
$a_pattern = '' |
|||
) |
Get all values from the database.
array | list of modules |
string | search pattern |
Definition at line 104 of file class.ilObjLanguageExt.php.
References _getValues().
Referenced by importLanguageFile().
ilObjLanguageExt::getChangedValues | ( | $a_modules = array() , |
|
$a_pattern = '' |
|||
) |
Get only the changed values from the database which differ from the original language file.
array | list of modules |
string | search pattern |
Definition at line 118 of file class.ilObjLanguageExt.php.
References _getValues().
Referenced by importLanguageFile().
ilObjLanguageExt::getCommentedValues | ( | $a_modules = array() , |
|
$a_pattern = '' |
|||
) |
Get all values from the database for wich the global language file has a comment.
Note: This function checks the comments in the globel lang file, not the remarks in the database!
array | list of modules |
array | search pattern |
Definition at line 164 of file class.ilObjLanguageExt.php.
References _getValues(), and getGlobalLanguageFile().
ilObjLanguageExt::getCustLangPath | ( | ) |
Get the customized language files path.
Definition at line 82 of file class.ilObjLanguageExt.php.
ilObjLanguageExt::getGlobalLanguageFile | ( | ) |
Read and get the global language file as an object.
Definition at line 29 of file class.ilObjLanguageExt.php.
References ilLanguageFile\_getGlobalLanguageFile().
Referenced by getAddedValues(), getCommentedValues(), getMergedRemarks(), and getMergedValues().
ilObjLanguageExt::getLangPath | ( | ) |
Get the language files path.
Definition at line 72 of file class.ilObjLanguageExt.php.
References ilObjLanguage\$lang_path.
ilObjLanguageExt::getLongDescription | ( | ) |
Get the full language description.
Reimplemented from ilObject.
Definition at line 62 of file class.ilObjLanguageExt.php.
ilObjLanguageExt::getMergedRemarks | ( | ) |
Get the local remarks merged into the remarks of the global language file.
The returned array contains:
Definition at line 206 of file class.ilObjLanguageExt.php.
References _getRemarks(), and getGlobalLanguageFile().
ilObjLanguageExt::getMergedValues | ( | ) |
Get the local values merged into the values of the global language file.
The returned array contains:
Definition at line 185 of file class.ilObjLanguageExt.php.
References _getValues(), and getGlobalLanguageFile().
ilObjLanguageExt::getUnchangedValues | ( | $a_modules = array() , |
|
$a_pattern = '' |
|||
) |
Get only the unchanged values from the database which are equal to the original language file.
array | list of modules |
array | search pattern |
Definition at line 132 of file class.ilObjLanguageExt.php.
References _getValues().
ilObjLanguageExt::ilObjLanguageExt | ( | $a_id = 0 , |
|
$a_call_by_reference = false |
|||
) |
Constructor.
Definition at line 20 of file class.ilObjLanguageExt.php.
References ilObjLanguage\ilObjLanguage().
ilObjLanguageExt::importLanguageFile | ( | $a_file, | |
$a_mode_existing = 'keepnew' |
|||
) |
Import a language file into the ilias database.
string | handling of existing values ('keepall','keepnew','replace','delete') |
Definition at line 226 of file class.ilObjLanguageExt.php.
References $ilErr, ilObjLanguage\$key, ilObjLanguage\_deleteLangData(), _saveValues(), getAllValues(), and getChangedValues().
ilObjLanguageExt::setLocal | ( | $a_local = true | ) |
Set the local status of the language.
boolean | local status (true/false) |
Definition at line 40 of file class.ilObjLanguageExt.php.
References ilObjLanguage\isInstalled(), ilObject\setDescription(), and ilObject\update().