ilObjLanguageAccess Class Reference

Collaboration diagram for ilObjLanguageAccess:

Static Public Member Functions
static	_checkTranslate ()
	Permission check for translations. More...
static	_checkMaintenance ()
	Permission check for language maintenance (import/export) More...
static	_lookupLangFolderRefId ()
	Lookup the ref_id of the global language folder. More...
static	_lookupId (string $a_key)
	Lookup the object ID for a language key. More...
static	_getTranslationLink ()
	Get the link to translate the current page. More...
static	_isPageTranslation ()
	Check if the current request is a page translation. More...
static	_saveUsages ()
	Store the collected language variable usages in the user session This should be called as late as possible in a request. More...
static	_getSavedModules ()
	Get the stored modules from the user session. More...
static	_getSavedTopics ()
	Get the stored topics from the user session. More...

Static Protected Attributes
static bool	$cached_check_translate

Detailed Description

Definition at line 33 of file class.ilObjLanguageAccess.php.

Member Function Documentation

_checkMaintenance()

static ilObjLanguageAccess::_checkMaintenance ( )

static

Permission check for language maintenance (import/export)

• The user must have read and write permissions to the language folder

Return whether maintenance is possible (true/false)

Definition at line 80 of file class.ilObjLanguageAccess.php.

References $DIC, $ilSetting, and $ref_id.

Referenced by ilObjLanguageExtGUI\executeCommand().

                                              : bool
    {
        global $DIC;
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
        $rbacsystem = $DIC->rbac()->system();

        if ($ilUser->getId()) {
            $ref_id = self::_lookupLangFolderRefId();
            return $rbacsystem->checkAccess("read,write", $ref_id);
        }
        return false;
    }

Here is the caller graph for this function:

_checkTranslate()

static ilObjLanguageAccess::_checkTranslate ( )

static

Permission check for translations.

This check is used for displaying the translation link on each page

• The page translation of the current language must be turned on
• The user must have read and write permissions to the language folder

Return whether translation is possible (true/false)

Definition at line 46 of file class.ilObjLanguageAccess.php.

References $DIC, $ilSetting, $lng, and $ref_id.

Referenced by ilFooterStandardGroupsProvider\getEntries().

                                            : bool
    {
        global $DIC;
        $lng = $DIC->language();
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
        $rbacsystem = $DIC->rbac()->system();

        if (isset(self::$cached_check_translate)) {
            return self::$cached_check_translate;
        }

        if (!$ilSetting->get("lang_translate_" . $lng->getLangKey())) {
            self::$cached_check_translate = false;
            return self::$cached_check_translate;
        }

        if ($ilUser->getId()) {
            $ref_id = self::_lookupLangFolderRefId();
            self::$cached_check_translate = $rbacsystem->checkAccess("read,write", $ref_id);
        } else {
            self::$cached_check_translate = false;
        }

        return self::$cached_check_translate;
    }

Here is the caller graph for this function:

_getSavedModules()

static ilObjLanguageAccess::_getSavedModules ( )

static

Get the stored modules from the user session.

Return list of module names

Definition at line 199 of file class.ilObjLanguageAccess.php.

References ilSession\get().

Referenced by ilObjLanguageExtGUI\initAddNewEntryForm(), and ilObjLanguageExtGUI\viewObject().

                                             : array
    {
        $saved = [];
        $lang_ext_maintenance_from_session = ilSession::get("lang_ext_maintenance");
        if (is_array($lang_ext_maintenance_from_session) && isset($lang_ext_maintenance_from_session["used_modules"])) {
            $saved = $lang_ext_maintenance_from_session["used_modules"];
        }
        return $saved;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getSavedTopics()

static ilObjLanguageAccess::_getSavedTopics ( )

static

Get the stored topics from the user session.

Return list of module names

Definition at line 214 of file class.ilObjLanguageAccess.php.

References ilSession\get().

Referenced by ilObjLanguageExtGUI\initAddNewEntryForm(), and ilObjLanguageExtGUI\viewObject().

                                            : array
    {
        $saved = [];
        $lang_ext_maintenance_from_session = ilSession::get("lang_ext_maintenance");
        if (is_array($lang_ext_maintenance_from_session) && isset($lang_ext_maintenance_from_session["used_topics"])) {
            $saved = $lang_ext_maintenance_from_session["used_topics"];
        }
        return $saved;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getTranslationLink()

static ilObjLanguageAccess::_getTranslationLink ( )

static

Get the link to translate the current page.

Return translation link

Definition at line 138 of file class.ilObjLanguageAccess.php.

Referenced by ilFooterStandardGroupsProvider\getEntries().

                                                : string
    {
        // ref id must be given to prevent params being deleted by ilAdministrtionGUI
        return "ilias.php"
        . "?ref_id=" . self::_lookupLangFolderRefId()
        . "&baseClass=ilAdministrationGUI"
        . "&cmdClass=ilobjlanguageextgui"
        . "&view_mode=translate"
        . "&reset_offset=true";
    }

Here is the caller graph for this function:

_isPageTranslation()

static ilObjLanguageAccess::_isPageTranslation ( )

static

Check if the current request is a page translation.

The page translation mode is used when the translation of a single page is called by the translation link on a page footer. On this screen only the topics stored from the calling page are shown for translation and only a save function for these topics is offered.

Returns

bool page translation (true or false)

Definition at line 159 of file class.ilObjLanguageAccess.php.

References $DIC.

Referenced by ilLanguageExtTableGUI\__construct(), ilObjLanguageExtGUI\addAdminLocatorItems(), ilObjLanguageExtGUI\getAdminTabs(), ilFooterStandardGroupsProvider\getEntries(), ilLanguageExtTableGUI\initFilter(), ilObjLanguageExtGUI\setTitleAndDescription(), and ilObjLanguageExtGUI\viewObject().

                                               : bool
    {
        global $DIC;
        $cmdClass = "";
        $view_mode_get = "";
        if ($DIC->http()->wrapper()->query()->has("cmdClass")) {
            $cmdClass = $DIC->http()->wrapper()->query()->retrieve(
                "cmdClass",
                $DIC->refinery()->kindlyTo()->string()
            );
        }
        if ($DIC->http()->wrapper()->query()->has("view_mode")) {
            $view_mode_get = $DIC->http()->wrapper()->query()->retrieve(
                "view_mode",
                $DIC->refinery()->kindlyTo()->string()
            );
        }
        return (strtolower($cmdClass) === "ilobjlanguageextgui" && $view_mode_get === "translate");
    }

Here is the caller graph for this function:

_lookupId()

static ilObjLanguageAccess::_lookupId ( string  $a_key )

static

Lookup the object ID for a language key.

$a_key language key Return language object id

Definition at line 119 of file class.ilObjLanguageAccess.php.

References $DIC, $ilDB, and $q.

Referenced by ilObjLanguageExtGUI\__construct().

                                                   : int
    {
        global $DIC;
        $ilDB = $DIC->database();

        $q = "SELECT obj_id FROM object_data " .
        " WHERE type = " . $ilDB->quote("lng", "text") .
        " AND title = " . $ilDB->quote($a_key, "text");
        $set = $ilDB->query($q);
        $row = $ilDB->fetchAssoc($set);
        return (int) $row["obj_id"];
    }

Here is the caller graph for this function:

_lookupLangFolderRefId()

static ilObjLanguageAccess::_lookupLangFolderRefId ( )

static

Lookup the ref_id of the global language folder.

Return language folder ref_id

Definition at line 100 of file class.ilObjLanguageAccess.php.

References $DIC, $ilDB, and $q.

                                                   : int
    {
        global $DIC;
        $ilDB = $DIC->database();

        $q = "SELECT ref_id FROM object_reference r, object_data d" .
        " WHERE r.obj_id = d.obj_id AND d.type = " . $ilDB->quote("lngf", "text");
        $set = $ilDB->query($q);
        $row = $ilDB->fetchAssoc($set);
        return (int) $row["ref_id"];
    }

_saveUsages()

static ilObjLanguageAccess::_saveUsages ( )

static

Store the collected language variable usages in the user session This should be called as late as possible in a request.

Definition at line 183 of file class.ilObjLanguageAccess.php.

References $DIC, $lng, and ilSession\set().

Referenced by ilDataCollectionGlobalTemplate\getSpecial(), ilGlobalTemplate\getSpecial(), ilGlobalPageTemplate\printToStdout(), ilDataCollectionGlobalTemplate\printToStdout(), ILIAS\components\UICore\MetaTemplate\PageContentGUI\renderPage(), and ilGlobalTemplate\renderPage().

                                        : void
    {
        global $DIC;
        $lng = $DIC->language();

        if (self::_checkTranslate() and !self::_isPageTranslation()) {
            ilSession::set("lang_ext_maintenance", array("used_modules" => array_keys($lng->getUsedModules())));
            ilSession::set("lang_ext_maintenance", array("used_topics" => array_keys($lng->getUsedTopics())));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cached_check_translate

bool ilObjLanguageAccess::$cached_check_translate

staticprotected

Definition at line 35 of file class.ilObjLanguageAccess.php.

---

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

• components/ILIAS/Language/classes/class.ilObjLanguageAccess.php