To add a new language: More...

Collaboration diagram for Internationalization:

Files
file	spanish.php
file	german.php
file	spanish.php

Functions
	CASClient::getLang ()
	This method returns the language used by phpCAS.
	CASClient::getString ($str)
	This method returns a string depending on the language.
	CASClient::setLang ($lang)
	This method is used to set the language used by phpCAS.

Variables
	CASClient::$_lang
	A string corresponding to the language used by phpCAS.
	CASClient::$_strings
	array containing the strings used by phpCAS.
const	PHPCAS_LANG_DEFAULT = PHPCAS_LANG_ENGLISH
	phpCAS default language (when phpCAS::setLang() is not used)
const	PHPCAS_LANG_DEFAULT = PHPCAS_LANG_ENGLISH
	phpCAS default language (when phpCAS::setLang() is not used)

Detailed Description

To add a new language:

1. define a new constant PHPCAS_LANG_XXXXXX in CAS/CAS.php
2. copy any file from CAS/languages to CAS/languages/XXXXXX.php
3. Make the translations

Function Documentation

CASClient::getLang ( )

private

This method returns the language used by phpCAS.

Returns: a string representing the language

Definition at line 194 of file client.php.

References CASClient\$_lang, PHPCAS_LANG_DEFAULT, and CASClient\setLang().

Referenced by CASClient\getString().

                {
                if ( empty($this->_lang) )
                        $this->setLang(PHPCAS_LANG_DEFAULT);
                return $this->_lang;
                }

Here is the call graph for this function:

Here is the caller graph for this function:

CASClient::getString ( $str )

private

This method returns a string depending on the language.

Parameters

$str	the index of the string in $_string.

Returns: the string corresponding to $index in $string.

Definition at line 221 of file client.php.

References _strings, and CASClient\getLang().

Referenced by CASClient\logout(), CASClient\printHTMLFooter(), and CASClient\redirectToCas().

                {
                // call CASclient::getLang() to be sure the language is initialized
                $this->getLang();
                
                if ( !isset($this->_strings[$str]) ) {
                        trigger_error('string `'.$str.'\' not defined for language `'.$this->getLang().'\'',E_USER_ERROR);
                }
                return $this->_strings[$str];
                }

Here is the call graph for this function:

Here is the caller graph for this function:

CASClient::setLang ( $lang )

This method is used to set the language used by phpCAS.

Note: Can be called only once.

Parameters

$lang a string representing the language.

See Also: CAS_LANG_FRENCH, CAS_LANG_ENGLISH

Definition at line 241 of file client.php.

References $lang, and _strings.

Referenced by CASClient\getLang().

                {
                // include the corresponding language file
                include_once(dirname(__FILE__).'/languages/'.$lang.'.php');
                
                if ( !is_array($this->_strings) ) {
                        trigger_error('language `'.$lang.'\' is not implemented',E_USER_ERROR);
                }
                $this->_lang = $lang;
                }