Class: Translation2_Decorator_Lang

Source Location: /Translation2-2.0.0beta11/Decorator/Lang.php

Class Overview

Translation2
   |
   --Translation2_Decorator
      |
      --Translation2_Decorator_Lang

Decorator to provide a fallback language for empty strings.

Author(s):

Lorenzo Alberton <dot alberton at quipo dot it l dot alberton at quipo dot it>

Version:

CVS: $Id: Lang.php,v 1.11 2006/03/08 15:01:08 quipo Exp $

Copyright:

2004-2005 Lorenzo Alberton

Inherited Variables

Class: Translation2_Decorator

Translation2_Decorator::$currentPageID
Translation2_Decorator::$lang
Translation2_Decorator::$storage
Translation2_Decorator::$translation2

Class: Translation2

Translation2::$options
Translation2::$params

Inherited Methods

Class: Translation2_Decorator

Translation2_Decorator::Translation2_Decorator(): Constructor
Translation2_Decorator::get(): Get translated string
Translation2_Decorator::getDecorator(): Return an instance of a decorator
Translation2_Decorator::getLang(): get lang info
Translation2_Decorator::getLangs(): get langs
Translation2_Decorator::getPage(): Same as getRawPage, but resort to fallback language and replace parameters when needed
Translation2_Decorator::getRaw(): Get translated string
Translation2_Decorator::getRawPage(): Get the array of strings in a page
Translation2_Decorator::getStringID(): Get the stringID for the given string. This method is the reverse of get().
Translation2_Decorator::replaceEmptyStringsWithKeys(): Replace empty strings with their stringID
Translation2_Decorator::setContainerOptions(): Set some storage driver options
Translation2_Decorator::setLang(): Set default lang
Translation2_Decorator::setOption(): set Decorator option
Translation2_Decorator::setOptions(): set Decorator options
Translation2_Decorator::setPageID(): Set default page
Translation2_Decorator::setParams(): Set parameters for next string
Translation2_Decorator::translate(): Get translated string
Translation2_Decorator::_replaceParams(): Replace parameters in strings
Translation2_Decorator::__clone(): Clone internal object references

Class: Translation2

Translation2::Translation2(): Constructor
Translation2::factory(): Return a Translation2 instance already initialized
Translation2::get(): Get translated string
Translation2::getDecorator(): Return an instance of a decorator
Translation2::getLang(): get lang info
Translation2::getLangs(): get langs
Translation2::getPage(): Get an entire group of strings
Translation2::getRaw(): Get translated string (as-is)
Translation2::getRawPage(): Get the array of strings in a page
Translation2::getStringID(): Get the stringID for the given string. This method is the reverse of get().
Translation2::replaceEmptyStringsWithKeys(): Replace empty strings with their stringID
Translation2::setContainerOptions(): Set some storage driver options
Translation2::setLang(): Set default lang
Translation2::setPageID(): Set default page
Translation2::setParams(): Set parameters for next string
Translation2::_replaceParams(): Replace parameters in strings
Translation2::__clone(): Clone internal object references

Class Details

[line 55]
Decorator to provide a fallback language for empty strings.

Link: http://pear.php.net/package/Translation2
Version: CVS: $Id: Lang.php,v 1.11 2006/03/08 15:01:08 quipo Exp $
License: BSD License (3 Clause)
Copyright: 2004-2005 Lorenzo Alberton
Author: Lorenzo Alberton <dot alberton at quipo dot it l dot alberton at quipo dot it>

[ Top ]

Class Variables

$fallbackLang =

[line 64]

fallback lang

Access: protected

Type:

string

[ Top ]

Method Detail

get [line 100]

string get(
string
$stringID, [string
$pageID = TRANSLATION2_DEFAULT_PAGEID], [string
$langID = null], [string
$defaultText = ''])

Get translated string

If the string is empty, check the fallback language

Overrides Translation2_Decorator::get() (Get translated string)

Parameters:

string	`$stringID`	—
string	`$pageID`	—
string	`$langID`	—
string	`$defaultText`	—	Text to display when the strings in both the default and the fallback lang are empty

[ Top ]

getPage [line 120]

array getPage(
[string
$pageID = TRANSLATION2_DEFAULT_PAGEID], [string
$langID = null], [
$defaultText = ''])

Same as getRawPage, but resort to fallback language and replace parameters when needed

Overrides Translation2_Decorator::getPage() (Same as getRawPage, but resort to fallback language and replace parameters when needed)

Parameters:

string	`$pageID`	—
string	`$langID`	—
	`$defaultText`	—

[ Top ]

setOption [line 76]

void setOption(
string
$option, [mixed
$value = null])

set Decorator option (intercept 'fallbackLang' option).

I don't know why it's needed, but it doesn't work without.

Overrides Translation2_Decorator::setOption() (set Decorator option)

Parameters:

string	`$option`	—	option name
mixed	`$value`	—	option value

[ Top ]