Inheritance diagram for ilObjLanguageFolderGUI:

Collaboration diagram for ilObjLanguageFolderGUI:

Public Member Functions
	__construct (?array $a_data, int $a_id, bool $a_call_by_reference)
	Constructor. More...

	viewObject ()
	show installed languages More...

	installObject ()
	install languages More...

	installLocalObject ()
	Install local language modifications. More...

	uninstallObject ()
	uninstall language More...

	uninstallChangesObject ()
	Uninstall local changes in the database. More...

	refreshObject ()
	update all installed languages More...

	refreshSelectedObject ()
	update selected languages More...

	setUserLanguageObject ()
	set user language More...

	setSystemLanguageObject ()
	set the system language More...

	checkLanguageObject ()
	check all languages More...

	out ()

	getAdminTabs ()

	executeCommand ()

	confirmRefreshObject ()

	confirmRefreshSelectedObject (array $a_ids=array())

	confirmUninstallObject ()

	confirmUninstallChangesObject ()

	getActions ()
	Get Actions. More...

	listDeprecatedObject ()
	Download deprecated lang entries. More...

	downloadDeprecatedObject ()
	Download deprecated lang entries. More...

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

	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 $desc)

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

Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	getTabs ()
	get tabs More...

	disableLanguageDetectionObject ()
	Disable language detection. More...

	enableLanguageDetectionObject ()
	Enable language detection. More...

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms (string $new_type)
	Init creation forms. More...

	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
HTTPServices	$http

Refinery	$refinery

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

int	$id

bool	$referenced

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 = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Member Functions
	getPostId ()

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	_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)

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

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

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Detailed Description

Class ilObjLanguageFolderGUI.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

ilObjLanguageFolderGUI: ilPermissionGUI

Definition at line 34 of file class.ilObjLanguageFolderGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjLanguageFolderGUI::__construct	(	?array	$a_data,
		int	$a_id,
		bool	$a_call_by_reference
	)

Constructor.

Definition at line 42 of file class.ilObjLanguageFolderGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

     {
         global $DIC;
         $this->type = "lngf";
         parent::__construct($a_data, $a_id, $a_call_by_reference, false);
         //$_GET["sort_by"] = "language";
         $this->lng->loadLanguageModule("lng");
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkLanguageObject()

ilObjLanguageFolderGUI::checkLanguageObject ( )

check all languages

Definition at line 396 of file class.ilObjLanguageFolderGUI.php.

References ilObjectGUI\checkPermission(), and out().

                                          : void
     {
         $this->checkPermission("write");
         $this->data = $this->object->checkAllLanguages();
         $this->out();
     }

Here is the call graph for this function:

◆ confirmRefreshObject()

ilObjLanguageFolderGUI::confirmRefreshObject ( )

Definition at line 460 of file class.ilObjLanguageFolderGUI.php.

References $lang, ilObject\_getObjectsByType(), ilObjectGUI\checkPermission(), and confirmRefreshSelectedObject().

                                           : void
     {
         $this->checkPermission("write");
 
         $languages = ilObject::_getObjectsByType("lng");
 
         $ids = array();
         foreach ($languages as $lang) {
             $langObj = new ilObjLanguage((int) $lang["obj_id"], false);
             if ($langObj->isInstalled()) {
                 $ids[] = $lang["obj_id"];
             }
         }
         $this->confirmRefreshSelectedObject($ids);
     }

Here is the call graph for this function:

◆ confirmRefreshSelectedObject()

ilObjLanguageFolderGUI::confirmRefreshSelectedObject ( array $a_ids = array() )

Definition at line 476 of file class.ilObjLanguageFolderGUI.php.

References ilObject\$id, ilObjLanguage\_getLastLocalChange(), ilObject\_lookupTitle(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), getPostId(), IL_CAL_DATETIME, and ILIAS\Repository\lng().

Referenced by confirmRefreshObject().

                                                                         : void
     {
         $this->checkPermission("write");
         $this->lng->loadLanguageModule("meta");
 
         $header = '';
         $ids = [];
         if (!empty($a_ids)) {
             $ids = $a_ids;
             $header = $this->lng->txt("lang_refresh_confirm");
         } elseif (!empty($post_id = $this->getPostId())) {
             $ids = $post_id;
             $header = $this->lng->txt("lang_refresh_confirm_selected");
         } else {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         $conf_screen = new ilConfirmationGUI();
         $some_changed = false;
         foreach ($ids as $id) {
             $lang_key = ilObject::_lookupTitle((int) $id);
             $lang_title = $this->lng->txt("meta_l_" . $lang_key);
             $last_change = ilObjLanguage::_getLastLocalChange($lang_key);
             if (!empty($last_change)) {
                 $some_changed = true;
                 $lang_title .= " (" . $this->lng->txt("last_change") . " "
                     . ilDatePresentation::formatDate(new ilDateTime($last_change, IL_CAL_DATETIME)) . ")";
             }
             $conf_screen->addItem("id[]", (string) $id, $lang_title);
         }
 
         $conf_screen->setFormAction($this->ctrl->getFormAction($this));
         if ($some_changed) {
             $header .= "<br />" . $this->lng->txt("lang_refresh_confirm_info");
         }
         $conf_screen->setHeaderText($header);
         $conf_screen->setCancel($this->lng->txt("cancel"), "view");
         $conf_screen->setConfirm($this->lng->txt("ok"), "refreshSelected");
         $this->tpl->setContent($conf_screen->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmUninstallChangesObject()

ilObjLanguageFolderGUI::confirmUninstallChangesObject ( )

Definition at line 535 of file class.ilObjLanguageFolderGUI.php.

References ilObject\$id, ilObject\_lookupTitle(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), getPostId(), and ILIAS\Repository\lng().

                                                    : void
     {
         $this->checkPermission('write');
 
         $this->lng->loadLanguageModule("meta");
         $conf_screen = new ilConfirmationGUI();
         $conf_screen->setFormAction($this->ctrl->getFormAction($this));
         $conf_screen->setHeaderText($this->lng->txt("lang_uninstall_changes_confirm"));
         foreach ($this->getPostId() as $id) {
             $lang_title = ilObject::_lookupTitle($id);
             $conf_screen->addItem("id[]", (string) $id, $this->lng->txt("meta_l_" . $lang_title));
         }
         $conf_screen->setCancel($this->lng->txt("cancel"), "view");
         $conf_screen->setConfirm($this->lng->txt("ok"), "uninstallChanges");
         $this->tpl->setContent($conf_screen->getHTML());
     }

Here is the call graph for this function:

◆ confirmUninstallObject()

ilObjLanguageFolderGUI::confirmUninstallObject ( )

Definition at line 518 of file class.ilObjLanguageFolderGUI.php.

References ilObject\$id, ilObject\_lookupTitle(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), getPostId(), and ILIAS\Repository\lng().

                                             : void
     {
         $this->checkPermission("write");
 
         $this->lng->loadLanguageModule("meta");
         $conf_screen = new ilConfirmationGUI();
         $conf_screen->setFormAction($this->ctrl->getFormAction($this));
         $conf_screen->setHeaderText($this->lng->txt("lang_uninstall_confirm"));
         foreach ($this->getPostId() as $id) {
             $lang_title = ilObject::_lookupTitle($id);
             $conf_screen->addItem("id[]", (string) $id, $this->lng->txt("meta_l_" . $lang_title));
         }
         $conf_screen->setCancel($this->lng->txt("cancel"), "view");
         $conf_screen->setConfirm($this->lng->txt("ok"), "uninstall");
         $this->tpl->setContent($conf_screen->getHTML());
     }

Here is the call graph for this function:

◆ disableLanguageDetectionObject()

ilObjLanguageFolderGUI::disableLanguageDetectionObject ( )

protected

Disable language detection.

Definition at line 572 of file class.ilObjLanguageFolderGUI.php.

References ILIAS\Repository\lng(), ILIAS\Repository\settings(), and viewObject().

                                                        : void
     {
         $this->settings->set("lang_detection", '0');
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("saved_successfully"));
         $this->viewObject();
     }

Here is the call graph for this function:

◆ downloadDeprecatedObject()

ilObjLanguageFolderGUI::downloadDeprecatedObject ( )

Download deprecated lang entries.

Definition at line 613 of file class.ilObjLanguageFolderGUI.php.

References $d, ILIAS\LTI\ToolProvider\$key, $res, and ilUtil\deliverData().

                                               : void
     {
         include_once "./Services/Language/classes/class.ilLangDeprecated.php";
         $d = new ilLangDeprecated();
         $res = "";
         foreach ($d->getDeprecatedLangVars() as $key => $mod) {
             $res .= $mod . "," . $key . "\n";
         }
 
         ilUtil::deliverData($res, "lang_deprecated.csv");
     }

Here is the call graph for this function:

◆ enableLanguageDetectionObject()

ilObjLanguageFolderGUI::enableLanguageDetectionObject ( )

protected

Enable language detection.

Definition at line 582 of file class.ilObjLanguageFolderGUI.php.

References ILIAS\Repository\lng(), ILIAS\Repository\settings(), and viewObject().

                                                       : void
     {
         $this->settings->set("lang_detection", '1');
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("saved_successfully"));
         $this->viewObject();
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjLanguageFolderGUI::executeCommand ( )

Definition at line 429 of file class.ilObjLanguageFolderGUI.php.

References ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), and ilObjectGUI\prepareOutput().

                                     : void
     {
         // always check read permission, needed write permissions are checked in the *Object functions
         $this->checkPermission("read", "", $this->type, $this->ref_id);
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
         $this->prepareOutput();
 
         switch ($next_class) {
             case "ilpermissiongui":
                 include_once "Services/AccessControl/classes/class.ilPermissionGUI.php";
                 $perm_gui = new ilPermissionGUI($this);
                 $this->tabs_gui->activateTab("perm_settings");
                 $this->ctrl->forwardCommand($perm_gui);
                 break;
 
             default:
                 $this->tabs_gui->activateTab("settings");
 
                 if (!$cmd) {
                     $cmd = "view";
                 }
 
                 $cmd .= "Object";
                 $this->$cmd();
 
                 break;
         }
     }

Here is the call graph for this function:

◆ getActions()

ilObjLanguageFolderGUI::getActions ( )

Get Actions.

Deprecated:: seems to be not needed anymore

Definition at line 556 of file class.ilObjLanguageFolderGUI.php.

                                 : array
     {
         // standard actions for container
         return array(
             "install" => array("name" => "install", "lng" => "install"),
             "installLocal" => array("name" => "installLocal", "lng" => "install_local"),
             "uninstall" => array("name" => "uninstall", "lng" => "uninstall"),
             "refresh" => array("name" => "confirmRefreshSelected", "lng" => "refresh"),
             "setSystemLanguage" => array("name" => "setSystemLanguage", "lng" => "setSystemLanguage"),
             "setUserLanguage" => array("name" => "setUserLanguage", "lng" => "setUserLanguage")
         );
     }

◆ getAdminTabs()

ilObjLanguageFolderGUI::getAdminTabs ( )

Definition at line 409 of file class.ilObjLanguageFolderGUI.php.

References getTabs().

                                   : void
     {
         $this->getTabs();
     }

Here is the call graph for this function:

◆ getPostId()

ilObjLanguageFolderGUI::getPostId ( )

private

Returns: int[]|mixed

Definition at line 628 of file class.ilObjLanguageFolderGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by confirmRefreshSelectedObject(), confirmUninstallChangesObject(), confirmUninstallObject(), installLocalObject(), installObject(), refreshSelectedObject(), setSystemLanguageObject(), setUserLanguageObject(), uninstallChangesObject(), and uninstallObject().

     {
         $post_field = [];
         if ($this->http->wrapper()->post()->has("id")) {
             $post_field = $this->http->wrapper()->post()->retrieve(
                 "id",
                 $this->refinery->kindlyTo()->dictOf(
                     $this->refinery->kindlyTo()->int()
                 )
             );
         }
         if ($post_field == null) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
             $this->ctrl->redirect($this, "view");
         }
         return $post_field;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTabs()

ilObjLanguageFolderGUI::getTabs ( )

protected

get tabs

Parameters

object tabs gui object

Definition at line 418 of file class.ilObjLanguageFolderGUI.php.

References ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by getAdminTabs().

                                 : void
     {
         if ($this->checkPermissionBool("read")) {
             $this->tabs_gui->addTab("settings", $this->lng->txt("settings"), $this->ctrl->getLinkTarget($this, "view"));
         }
 
         if ($this->checkPermissionBool("edit_permission")) {
             $this->tabs_gui->addTab("perm_settings", $this->lng->txt("perm_settings"), $this->ctrl->getLinkTargetByClass(array(self::class,"ilpermissiongui"), "perm"));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ installLocalObject()

ilObjLanguageFolderGUI::installLocalObject ( )

Install local language modifications.

Definition at line 139 of file class.ilObjLanguageFolderGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilObjectGUI\$obj_id, ilObjectGUI\checkPermission(), getPostId(), ILIAS\Repository\lng(), and out().

                                         : void
     {
         $this->checkPermission("write");
         $this->lng->loadLanguageModule("meta");
 
         foreach ($this->getPostId() as $obj_id) {
             $langObj = new ilObjLanguage($obj_id);
             $key = $langObj->install();
 
             if ($key !== "") {
                 $lang_installed[] = $key;
             }
 
             unset($langObj);
 
             $langObj = new ilObjLanguage($obj_id);
             $key = $langObj->install("local");
 
             if ($key !== "") {
                 $local_installed[] = $key;
             }
 
             unset($langObj);
         }
 
         if (isset($lang_installed)) {
             if (count($lang_installed) === 1) {
                 $this->data = $this->lng->txt("meta_l_" . $lang_installed[0]) . " " . strtolower($this->lng->txt("installed")) . ".";
             } else {
                 $langnames = [];
                 foreach ($lang_installed as $lang_key) {
                     $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                 }
                 $this->data = implode(", ", $langnames) . " " . strtolower($this->lng->txt("installed")) . ".";
             }
         }
 
         if (isset($local_installed)) {
             if (count($local_installed) === 1) {
                 $this->data .= " " . $this->lng->txt("meta_l_" . $local_installed[0]) . " " . $this->lng->txt("local_language_file") . " " . strtolower($this->lng->txt("installed")) . ".";
             } else {
                 $langnames = [];
                 foreach ($local_installed as $lang_key) {
                     $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                 }
                 $this->data .= " " . implode(", ", $langnames) . " " . $this->lng->txt("local_language_files") . " " . strtolower($this->lng->txt("installed")) . ".";
             }
         } else {
             $this->data .= " " . $this->lng->txt("local_languages_already_installed");
         }
 
         $this->out();
     }

Here is the call graph for this function:

◆ installObject()

ilObjLanguageFolderGUI::installObject ( )

install languages

Definition at line 102 of file class.ilObjLanguageFolderGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilObjectGUI\$obj_id, ilObjectGUI\checkPermission(), getPostId(), ILIAS\Repository\lng(), and out().

                                    : void
     {
         $this->checkPermission("write");
         $this->lng->loadLanguageModule("meta");
 
         foreach ($this->getPostId() as $obj_id) {
             $langObj = new ilObjLanguage((int) $obj_id);
             $key = $langObj->install();
 
             if ($key !== "") {
                 $lang_installed[] = $key;
             }
 
             unset($langObj);
         }
 
         if (isset($lang_installed)) {
             if (count($lang_installed) === 1) {
                 $this->data = $this->lng->txt("meta_l_" . $lang_installed[0]) . " " . strtolower($this->lng->txt("installed")) . ".";
             } else {
                 $langnames = [];
                 foreach ($lang_installed as $lang_key) {
                     $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                 }
                 $this->data = implode(", ", $langnames) . " " . strtolower($this->lng->txt("installed")) . ".";
             }
         } else {
             $this->data = $this->lng->txt("languages_already_installed");
         }
 
         $this->out();
     }

Here is the call graph for this function:

◆ listDeprecatedObject()

ilObjLanguageFolderGUI::listDeprecatedObject ( )

Download deprecated lang entries.

Definition at line 592 of file class.ilObjLanguageFolderGUI.php.

References $d, ILIAS\LTI\ToolProvider\$key, $res, ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), and ILIAS\Repository\toolbar().

                                           : void
     {
         $button = ilLinkButton::getInstance();
         $button->setCaption("download");
         $button->setUrl($this->ctrl->getLinkTarget($this, "downloadDeprecated"));
         $this->toolbar->addButtonInstance($button);
 
         include_once "./Services/Language/classes/class.ilLangDeprecated.php";
 
         $d = new ilLangDeprecated();
         $res = "";
         foreach ($d->getDeprecatedLangVars() as $key => $mod) {
             $res .= $mod . "," . $key . "\n";
         }
 
         $this->tpl->setContent("<pre>" . $res . "</pre>");
     }

Here is the call graph for this function:

◆ out()

ilObjLanguageFolderGUI::out ( )

Definition at line 403 of file class.ilObjLanguageFolderGUI.php.

References ILIAS\Repository\ctrl().

Referenced by checkLanguageObject(), installLocalObject(), installObject(), refreshObject(), refreshSelectedObject(), setSystemLanguageObject(), setUserLanguageObject(), uninstallChangesObject(), and uninstallObject().

                          : void
     {
         $this->tpl->setOnScreenMessage('info', $this->data, true);
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refreshObject()

ilObjLanguageFolderGUI::refreshObject ( )

update all installed languages

Definition at line 276 of file class.ilObjLanguageFolderGUI.php.

References ilObjectGUI\checkPermission(), ILIAS\Repository\lng(), out(), and ilObjLanguage\refreshAll().

                                    : void
     {
         $this->checkPermission("write");
 
         ilObjLanguage::refreshAll();
         $this->data = $this->lng->txt("languages_updated");
         $this->out();
     }

Here is the call graph for this function:

◆ refreshSelectedObject()

ilObjLanguageFolderGUI::refreshSelectedObject ( )

update selected languages

Definition at line 289 of file class.ilObjLanguageFolderGUI.php.

References ilObject\$id, ilObjectGUI\checkPermission(), getPostId(), ILIAS\Repository\lng(), out(), and ilObjLanguage\refreshPlugins().

                                            : void
     {
         $this->checkPermission("write");
         $this->data = $this->lng->txt("selected_languages_updated");
         $this->lng->loadLanguageModule("meta");
 
         $refreshed = array();
         foreach ($this->getPostId() as $id) {
             $langObj = new ilObjLanguage((int) $id, false);
             if ($langObj->refresh()) {
                 $refreshed[] = $langObj->getKey();
                 $this->data .= "<br />" . $this->lng->txt("meta_l_" . $langObj->getKey());
             }
             unset($langObj);
         }
 
         ilObjLanguage::refreshPlugins($refreshed);
         $this->out();
     }

Here is the call graph for this function:

◆ setSystemLanguageObject()

ilObjLanguageFolderGUI::setSystemLanguageObject ( )

set the system language

Definition at line 356 of file class.ilObjLanguageFolderGUI.php.

References ilObjectGUI\$obj_id, ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), getPostId(), ILIAS\Repository\lng(), and out().

                                              : void
     {
         $this->checkPermission("write");
         $this->lng->loadLanguageModule("meta");
 
         $post_id = $this->getPostId();
 
         if (count($post_id) !== 1) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("choose_only_one_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         $obj_id = $post_id[0];
 
         $newSysLangObj = new ilObjLanguage($obj_id);
 
         if ($newSysLangObj->isSystemLanguage()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newSysLangObj->getKey()) . " " . $this->lng->txt("is_already_your") . " " . $this->lng->txt("system_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         if (!$newSysLangObj->isInstalled()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newSysLangObj->getKey()) . " " . $this->lng->txt("language_not_installed") . "<br/>" . $this->lng->txt("action_aborted"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         $this->ilias->setSetting("language", $newSysLangObj->getKey());
 
         // update ini-file
         $this->ilias->ini->setVariable("language", "default", $newSysLangObj->getKey());
         $this->ilias->ini->write();
 
         $this->data = $this->lng->txt("system_language") . " " . $this->lng->txt("changed_to") . " " . $this->lng->txt("meta_l_" . $newSysLangObj->getKey()) . ".";
 
         $this->out();
     }

Here is the call graph for this function:

◆ setUserLanguageObject()

ilObjLanguageFolderGUI::setUserLanguageObject ( )

set user language

Definition at line 312 of file class.ilObjLanguageFolderGUI.php.

References $DIC, $ilUser, ilObjectGUI\$obj_id, ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), getPostId(), ILIAS\Repository\lng(), and out().

                                            : void
     {
         global $DIC;
         $ilUser = $DIC->user();
 
         $this->checkPermission("write");
         $this->lng->loadLanguageModule("meta");
 
         require_once "./Services/User/classes/class.ilObjUser.php";
 
         $post_id = $this->getPostId();
 
         if (count($post_id) !== 1) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("choose_only_one_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         $obj_id = $post_id[0];
 
         $newUserLangObj = new ilObjLanguage($obj_id);
 
         if ($newUserLangObj->isUserLanguage()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newUserLangObj->getKey()) . " " . $this->lng->txt("is_already_your") . " " . $this->lng->txt("user_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         if (!$newUserLangObj->isInstalled()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newUserLangObj->getKey()) . " " . $this->lng->txt("language_not_installed") . "<br/>" . $this->lng->txt("action_aborted"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         $curUser = new ilObjUser($ilUser->getId());
         $curUser->setLanguage($newUserLangObj->getKey());
         $curUser->update();
 
         $this->data = $this->lng->txt("user_language") . " " . $this->lng->txt("changed_to") . " " . $this->lng->txt("meta_l_" . $newUserLangObj->getKey()) . ".";
 
         $this->out();
     }

Here is the call graph for this function:

◆ uninstallChangesObject()

ilObjLanguageFolderGUI::uninstallChangesObject ( )

Uninstall local changes in the database.

Definition at line 244 of file class.ilObjLanguageFolderGUI.php.

References ilObject\$id, ilObjectGUI\checkPermission(), getPostId(), ILIAS\Repository\lng(), out(), and ilObjLanguage\refreshPlugins().

                                             : void
     {
         $this->checkPermission("write");
 
         $this->data = $this->lng->txt("selected_languages_updated");
         $this->lng->loadLanguageModule("meta");
         $refreshed = [];
 
         foreach ($this->getPostId() as $id) {
             $langObj = new ilObjLanguage((int) $id, false);
 
             if ($langObj->isInstalled()) {
                 if ($langObj->check()) {
                     $langObj->flush("all");
                     $langObj->insert();
                     $langObj->setTitle($langObj->getKey());
                     $langObj->setDescription("installed");
                     $langObj->update();
                     $refreshed[] = $langObj->getKey();
                 }
                 $this->data .= "<br />" . $this->lng->txt("meta_l_" . $langObj->getKey());
             }
 
             unset($langObj);
         }
         ilObjLanguage::refreshPlugins($refreshed);
         $this->out();
     }

Here is the call graph for this function:

◆ uninstallObject()

ilObjLanguageFolderGUI::uninstallObject ( )

uninstall language

Definition at line 197 of file class.ilObjLanguageFolderGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilObjectGUI\$obj_id, ilObjectGUI\checkPermission(), getPostId(), ILIAS\Repository\lng(), and out().

                                      : void
     {
         $this->checkPermission('write');
         $this->lng->loadLanguageModule("meta");
 
         $sys_lang = false;
         $usr_lang = false;
 
         // uninstall all selected languages
         foreach ($this->getPostId() as $obj_id) {
             $langObj = new ilObjLanguage($obj_id);
             if (!($sys_lang = $langObj->isSystemLanguage()) && !($usr_lang = $langObj->isUserLanguage())) {
                 $key = $langObj->uninstall();
                 if ($key !== "") {
                     $lang_uninstalled[] = $key;
                 }
             }
             unset($langObj);
         }
 
         // generate output message
         if (isset($lang_uninstalled)) {
             if (count($lang_uninstalled) === 1) {
                 $this->data = $this->lng->txt("meta_l_" . $lang_uninstalled[0]) . " " . $this->lng->txt("uninstalled");
             } else {
                 $langnames = [];
                 foreach ($lang_uninstalled as $lang_key) {
                     $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                 }
 
                 $this->data = implode(", ", $langnames) . " " . $this->lng->txt("uninstalled");
             }
         } elseif ($sys_lang) {
             $this->data = $this->lng->txt("cannot_uninstall_systemlanguage");
         } elseif ($usr_lang) {
             $this->data = $this->lng->txt("cannot_uninstall_language_in_use");
         } else {
             $this->data = $this->lng->txt("languages_already_uninstalled");
         }
 
         $this->out();
     }

Here is the call graph for this function:

◆ viewObject()

ilObjLanguageFolderGUI::viewObject ( )

show installed languages

Definition at line 56 of file class.ilObjLanguageFolderGUI.php.

References $check, $DIC, ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\toolbar().

Referenced by disableLanguageDetectionObject(), and enableLanguageDetectionObject().

                                 : void
     {
         global $DIC;
 
         if ($this->checkPermissionBool("write")) {
             // refresh
             $refresh = ilLinkButton::getInstance();
             $refresh->setUrl($this->ctrl->getLinkTarget($this, "confirmRefresh"));
             $refresh->setCaption("refresh_languages");
             $this->toolbar->addButtonInstance($refresh);
 
             // check languages
             $check = ilLinkButton::getInstance();
             $check->setUrl($this->ctrl->getLinkTarget($this, "checkLanguage"));
             $check->setCaption("check_languages");
             $this->toolbar->addButtonInstance($check);
         }
 
         $ilClientIniFile = $DIC["ilClientIniFile"];
         if ($ilClientIniFile->variableExists("system", "LANGUAGE_LOG")) {
             $download = ilLinkButton::getInstance();
             $download->setUrl($this->ctrl->getLinkTarget($this, "listDeprecated"));
             $download->setCaption("lng_download_deprecated");
             $this->toolbar->addButtonInstance($download);
         }
 
         if ($this->checkPermissionBool("write")) {
             if (!$this->settings->get("lang_detection")) {
                 // Toggle Button for auto language detection (toggle off)
                 $toggleButton = $DIC->ui()->factory()->button()->toggle("", $DIC->ctrl()->getLinkTarget($this, "enableLanguageDetection"), $DIC->ctrl()->getLinkTarget($this, "disableLanguageDetection"), false)
                     ->withLabel($this->lng->txt("language_detection"))->withAriaLabel($this->lng->txt("lng_enable_language_detection"));
             } else {
                 // Toggle Button for auto language detection (toggle on)
                 $toggleButton = $DIC->ui()->factory()->button()->toggle("", $DIC->ctrl()->getLinkTarget($this, "enableLanguageDetection"), $DIC->ctrl()->getLinkTarget($this, "disableLanguageDetection"), true)
                     ->withLabel($this->lng->txt("language_detection"))->withAriaLabel($this->lng->txt("lng_disable_language_detection"));
             }
             $this->toolbar->addComponent($toggleButton);
         }
 
         $ltab = new ilLanguageTableGUI($this, "view", $this->object);
         $this->tpl->setContent($ltab->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $http

HTTPServices ilObjLanguageFolderGUI::$http

protected

Definition at line 36 of file class.ilObjLanguageFolderGUI.php.

◆ $refinery

Refinery ilObjLanguageFolderGUI::$refinery

protected

Definition at line 37 of file class.ilObjLanguageFolderGUI.php.

The documentation for this class was generated from the following file:

Services/Language/classes/class.ilObjLanguageFolderGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkLanguageObject()

◆ confirmRefreshObject()

◆ confirmRefreshSelectedObject()

◆ confirmUninstallChangesObject()

◆ confirmUninstallObject()

◆ disableLanguageDetectionObject()

◆ downloadDeprecatedObject()

◆ enableLanguageDetectionObject()

◆ executeCommand()

◆ getActions()

◆ getAdminTabs()

◆ getPostId()

◆ getTabs()

◆ installLocalObject()

◆ installObject()

◆ listDeprecatedObject()

◆ out()

◆ refreshObject()

◆ refreshSelectedObject()

◆ setSystemLanguageObject()

◆ setUserLanguageObject()

◆ uninstallChangesObject()

◆ uninstallObject()

◆ viewObject()

Field Documentation

◆ $http

◆ $refinery