Class: TTranslate

Source Location: /I18N/TTranslate.php

Class Overview

TComponent
   |
   --TControl
      |
      --TI18NControl
         |
         --TTranslate

TTranslate class.

Class Details

[line 65]
TTranslate class.

This component performs message/string translation. The translation source is set in the TGlobalization handler. The following example demonstrated a simple message translation.

 <com:TTranslate Text="Goodbye" />

Depending on the culture set on the page, the phrase "Goodbye" will be translated.

The values of any attribute in TTranslate are consider as values for substitution. Strings enclosed with "{" and "}" are consider as the parameters. The following example will substitution the string "{time}" with the value of the attribute "time="#time()". Note that the value of the attribute time is evaluated.

 <com:TTranslate time="#time()">
   The unix-time is "{time}".
 </com:TTranslate>

More complex string substitution can be applied using the TParam component.

Namespace: System.I18N

Properties

Text, string,
Gets or sets the string to translate.
Catalogue, string,
Gets or sets the catalogue for message translation. The default catalogue can be set by the @Page directive.
Key, string,
Gets or sets the key used to message look up.
Trim, boolean,
Gets or sets an option to trim the contents. Default is to trim the contents.

version:	v1.0, last update on Fri Dec 24 21:38:49 EST 2004
author:	Xiang Wei Zhuo <weizhuo[at]gmail[dot]com>

[ Top ]

Methods

Child classes:

TChoices: TChoices class.

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TI18NControl

TI18NControl::charset(): Gets the charset, with fall back to the application charset,
TI18NControl::getCharset()
TI18NControl::getCulture(): Get the specific culture for this control.
TI18NControl::setCharset(): Sets the charset for message output
TI18NControl::setCulture(): Get the custom culture identifier.

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

method addParameter [line 198]

void addParameter(
string
$key, string
$value)

Add a string substitution key value pair.

Parameters:

string	$key	the string to substitute.
string	$value	the substitution value.

[ Top ]

method addParsedObject [line 73]

void addParsedObject(
TComponent|string
$object, TComponent
$context)

Adds the object parsed in template as a body of the component.

access:

public

Overrides TControl::addParsedObject() (Adds the object parsed in template as a body of the component.)

Parameters:

TComponent\|string	$object	the newly parsed object
TComponent	$context	the template owner

[ Top ]

method doTrim [line 150]

boolean doTrim(
)

Trim the content or not.

return:

trim or not.

[ Top ]

method getCatalogue [line 123]

string getCatalogue(
)

Get the message catalogue.

return:

catalogue.

[ Top ]

method getKey [line 114]

string getKey(
)

Get the key for message lookup.

return:

key

[ Top ]

method getParameters [line 165]

array getParameters(
)

Make all the attribute as parameters for subsititution.

The process of getting parameters from the attribute is as follows.

Get all the attributes of this component.

Call $this->evaluateExpression($array) to add the string above.

return:	parameters for string replacement.
access:	protected

[ Top ]

method getText [line 87]

string getText(
)

return:

the text to be localized/translated.

[ Top ]

method quote [line 187]

void quote(
mixed
$string)

access:

protected

[ Top ]

method renderBody [line 207]

void renderBody(
)

Display the translated string.

access:

protected

Overridden in child classes as:

TChoices::renderBody(): Display the choosen translated string.

Overrides TControl::renderBody() (Renders the body content.)

[ Top ]

method setCatalogue [line 132]

void setCatalogue(
string
$value)

Set the message catalogue.

Parameters:

string

$value

catalogue.

[ Top ]

method setKey [line 105]

void setKey(
string
$value)

Set the key for message lookup.

Parameters:

string

$value

key

[ Top ]

method setText [line 96]

void setText(
string
$value)

Sets the text for localization.

Parameters:

string

$value

the text for translation.

[ Top ]

method setTrim [line 141]

void setTrim(
boolean
$value)

Set the option to trim the contents.

Parameters:

boolean

$value

trim or not.

[ Top ]