ilPluginLanguage Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPluginLanguage:

Public Member Functions
	__construct (ilPluginInfo $plugin_info)
	getAvailableLangFiles ()
	Get array of all language files in the plugin. More...
	hasAvailableLangFiles ()
	getPrefix ()
	updateLanguages (?array $a_lang_keys=null)
	uninstall ()
	loadLanguageModule ()
	Load language module for plugin. More...
	txt (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...

Protected Member Functions
	getLanguageDirectory ()

Protected Attributes
ilPluginInfo	$plugin_info

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 25 of file class.ilPluginLanguage.php.

Constructor & Destructor Documentation

__construct()

ilPluginLanguage::__construct

(

ilPluginInfo

$plugin_info

)

Definition at line 29 of file class.ilPluginLanguage.php.

References $plugin_info.

    {
        $this->plugin_info = $plugin_info;
    }

Member Function Documentation

getAvailableLangFiles()

ilPluginLanguage::getAvailableLangFiles

(

)

Get array of all language files in the plugin.

Returns

array of [key => "en" (e.g.), file => ...]

Definition at line 44 of file class.ilPluginLanguage.php.

References getLanguageDirectory().

Referenced by hasAvailableLangFiles(), and updateLanguages().

                                           : array
    {
        $directory = $this->getLanguageDirectory();
        if (!@is_dir($directory)) {
            return [];
        }

        $langs = [];

        $dir = opendir($directory);
        while ($file = readdir($dir)) {
            if ($file === "." || $file === "..") {
                continue;
            }

            // directories
            if (@is_file($directory . "/" . $file) &&
                strpos($file, "ilias_") === 0 &&
                substr($file, strlen($file) - 5) === ".lang") {
                $langs[] = [
                    "key" => substr($file, 6, 2),
                    "file" => $file
                ];
            }
        }

        return $langs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLanguageDirectory()

ilPluginLanguage::getLanguageDirectory ( )

protected

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

Referenced by getAvailableLangFiles(), and updateLanguages().

                                             : string
    {
        return $this->plugin_info->getPath() . "/lang";
    }

Here is the caller graph for this function:

getPrefix()

ilPluginLanguage::getPrefix

(

)

Definition at line 78 of file class.ilPluginLanguage.php.

References XapiProxy\$plugin, and $plugin_info.

Referenced by loadLanguageModule(), txt(), uninstall(), and updateLanguages().

                               : string
    {
        $plugin = $this->plugin_info;
        $component = $plugin->getComponent();
        $slot = $plugin->getPluginSlot();

        return $component->getId() . "_" . $slot->getId() . "_" . $plugin->getId();
    }

Here is the caller graph for this function:

hasAvailableLangFiles()

ilPluginLanguage::hasAvailableLangFiles

(

)

Definition at line 73 of file class.ilPluginLanguage.php.

References getAvailableLangFiles().

                                           : bool
    {
        return count($this->getAvailableLangFiles()) > 0;
    }

Here is the call graph for this function:

loadLanguageModule()

ilPluginLanguage::loadLanguageModule

(

)

Load language module for plugin.

Definition at line 168 of file class.ilPluginLanguage.php.

References $DIC, $lng, and getPrefix().

Referenced by txt().

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

        if (is_object($lng)) {
            $lng->loadLanguageModule($this->getPrefix());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

txt()

ilPluginLanguage::txt

(

string

$a_var

)

Get Language Variable (prefix will be prepended automatically)

Definition at line 181 of file class.ilPluginLanguage.php.

References $DIC, $lng, getPrefix(), and loadLanguageModule().

                                      : string
    {
        global $DIC;
        $lng = $DIC->language();
        $this->loadLanguageModule();

        return $lng->txt($this->getPrefix() . "_" . $a_var, $this->getPrefix());
    }

Here is the call graph for this function:

uninstall()

ilPluginLanguage::uninstall

(

)

Definition at line 145 of file class.ilPluginLanguage.php.

References $DIC, $ilDB, and getPrefix().

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

        // remove all language entries (see ilObjLanguage)
        // see updateLanguages
        $prefix = $this->getPrefix();
        if ($prefix) {
            $ilDB->manipulate(
                "DELETE FROM lng_data" .
                " WHERE module = " . $ilDB->quote($prefix, "text")
            );
            $ilDB->manipulate(
                "DELETE FROM lng_modules" .
                " WHERE module = " . $ilDB->quote($prefix, "text")
            );
        }
    }

Here is the call graph for this function:

updateLanguages()

ilPluginLanguage::updateLanguages

(

?array

$a_lang_keys = null

)

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

References Vendor\Package\$a, $lang, $txt, ilObjLanguage\_getLocalChangesByModule(), getAvailableLangFiles(), ilObjLanguage\getInstalledLanguages(), getLanguageDirectory(), getPrefix(), and ilObjLanguage\replaceLangEntry().

                                                               : void
    {
        ilGlobalCache::flushAll();

        // get the keys of all installed languages if keys are not provided
        if (!isset($a_lang_keys)) {
            $a_lang_keys = [];
            foreach (ilObjLanguage::getInstalledLanguages() as $langObj) {
                if ($langObj->isInstalled()) {
                    $a_lang_keys[] = $langObj->getKey();
                }
            }
        }

        $langs = $this->getAvailableLangFiles();

        $prefix = $this->getPrefix();

        foreach ($langs as $lang) {
            // check if the language should be updated, otherwise skip it
            if (!in_array($lang['key'], $a_lang_keys, true)) {
                continue;
            }

            $txt = file($this->getLanguageDirectory() . "/" . $lang["file"]);
            $lang_array = [];

            // get locally changed variables of the module (these should be kept)
            $local_changes = ilObjLanguage::_getLocalChangesByModule($lang['key'], $prefix);

            // get language data
            if (is_array($txt)) {
                foreach ($txt as $row) {
                    if ($row[0] !== "#" && strpos($row, "#:#") > 0) {
                        $a = explode("#:#", trim($row));
                        $identifier = $prefix . "_" . trim($a[0]);
                        $value = trim($a[1]);

                        if (isset($local_changes[$identifier])) {
                            $lang_array[$identifier] = $local_changes[$identifier];
                        } else {
                            $lang_array[$identifier] = $value;
                            ilObjLanguage::replaceLangEntry($prefix, $identifier, $lang["key"], $value);
                        }
                        //echo "<br>-$prefix-".$prefix."_".trim($a[0])."-".$lang["key"]."-";
                    }
                }
            }

            ilObjLanguage::replaceLangModule($lang["key"], $prefix, $lang_array);
        }
    }

Here is the call graph for this function:

Field Documentation

$plugin_info

ilPluginInfo ilPluginLanguage::$plugin_info

protected

Definition at line 27 of file class.ilPluginLanguage.php.

Referenced by __construct(), and getPrefix().

---

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

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