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 ($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	$cached_check_translate

Detailed Description

Definition at line 17 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

static

Returns

boolean maintenance possible (true/false)

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

References $DIC, $ilSetting, and $ilUser.

Referenced by ilObjLanguageExtGUI\executeCommand().

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

        if ($ilUser->getId()) {
            $ref_id = self::_lookupLangFolderRefId();
            return $rbacsystem->checkAccess("read,write", (int) $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

static

Returns

boolean translation possible (true/false)

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

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

Referenced by ilCOPageGlobalTemplate\fillFooter(), ilRTEGlobalTemplate\fillFooter(), ilDataCollectionGlobalTemplate\fillFooter(), ilGlobalTemplate\fillFooter(), and ILIAS\UICore\PageContentProvider\getFooterModification().

    {
        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", (int) $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.

Returns

array list of module names

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

References $_SESSION.

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

    {
        $saved = $_SESSION['lang_ext_maintenance']['used_modules'];
        return is_array($saved) ? $saved : array();
    }

Here is the caller graph for this function:

_getSavedTopics()

static ilObjLanguageAccess::_getSavedTopics ( )

static

Get the stored topics from the user session.

Returns

array list of module names

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

References $_SESSION.

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

    {
        $saved = $_SESSION['lang_ext_maintenance']['used_topics'];
        return is_array($saved) ? $saved : array();
    }

Here is the caller graph for this function:

_getTranslationLink()

static ilObjLanguageAccess::_getTranslationLink ( )

static

Get the link to translate the current page.

Returns

string translation link

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

Referenced by ilCOPageGlobalTemplate\fillFooter(), ilRTEGlobalTemplate\fillFooter(), ilDataCollectionGlobalTemplate\fillFooter(), ilGlobalTemplate\fillFooter(), and ILIAS\UICore\PageContentProvider\getFooterModification().

    {
        // 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 151 of file class.ilObjLanguageAccess.php.

References $_GET.

Referenced by ilLanguageExtTableGUI\__construct(), ilObjLanguageExtGUI\addAdminLocatorItems(), ilRTEGlobalTemplate\fillFooter(), ilCOPageGlobalTemplate\fillFooter(), ilDataCollectionGlobalTemplate\fillFooter(), ilGlobalTemplate\fillFooter(), ilObjLanguageExtGUI\getAdminTabs(), ILIAS\UICore\PageContentProvider\getFooterModification(), ilLanguageExtTableGUI\initFilter(), ilObjLanguageExtGUI\setTitleAndDescription(), and ilObjLanguageExtGUI\viewObject().

    {
        return (strtolower($_GET['cmdClass'] == 'ilobjlanguageextgui') and $_GET['view_mode'] == "translate");
    }

Here is the caller graph for this function:

_lookupId()

static ilObjLanguageAccess::_lookupId (   $a_key )

static

Lookup the object ID for a language key.

Parameters

string	language key
integer	language object id

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

References $DIC, and $ilDB.

Referenced by ilObjLanguageExtGUI\__construct().

    {
        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 $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.

Returns

int language folder ref_id

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

References $DIC, and $ilDB.

    {
        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 $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 161 of file class.ilObjLanguageAccess.php.

References $_SESSION, $DIC, and $lng.

Referenced by ilCOPageGlobalTemplate\getSpecial(), ilRTEGlobalTemplate\getSpecial(), ilDataCollectionGlobalTemplate\getSpecial(), ilGlobalTemplate\getSpecial(), ilGlobalPageTemplate\printToStdout(), ilCOPageGlobalTemplate\printToStdout(), ilRTEGlobalTemplate\printToStdout(), ilDataCollectionGlobalTemplate\printToStdout(), ILIAS\ResourceStorage\Services\UICore\MetaTemplate\PageContentGUI\renderPage(), and ilGlobalTemplate\renderPage().

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

        if (self::_checkTranslate() and !self::_isPageTranslation()) {
            $_SESSION['lang_ext_maintenance']['used_modules'] = array_keys($lng->getUsedModules());
            $_SESSION['lang_ext_maintenance']['used_topics'] = array_keys($lng->getUsedTopics());
        }
    }

Here is the caller graph for this function:

Field Documentation

$cached_check_translate

ilObjLanguageAccess::$cached_check_translate

staticprotected

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

---

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

• Services/Language/classes/class.ilObjLanguageAccess.php