include/Expressions/Expression/AbstractExpression.php
Show:
inherited
inherited
Classes
\AbstractExpression
Package: SugarCRM
Base expression class
- Children
- \EnumExpression
- \GenericExpression
- \RelateExpression
- \DateExpression
- \NumericExpression
- \StringExpression
- \BooleanExpression
- \TimeExpression
- Api
Properties
$BOOLEAN_TYPE= '"boolean"'
static
Default value
"boolean"Details- Type
- n/a
$DATE_TYPE= '"date"'
static
Default value
"date"Details- Type
- n/a
$ENUM_TYPE= '"enum"'
static
Default value
"enum"Details- Type
- n/a
$FALSE= '"false"'
static
Default value
"false"Details- Type
- n/a
$GENERIC_TYPE= '"generic"'
static
Default value
"generic"Details- Type
- n/a
$INFINITY= '-1'
static
Default value
-1Details- Type
- n/a
$NUMERIC_TYPE= '"number"'
static
Default value
"number"Details- Type
- n/a
$RELATE_TYPE= '"relate"'
static
Default value
"relate"Details- Type
- n/a
$STRING_TYPE= '"string"'
static
Default value
"string"Details- Type
- n/a
$TIME_TYPE= '"time"'
static
Default value
"time"Details- Type
- n/a
$TRUE= '"true"'
static
Default value
"true"Details- Type
- n/a
$TYPE_MAP= 'array(
"number" => "NumericExpression",
"string" => "StringExpression",
"date" => "DateExpression",
"time" => "TimeExpression",
"boolean" => "BooleanExpression",
"enum" => "EnumExpression",
"relate" => "RelateExpression",
"generic" => "AbstractExpression",
)'
static
Default value
array(
"number" => "NumericExpression",
"string" => "StringExpression",
"date" => "DateExpression",
"time" => "TimeExpression",
"boolean" => "BooleanExpression",
"enum" => "EnumExpression",
"relate" => "RelateExpression",
"generic" => "AbstractExpression",
)Details- Type
- n/a
$params= ''
Details
- Type
- n/a
Methods
AbstractExpression(
$params
=
null
)
:
voidConstructs an Expression object given the parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| $params |
evaluate(
)
:
void
abstract
Evaluates this expression and returns the resulting value.
getJSEvaluate(
)
:
void
staticabstract
Returns the JavaScript equivalent for the evaluate function.
getParamCount(
)
:
void
static
Returns the exact number of parameters needed which is set as infinite by default.
getParameterTypes(
)
:
void
staticabstract
Defines the required types of each of the individual parameters.
getParameters(
)
:
voidReturns the parameter list for this Expression.
isProperType(
$variable, $type
)
:
voidEnforces the parameter types.
Parameters
| Name | Type | Description |
|---|---|---|
| $variable | ||
| $type |
toString(
)
:
voidReturns a string representation of this expression.
TODO: Make this an abstract method.
validateParameters(
)
:
voidValidates the parameters and throws an Exception if invalid.