Collaboration diagram for ilLanguageFile:

Public Member Functions
	__construct ($a_file, $a_key="", $a_scope='global')
	Constructor. More...

	read ()
	Read a language file. More...

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

	build ($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. More...

	getAllValues ()
	Get array of all values. More...

	getAllComments ()
	Get array of all comments. More...

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

	getValue ($a_module, $a_identifier)
	Get a single value. More...

	getComment ($a_module, $a_identifier)
	Get a single comment. More...

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

	setValue ($a_module, $a_identifier, $a_value)
	Set a single value. More...

	setAllValues ($a_values)
	Set all values. More...

	setAllComments ($a_comments)
	Set all comments. More...

	setComment ($a_module, $a_identifier, $a_value)
	Set a single comment. More...

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

Private Attributes
	$lang_file

	$lang_key

	$scope

	$header

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

	$separator

	$comment_separator

	$params = array()

	$values = array()

	$comments = array()

	$error_message = ""

Static Private Attributes
static	$global_file_objects = array()
	Created global file objects array. More...

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 35 of file class.ilLanguageFile.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	language file path and name
string	(optional) language key
string	(optional) scope ('global', 'local' or 'unchanged')

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

    {
        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 = $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"] = "";
    }

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

Member Function Documentation

◆ _getGlobalLanguageFile()

static ilLanguageFile::_getGlobalLanguageFile ( $a_lang_key )

static

Read and get a global language file as a singleton object.

Parameters

string language key

Returns: object language file object (with contents)

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

    {
        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];
    }

References $DIC, and $lng.

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

Here is the caller graph for this function:

◆ build()

ilLanguageFile::build ( $a_header = '' )

Build and get the file content.

Parameters

string (optional) fixed header for the new file

Returns: string language file content

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

    {
        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 = 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 ($this->comments[$key]) {
                $content .= $this->comment_separator . $this->comments[$key];
            }
        }
        return $content;
    }

References $DIC, $ilUser, $lng, $name, $tpl, and getAllParams().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllComments()

ilLanguageFile::getAllComments ( )

Get array of all comments.

Returns: array module.separator.identifier => comment

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

    {
        return $this->comments;
    }

References $comments.

◆ getAllParams()

ilLanguageFile::getAllParams ( )

Get array of all parameters.

Returns: array name => value

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

    {
        return $this->params;
    }

References $params.

Referenced by build().

Here is the caller graph for this function:

◆ getAllValues()

ilLanguageFile::getAllValues ( )

Get array of all values.

Returns: array module.separator.identifier => value

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

    {
        return $this->values;
    }

References $values.

◆ getComment()

ilLanguageFile::getComment	(	$a_module,
		$a_identifier
	)

Get a single comment.

Parameters

string	module name
string	indentifier

Returns: string value

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

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

◆ getErrorMessage()

ilLanguageFile::getErrorMessage ( )

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

Returns: string error message

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

    {
        return $this->error_message;
    }

References $error_message.

◆ getHeader()

ilLanguageFile::getHeader ( )

Get the header of the original file.

Returns: string

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

    {
        return $this->header;
    }

References $header.

◆ getParam()

ilLanguageFile::getParam ( $a_name )

Get a single parameter.

Parameters

string parameter name

Returns: string parameter value

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

    {
        return $this->params[$a_name];
    }

◆ getValue()

ilLanguageFile::getValue	(	$a_module,
		$a_identifier
	)

Get a single value.

Parameters

string	module name
string	indentifier

Returns: string value

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

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

◆ read()

ilLanguageFile::read ( )

Read a language file.

Returns: boolean reading successful

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

    {
        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;
                    continue;
                } else {
                    // get header params
                    $pos_par = strpos($line, "* @");
 
                    if ($pos_par !== false) {
                        $pos_par += 3;
                        $pos_space = strpos($line, " ", $pos_par);
                        $pos_tab = strpos($line, "\t", $pos_par);
                        if ($pos_space !== false and $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;
        } else {
            return true;
        }
    }

References $DIC, $lng, and $param.

◆ setAllComments()

ilLanguageFile::setAllComments ( $a_comments )

Set all comments.

Parameters

array module.separator.identifier => comment

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

    {
        $this->comments = $a_comments;
    }

◆ setAllValues()

ilLanguageFile::setAllValues ( $a_values )

Set all values.

Parameters

array module.separator.identifier => value

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

    {
        $this->values = $a_values;
    }

◆ setComment()

ilLanguageFile::setComment	(	$a_module,
		$a_identifier,
		$a_value
	)

Set a single comment.

Parameters

string	module name
string	indentifier
string	comment

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

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

◆ setParam()

ilLanguageFile::setParam	(	$a_name,
		$a_value
	)

Set a parameter.

Parameters

string	parameter name
string	parameter value

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

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

◆ setValue()

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

Set a single value.

Parameters

string	module name
string	indentifier
string	value

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

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

◆ write()

ilLanguageFile::write ( $a_header = '' )

Write a language file.

Parameters

string (optional) fixed header for the new file

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

    {
        $fp = fopen($this->lang_file, "w");
        fwrite($fp, $this->build($a_header));
        fclose($fp);
    }

References build().

Here is the call graph for this function:

Field Documentation

◆ $comment_separator

ilLanguageFile::$comment_separator

private

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

◆ $comments

ilLanguageFile::$comments = array()

private

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

Referenced by getAllComments().

◆ $error_message

ilLanguageFile::$error_message = ""

private

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

Referenced by getErrorMessage().

◆ $file_start

ilLanguageFile::$file_start = ""

private

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

Referenced by __construct().

◆ $global_file_objects

ilLanguageFile::$global_file_objects = array()

staticprivate

Created global file objects array.

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

◆ $header

ilLanguageFile::$header

private

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

Referenced by getHeader().

◆ $lang_file

ilLanguageFile::$lang_file

private

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

◆ $lang_key

ilLanguageFile::$lang_key

private

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

◆ $params

ilLanguageFile::$params = array()

private

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

Referenced by getAllParams().

◆ $scope

ilLanguageFile::$scope

private

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

◆ $separator

ilLanguageFile::$separator

private

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

◆ $values

ilLanguageFile::$values = array()

private

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