Class: Translation2_Admin_Decorator

Source Location: /Translation2-2.0.0beta10/Admin/Decorator.php

Class Overview

Translation2
   |
   --Translation2_Decorator
      |
      --Translation2_Admin_Decorator

Decorates a Translation2_Admin class.

Author(s):

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

Copyright:

2004-2005 Lorenzo Alberton

Methods

Child classes:

Translation2_Admin_Decorator_Autoadd: Automatically add requested strings

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 59]
Decorates a Translation2_Admin class.

Create a subclass of this class for your own "decoration".

Author: Lorenzo Alberton <dot alberton at quipo dot it l dot alberton at quipo dot it>
Copyright: 2004-2005 Lorenzo Alberton
Link: http://pear.php.net/package/Translation2
Todo: Don't allow stacking on top of regular Decorators, since that will break things.
Abstract:
License: BSD License (3 Clause)

[ Top ]

Method Detail

add [line 107]

void add(

$stringID, [
$pageID = null], 
$stringArray)

Add a translation

See: Translation2_Admin::add()

Parameters:

	`$stringID`	—
	`$pageID`	—
	`$stringArray`	—

[ Top ]

addLang [line 68]

void addLang(

$langData)

Create a new language

See: Translation2_Admin::addLang()

Parameters:

$langData —

[ Top ]

cleanCache [line 159]

void cleanCache(
)

Clean the cache

See: Translation2_Admin::cleanCache()

[ Top ]

getPageNames [line 146]

void getPageNames(
)

Get a list of all the pageIDs in any table.

See: Translation2_Admin::getPageNames()

[ Top ]

remove [line 133]

void remove(

$stringID, [
$pageID = null])

Remove a translation

See: Translation2_Admin::remove()

Parameters:

	`$stringID`	—
	`$pageID`	—

[ Top ]

removeLang [line 81]

void removeLang(
[
$langID = null], [
$force = false])

Remove a language

See: Translation2_Admin::removeLang()

Parameters:

	`$langID`	—
	`$force`	—

[ Top ]

update [line 120]

void update(

$stringID, [
$pageID = null], 
$stringArray)

Update a translation

See: Translation2_Admin::update()

Parameters:

	`$stringID`	—
	`$pageID`	—
	`$stringArray`	—

[ Top ]

updateLang [line 94]

void updateLang(

$langData)

Update the lang info in the langsAvail table

See: Translation2_Admin::updateLang()

Parameters:

$langData —

[ Top ]