Class TChoiceFormat

Description

TChoiceFormat class.

This component performs message/string choice translation. The translation source is set in the TGlobalization module. The following example demonstrates a simple 2 choice message translation.

  1. <com:TChoiceFormat Value="1">[1] One Apple. |[2] Two Apples</com:TChoiceFormat>

The Choice has Value "1" (one), thus the translated string is "One Apple". If the Value is "2", then it will show "Two Apples".

The message/string choices are separated by the pipe "|" followed by a set notation of the form

  • <tt>[1,2]</tt> -- accepts values between 1 and 2, inclusive.
  • <tt>(1,2)</tt> -- accepts values between 1 and 2, excluding 1 and 2.
  • <tt>{1,2,3,4}</tt> -- only values defined in the set are accepted.
  • <tt>[-Inf,0)</tt> -- accepts value greater or equal to negative infinity and strictly less than 0
Any non-empty combinations of the delimiters of square and round brackets are acceptable.

The string choosen for display depends on the Value property. The Value is evaluated for each set until the Value is found to belong to a particular set.

Properties

  • Value, float,
    Gets or sets the Value that determines which string choice to display.

Located in /I18N/TChoiceFormat.php (line 55)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TI18NControl
            |
            --TTranslate
               |
               --TChoiceFormat
Method Summary
float getValue ()
void setValue (float $value)
void translateText (mixed $text, mixed $subs)
Methods
getValue (line 60)
  • return: the numerical value.
  • access: public
float getValue ()
setValue (line 69)

Sets the numerical choice value

  • access: public
void setValue (float $value)
  • float $value: the choice value
translateText (line 79)

Display the choosen translated string.

Overrides the parent method, also calls parent's renderBody to translate.

  • access: protected
void translateText (mixed $text, mixed $subs)

Redefinition of:
TTranslate::translateText()
Translates the text with subsititution.

Inherited Methods

Inherited From TTranslate

TTranslate::getCatalogue()
TTranslate::getKey()
TTranslate::getParameter()
TTranslate::getParameters()
TTranslate::getText()
TTranslate::getTrim()
TTranslate::hasParameter()
TTranslate::removeParameter()
TTranslate::render()
TTranslate::setCatalogue()
TTranslate::setKey()
TTranslate::setParameter()
TTranslate::setText()
TTranslate::setTrim()
TTranslate::translateText()

Inherited From TI18NControl

TI18NControl::getCharset()
TI18NControl::getCulture()
TI18NControl::setCharset()
TI18NControl::setCulture()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants

Documentation generated on Sun, 30 Sep 2007 19:14:09 -0400 by phpDocumentor 1.3.0RC4