include/Expressions/Expression/String/SugarTranslateExpression.php

Show: inherited
Table of Contents

\SugarTranslateExpression

Package: SugarCRM

<b>translateLabel(String label, String module)</b><br/> Returns the translated version of a given label key<br/> ex: <i>translateLabel("LBL_NAME", "Accounts")</i> = "Name"

Parent(s)
\StringExpression < \AbstractExpression

Properties

Propertypublic  $BOOLEAN_TYPE= '"boolean"'
Default value"boolean"Details
Type
n/a
Inherited_from
\AbstractExpression::$$BOOLEAN_TYPE  
Inherited_from
\StringExpression::$$BOOLEAN_TYPE  
Propertypublic  $DATE_TYPE= '"date"'
Default value"date"Details
Type
n/a
Inherited_from
\AbstractExpression::$$DATE_TYPE  
Inherited_from
\StringExpression::$$DATE_TYPE  
Propertypublic  $ENUM_TYPE= '"enum"'
Default value"enum"Details
Type
n/a
Inherited_from
\AbstractExpression::$$ENUM_TYPE  
Inherited_from
\StringExpression::$$ENUM_TYPE  
Propertypublic  $FALSE= '"false"'
Default value"false"Details
Type
n/a
Inherited_from
\AbstractExpression::$$FALSE  
Inherited_from
\StringExpression::$$FALSE  
Propertypublic  $GENERIC_TYPE= '"generic"'
Default value"generic"Details
Type
n/a
Inherited_from
\AbstractExpression::$$GENERIC_TYPE  
Inherited_from
\StringExpression::$$GENERIC_TYPE  
Propertypublic  $INFINITY= '-1'
Default value-1Details
Type
n/a
Inherited_from
\AbstractExpression::$$INFINITY  
Inherited_from
\StringExpression::$$INFINITY  
Propertypublic  $NUMERIC_TYPE= '"number"'
Default value"number"Details
Type
n/a
Inherited_from
\AbstractExpression::$$NUMERIC_TYPE  
Inherited_from
\StringExpression::$$NUMERIC_TYPE  
Propertypublic  $RELATE_TYPE= '"relate"'
Default value"relate"Details
Type
n/a
Inherited_from
\AbstractExpression::$$RELATE_TYPE  
Inherited_from
\StringExpression::$$RELATE_TYPE  
Propertypublic  $STRING_TYPE= '"string"'
Default value"string"Details
Type
n/a
Inherited_from
\AbstractExpression::$$STRING_TYPE  
Inherited_from
\StringExpression::$$STRING_TYPE  
Propertypublic  $TIME_TYPE= '"time"'
Default value"time"Details
Type
n/a
Inherited_from
\AbstractExpression::$$TIME_TYPE  
Inherited_from
\StringExpression::$$TIME_TYPE  
Propertypublic  $TRUE= '"true"'
Default value"true"Details
Type
n/a
Inherited_from
\AbstractExpression::$$TRUE  
Inherited_from
\StringExpression::$$TRUE  
Propertypublic  $TYPE_MAP= 'array( "number" => "NumericExpression", "string" => "StringExpression", "date" => "DateExpression", "time" => "TimeExpression", "boolean" => "BooleanExpression", "enum" => "EnumExpression", "relate" => "RelateExpression", "generic" => "AbstractExpression", )'
Default valuearray( "number" => "NumericExpression", "string" => "StringExpression", "date" => "DateExpression", "time" => "TimeExpression", "boolean" => "BooleanExpression", "enum" => "EnumExpression", "relate" => "RelateExpression", "generic" => "AbstractExpression", )Details
Type
n/a
Inherited_from
\AbstractExpression::$$TYPE_MAP  
Inherited_from
\StringExpression::$$TYPE_MAP  
Propertypublic  $params= ''
Details
Type
n/a
Inherited_from
\AbstractExpression::$$params  
Inherited_from
\StringExpression::$$params  

Methods

methodpublicAbstractExpression(  $params = null ) : void
inherited

Constructs an Expression object given the parameters.

Inherited from: \AbstractExpression::AbstractExpression()\StringExpression::AbstractExpression()
Parameters
Name Type Description
$params
methodpublicevaluate( ) : void

Evaluates this expression and returns the resulting value.

methodpublicgetJSEvaluate( ) : void
static

Returns the JS Equivalent of the evaluate function.

methodpublicgetOperationName( ) : void
static

Returns the opreation name that this Expression should be called by.

methodpublicgetParamCount( ) : void
static

Returns the maximum number of parameters needed.

methodpublicgetParameterTypes( ) : void
staticinherited

All parameters have to be a string.

Inherited from: \StringExpression::getParameterTypes()
methodpublicgetParameters( ) : void
inherited

Returns the parameter list for this Expression.

Inherited from: \AbstractExpression::getParameters()\StringExpression::getParameters()
methodpublicisProperType(  $variable,  $type ) : void
inherited

Enforces the parameter types.

Inherited from: \AbstractExpression::isProperType()\StringExpression::isProperType()
Parameters
Name Type Description
$variable
$type
methodpublictoString( ) : void
inherited

Returns a string representation of this expression.

Inherited from: \AbstractExpression::toString()\StringExpression::toString()

TODO: Make this an abstract method.

methodpublicvalidateParameters( ) : void
inherited

Validates the parameters and throws an Exception if invalid.

Inherited from: \AbstractExpression::validateParameters()\StringExpression::validateParameters()
Documentation was generated by DocBlox 0.18.1.