Collaboration diagram for ilLanguageFile:

Public Member Functions
	__construct (string $a_file, string $a_key="", string $a_scope="global")
	Constructor $a_file language file path and name $a_key (optional) language key $a_scope (optional) scope ('global', 'local' or 'unchanged') More...

	read ()
	Read a language file Return true, if reading successful. More...

	write (string $a_header="")
	Write a language file. More...

	build (string $a_header='')
	Build and get the file content. More...

	getErrorMessage ()
	Get the error message of the last read/write operation. More...

	getHeader ()
	Get the header of the original file. More...

	getAllParams ()
	Get array of all parameters Return array [name => value]. More...

	getAllValues ()
	Get array of all values Return array [module.separator.identifier => value]. More...

	getAllComments ()
	Get array of all comments Return array [module.separator.identifier => comment]. More...

	getParam (string $a_name)
	Get a single parameter $a_name parameter name. More...

	getValue (string $a_module, string $a_identifier)
	Get a single value $a_module module name $a_identifier indentifier. More...

	getComment (string $a_module, string $a_identifier)
	Get a single comment $a_module module name $a_identifier indentifier. More...

	setParam (string $a_name, string $a_value)
	Set a parameter $a_name parameter name $a_value parameter value. More...

	setValue (string $a_module, string $a_identifier, string $a_value)
	Set a single value $a_module module name $a_identifier indentifier $a_value value. More...

	setAllValues (array $a_values)
	Set all values $a_values [module.separator.identifier => value]. More...

	setAllComments (array $a_comments)
	Set all comments $a_comments [module.separator.identifier => comment]. More...

	setComment (string $a_module, string $a_identifier, string $a_comment)
	Set a single comment $a_module module name $a_identifier indentifier $a_comment comment. More...

Static Public Member Functions
static	_getGlobalLanguageFile (string $a_lang_key)
	Read and get a global language file as a singleton object $a_lang_key language key. More...

Private Attributes
string	$lang_file

string	$lang_key

string	$scope

string	$header

string	$file_start = "<!-- language file start -->"

string	$separator

string	$comment_separator

array	$params

array	$values

array	$comments

string	$error_message = ""

Static Private Attributes
static array	$global_file_objects

Detailed Description

Class ilLanguageFile.

Provides methods for working with language files: read, check and write content, comments and parameters

Author: Fred Neumann fred..nosp@m.neum.nosp@m.ann@f.nosp@m.im.u.nosp@m.ni-er.nosp@m.lang.nosp@m.en.de

Version: $Id$

Definition at line 32 of file class.ilLanguageFile.php.

Constructor & Destructor Documentation

◆ __construct()

ilLanguageFile::__construct	(	string	$a_file,
		string	$a_key = `""`,
		string	$a_scope = `"global"`
	)

Constructor $a_file language file path and name $a_key (optional) language key $a_scope (optional) scope ('global', 'local' or 'unchanged')

Definition at line 53 of file class.ilLanguageFile.php.

References $DIC, $file_start, $lng, and ILIAS_VERSION.

     {
         global $DIC;
         $lng = $DIC->language();
 
         $this->separator = $lng->separator;
         $this->comment_separator = $lng->comment_separator;
 
         $this->lang_file = $a_file;
         $this->lang_key = $a_key;
         $this->scope = $a_scope;
 
         // initialize the header of a blank file
         $this->header = $this->file_start;
 
         // Set the default parameters to be written in a new file.
         // This ensures the correct order of parameters
 
         $this->params["module"] = "language file";
         $this->params["modulegroup"] = "language";
 
         if ($this->scope === "local") {
             $this->params["based_on"] = "";
         } else {
             $this->params["author"] = "";
             $this->params["version"] = "";
         }
 
         $this->params["il_server"] = ILIAS_HTTP_PATH;
         $this->params["il_version"] = ILIAS_VERSION;
         $this->params["created"] = "";
         $this->params["created_by"] = "";
     }

Member Function Documentation

◆ _getGlobalLanguageFile()

static ilLanguageFile::_getGlobalLanguageFile ( string $a_lang_key )

static

Read and get a global language file as a singleton object $a_lang_key language key.

Returns: object language file object (with contents)

Definition at line 378 of file class.ilLanguageFile.php.

References $DIC, and $lng.

Referenced by ilObjLanguageExt\_saveValues(), and ilObjLanguageExt\getGlobalLanguageFile().

     {
         global $DIC;
         $lng = $DIC->language();
 
         if (!isset(self::$global_file_objects[$a_lang_key])) {
             $file_object = new ilLanguageFile(
                 $lng->lang_path . "/ilias_" . $a_lang_key . ".lang",
                 $a_lang_key,
                 "global"
             );
             $file_object->read();
 
             self::$global_file_objects[$a_lang_key] = $file_object;
         }
 
         return self::$global_file_objects[$a_lang_key];
     }

Here is the caller graph for this function:

◆ build()

ilLanguageFile::build ( string $a_header = '' )

Build and get the file content.

$a_header (optional) fixed header for the new file

Definition at line 191 of file class.ilLanguageFile.php.

References $DIC, $ilUser, ILIAS\LTI\ToolProvider\$key, $lng, $name, $tpl, and getAllParams().

Referenced by write().

                                                 : string
     {
         global $DIC;
         $ilUser = $DIC->user();
         $lng = $DIC->language();
 
         if ($a_header) {
             // take the given header
             $content = $a_header;
         } else {
             // set default params
             $lng->loadLanguageModule("meta");
             $lang_name = $lng->txtlng("meta", "meta_l_" . $this->lang_key, "en");
             $this->params["module"] = "language file " . $lang_name;
             $this->params["created"] = date("Y-m-d H:i:s");
             $this->params["created_by"] = $ilUser->getFullname() . " <" . $ilUser->getEmail() . ">";
 
             // build the header
             $tpl = new ilTemplate("tpl.lang_file_header.html", true, true, "Services/Language");
             foreach ($this->getAllParams() as $name => $value) {
                 $tabs = intval(ceil((20 - 3 - strlen($name)) / 4));
                 $tabs = $tabs > 0 ? $tabs : 1;
 
                 $tpl->setCurrentBlock("param");
                 $tpl->setVariable("PAR_NAME", $name);
                 $tpl->setVariable("PAR_SPACE", str_repeat("\t", $tabs));
                 $tpl->setVariable("PAR_VALUE", $value);
                 $tpl->parseCurrentBlock();
             }
             $txt_scope = $lng->txtlng("administration", "language_scope_" . $this->scope, "en");
             $tpl->setVariable("SCOPE", $txt_scope);
 
             $content = $tpl->get();
         }
 
         // fault tolerant check for adding newline
         $add_newline = (substr($content, strlen($content) - 1, 1) !== "\n");
 
         // build the content
         foreach ($this->values as $key => $value) {
             // add the newline before the line!
             // a valid lang file should not have a newline at the end!
             if ($add_newline) {
                 $content .= "\n";
             }
             $add_newline = true;
 
             $content .= $key . $this->separator . $value;
 
             if (isset($this->comments[$key])) {
                 $content .= $this->comment_separator . $this->comments[$key];
             }
         }
         return $content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllComments()

ilLanguageFile::getAllComments ( )

Get array of all comments Return array [module.separator.identifier => comment].

Definition at line 288 of file class.ilLanguageFile.php.

References $comments.

                                     : array
     {
         return $this->comments;
     }

◆ getAllParams()

ilLanguageFile::getAllParams ( )

Get array of all parameters Return array [name => value].

Definition at line 270 of file class.ilLanguageFile.php.

References $params.

Referenced by build().

                                   : array
     {
         return $this->params;
     }

Here is the caller graph for this function:

◆ getAllValues()

ilLanguageFile::getAllValues ( )

Get array of all values Return array [module.separator.identifier => value].

Definition at line 279 of file class.ilLanguageFile.php.

References $values.

                                   : array
     {
         return $this->values;
     }

◆ getComment()

ilLanguageFile::getComment	(	string	$a_module,
		string	$a_identifier
	)

Get a single comment $a_module module name $a_identifier indentifier.

Definition at line 317 of file class.ilLanguageFile.php.

                                                                       : string
     {
         return $this->comments[$a_module . $this->separator . $a_identifier];
     }

◆ getErrorMessage()

ilLanguageFile::getErrorMessage ( )

Get the error message of the last read/write operation.

Definition at line 251 of file class.ilLanguageFile.php.

References $error_message.

                                      : string
     {
         return $this->error_message;
     }

◆ getHeader()

ilLanguageFile::getHeader ( )

Get the header of the original file.

Definition at line 260 of file class.ilLanguageFile.php.

References $header.

                                : string
     {
         return $this->header;
     }

◆ getParam()

ilLanguageFile::getParam ( string $a_name )

Get a single parameter $a_name parameter name.

Definition at line 297 of file class.ilLanguageFile.php.

                                             : string
     {
         return $this->params[$a_name] ?? '';
     }

◆ getValue()

ilLanguageFile::getValue	(	string	$a_module,
		string	$a_identifier
	)

Get a single value $a_module module name $a_identifier indentifier.

Definition at line 307 of file class.ilLanguageFile.php.

                                                                     : string
     {
         return $this->values[$a_module . $this->separator . $a_identifier];
     }

◆ read()

ilLanguageFile::read ( )

Read a language file Return true, if reading successful.

Otherwise return false

Definition at line 91 of file class.ilLanguageFile.php.

References $DIC, ILIAS\LTI\ToolProvider\$key, $lng, and $param.

                           : bool
     {
         global $DIC;
         $lng = $DIC->language();
 
         $this->header = '';
         $this->params = array();
         $this->values = array();
         $this->comments = array();
         $this->error_message = "";
 
         $content = file($this->lang_file);
         $in_header = true;
 
         foreach ($content as $line_num => $line) {
             if ($in_header) {
                 // store the header line
                 $this->header .= $line . "\n";
 
                 // check header end
                 if (trim($line) === $this->file_start) {
                     $in_header = false;
                 } else {
                     // get header params
                     $pos_par = strpos($line, "* @");
 
                     if (strpos($line, "* @") !== false) {
                         $pos_par += 3;
                         $pos_space = strpos($line, " ", $pos_par);
                         $pos_tab = strpos($line, "\t", $pos_par);
                         if ($pos_space !== false && $pos_tab !== false) {
                             $pos_white = min($pos_space, $pos_tab);
                         } elseif ($pos_space !== false) {
                             $pos_white = $pos_space;
                         } elseif ($pos_tab !== false) {
                             $pos_white = $pos_tab;
                         } else {
                             $pos_white = false;
                         }
                         if ($pos_white) {
                             $param = substr($line, $pos_par, $pos_white - $pos_par);
                             $value = trim(substr($line, $pos_white));
 
                             $this->params[$param] = $value;
                         }
                     }
                 }
             } else {
                 // separate the lang file entry
                 $separated = explode($this->separator, trim($line));
 
                 // not a valid line with module, identifier and value?
                 if (count($separated) !== 3) {
                     $this->error_message =
                             $lng->txt("file_not_valid") . " "
                             . $lng->txt("err_in_line") . " " . $line_num . ". "
                             . $lng->txt("err_count_param");
                     return false;
                 } else {
                     $key = $separated[0] . $this->separator . $separated[1];
                     $value = $separated[2];
 
                     // cut off comment
                     $pos = strpos($value, $this->comment_separator);
                     if ($pos !== false) {
                         $this->comments[$key]
                             = substr($value, $pos + strlen($this->comment_separator));
 
                         $value = substr($value, 0, $pos);
                     }
                     $this->values[$key] = $value;
                 }
             }
         }
         // still in header after parsing the whole file?
         if ($in_header) {
             $this->error_message = $lng->txt("file_not_valid") . " " . $lng->txt("err_wrong_header");
             return false;
         }
 
         return true;
     }

◆ setAllComments()

ilLanguageFile::setAllComments ( array $a_comments )

Set all comments $a_comments [module.separator.identifier => comment].

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

                                                      : void
     {
         $this->comments = $a_comments;
     }

◆ setAllValues()

ilLanguageFile::setAllValues ( array $a_values )

Set all values $a_values [module.separator.identifier => value].

Definition at line 347 of file class.ilLanguageFile.php.

                                                  : void
     {
         $this->values = $a_values;
     }

◆ setComment()

ilLanguageFile::setComment	(	string	$a_module,
		string	$a_identifier,
		string	$a_comment
	)

Set a single comment $a_module module name $a_identifier indentifier $a_comment comment.

Definition at line 368 of file class.ilLanguageFile.php.

                                                                                          : string
     {
         return $this->comments[$a_module . $this->separator . $a_identifier] = $a_comment;
     }

◆ setParam()

ilLanguageFile::setParam	(	string	$a_name,
		string	$a_value
	)

Set a parameter $a_name parameter name $a_value parameter value.

Definition at line 327 of file class.ilLanguageFile.php.

                                                              : void
     {
         $this->params[$a_name] = $a_value;
     }

◆ setValue()

ilLanguageFile::setValue	(	string	$a_module,
		string	$a_identifier,
		string	$a_value
	)

Set a single value $a_module module name $a_identifier indentifier $a_value value.

Definition at line 338 of file class.ilLanguageFile.php.

                                                                                      : void
     {
         $this->values[$a_module . $this->separator . $a_identifier] = $a_value;
     }

◆ write()

ilLanguageFile::write ( string $a_header = "" )

Write a language file.

$a_header (optional) fixed header for the new file

Definition at line 179 of file class.ilLanguageFile.php.

References build().

                                                 : void
     {
         $fp = fopen($this->lang_file, 'wb');
         fwrite($fp, $this->build($a_header));
         fclose($fp);
     }

Here is the call graph for this function:

Field Documentation

◆ $comment_separator

string ilLanguageFile::$comment_separator

private

Definition at line 41 of file class.ilLanguageFile.php.

◆ $comments

array ilLanguageFile::$comments

private

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

Referenced by getAllComments().

◆ $error_message

string ilLanguageFile::$error_message = ""

private

Definition at line 45 of file class.ilLanguageFile.php.

Referenced by getErrorMessage().

◆ $file_start

string ilLanguageFile::$file_start = ""

private

Definition at line 39 of file class.ilLanguageFile.php.

Referenced by __construct().

◆ $global_file_objects

array ilLanguageFile::$global_file_objects

staticprivate

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

◆ $header

string ilLanguageFile::$header

private

Definition at line 38 of file class.ilLanguageFile.php.

Referenced by getHeader().

◆ $lang_file

string ilLanguageFile::$lang_file

private

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

◆ $lang_key

string ilLanguageFile::$lang_key

private

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

◆ $params

array ilLanguageFile::$params

private

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

Referenced by getAllParams().

◆ $scope

string ilLanguageFile::$scope

private

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

◆ $separator

string ilLanguageFile::$separator

private

Definition at line 40 of file class.ilLanguageFile.php.

◆ $values

array ilLanguageFile::$values

private

Definition at line 43 of file class.ilLanguageFile.php.

Referenced by getAllValues().

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

Services/Language/classes/class.ilLanguageFile.php

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getGlobalLanguageFile()

◆ build()

◆ getAllComments()

◆ getAllParams()

◆ getAllValues()

◆ getComment()

◆ getErrorMessage()

◆ getHeader()

◆ getParam()

◆ getValue()

◆ read()

◆ setAllComments()

◆ setAllValues()

◆ setComment()

◆ setParam()

◆ setValue()

◆ write()

Field Documentation

◆ $comment_separator

◆ $comments

◆ $error_message

◆ $file_start

◆ $global_file_objects

◆ $header

◆ $lang_file

◆ $lang_key

◆ $params

◆ $scope

◆ $separator

◆ $values