Class: Translation2_Decorator_DefaultText

Source Location: /Translation2-2.0.1/Decorator/DefaultText.php

Class Overview

Translation2
   |
   --Translation2_Decorator
      |
      --Translation2_Decorator_DefaultText

Decorator to provide a fallback text for empty strings.

Author(s):

Rolf 'Red' Ochsenbein <red at raven.ch>
Lorenzo Alberton <l.alberton at quipo.it>

Version:

CVS: $Id: DefaultText.php,v 1.13 2007/10/28 23:42:35 quipo Exp $

Copyright:

2004-2007 Lorenzo Alberton, Rolf 'Red' Ochsenbein

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 Constructs the Translation2_Decorator
Translation2_Decorator::get(): Get translated string
Translation2_Decorator::getDecorator(): Return an instance of a decorator
Translation2_Decorator::getLang(): Get language info
Translation2_Decorator::getLangs(): Get languages
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::setCharset(): Set charset used to read/store the translations
Translation2_Decorator::setContainerOptions(): Set some storage driver options
Translation2_Decorator::setLang(): Set default language
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::_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::setCharset(): Set charset used to read/store the translations
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 62]
Decorator to provide a fallback text for empty strings.

If the string is empty, return the <parameter>defaultText</parameter> parameter. If the <parameter>defaultText</parameter> parameter is empty too, then return "$emptyPostfix.$outputString.$emptyPrefix", the three variables being class properties you can set to a custom string.

Author: Rolf 'Red' Ochsenbein <red@raven.ch>
Author: Lorenzo Alberton <l.alberton@quipo.it>
Version: CVS: $Id: DefaultText.php,v 1.13 2007/10/28 23:42:35 quipo Exp $
Copyright: 2004-2007 Lorenzo Alberton, Rolf 'Red' Ochsenbein
Link: http://pear.php.net/package/Translation2
License: BSD License (3 Clause)

[ Top ]

Class Variables

$emptyPostfix = ''

[line 73]

String appended to the returned string when the string is empty and it's replaced by its $stringID. It can be used to mark unreplaced strings.

Access: protected

Type:

string

[ Top ]

$emptyPrefix = ''

[line 82]

String prepended to the returned string when the string is empty and it's replaced by its $stringID. It can be used to mark unreplaced strings.

Access: protected

Type:

string

[ Top ]

$outputString = '%stringID%'

[line 93]

String to output when there was no translation

%stringID% will be replaced with the stringID %stringID_url% will replaced with a urlencoded stringID %url% will be replaced with the targeted url

Access: protected

Type:

string

[ Top ]

$url = '#'

[line 100]

Targeted URL of strings without translations

Access: protected

Type:

string

[ Top ]

Method Detail

get [line 118]

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

Get translated string

If the string is empty, return the $defaultText if not empty, the $stringID otherwise.

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

Parameters:

string	`$stringID`	—	string ID
string	`$pageID`	—	page/group ID
string	`$langID`	—	language ID
string	`$defaultText`	—	Text to display when the string is empty

[ Top ]

getPage [line 162]

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

Replace empty strings with their $stringID

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

Parameters:

string	`$pageID`	—	page/group ID
string	`$langID`	—	language ID

[ Top ]

getStringID [line 184]

string &getStringID(
string
$string, [string
$pageID = TRANSLATION2_DEFAULT_PAGEID])

Get the stringID for the given string. This method is the reverse of get().

If the requested string is unknown to the system, the requested string will be returned.

Overrides Translation2_Decorator::getStringID() (Get the stringID for the given string. This method is the reverse of get().)

Parameters:

string	`$string`	—	This is NOT the stringID, this is a real string. The method will search for its matching stringID, and then it will return the associate string in the selected language.
string	`$pageID`	—	page/group ID

[ Top ]