System.I18N

[ ] [ ] [ ]

Packages:
prado
Database
RSSBuilder
System
System.Data
System.Exception
System.I18N
System.I18N.core
System.Security
System.Web.Services
System.Web.Services.AJAX
System.Web.UI
System.Web.UI.ActiveControls
System.Web.UI.WebControls

Classes:

HTTPGlobalization
TChoices
TDateFormat
TI18NControl
TNumberFormat
TParam
Translation
TTranslate

Files:

HTTPGlobalization.php
TChoices.php
TDateFormat.php
TI18NControl.php
TNumberFormat.php
TParam.php
Translation.php
TTranslate.php

Class: TParam

Source Location: /I18N/TParam.php

Class Overview

TComponent
   |
   --TControl
      |
      --TParam

TParam component should be used inside the TTranslate component to allow parameter substitution.

Class Details

[line 49]
TParam component should be used inside the TTranslate component to allow parameter substitution.

For example, the strings "{greeting}" and "{name}" will be replace with the values of "Hello" and "World", respectively. The substitution string must be enclose with "{" and "}". The parameters can be further translated by using TTranslate.

 <com:TTranslate>
   {greeting} {name}!
   <com:TParam Key="name">World</com:TParam>
   <com:TParam Key="greeting">Hello</com:TParam>
 </com:TTranslate>

Namespace: System.I18N

Properties

Key, string, required.
Gets or sets the string in TTranslate to substitute.
Trim, boolean,
Gets or sets an option to trim the contents of the TParam. Default is to trim the contents.

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

[ Top ]

Variables

$key
$trim

Methods

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

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 Variables

$key =

[line 55]

The substitution key.

access:

protected

Type:

string

[ Top ]

$trim = true

[line 61]

To trim or not to trim the contents.

access:

protected

Type:

boolean

[ Top ]

Class Methods

method doTrim [line 96]

boolean doTrim(
)

Trim the content or not.

return:

trim or not.

[ Top ]

method getKey [line 67]

string getKey(
)

Get the parameter substitution key.

return:

substitution key.

[ Top ]

method renderBody [line 107]

void renderBody(
)

Get the contents and add the content to the TTranslate component. This component does not render anything.

The parent container must be of TTranslate, otherwise error.

access:

protected

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

[ Top ]

method setKey [line 78]

void setKey(
string
$value)

Set the parameter substitution key.

Parameters:

string

$value

substitution key.

[ Top ]

method setTrim [line 87]

void setTrim(
boolean
$value)

Set the option to trim the contents.

Parameters:

boolean

$value

trim or not.

[ Top ]

© 2004-2005 PRADO Software Group. All Rights Reserved.