include/Expressions/Expression/Boolean/BooleanExpression.php
Show:
inherited
inherited
Classes
\BooleanExpression
Package: SugarCRM
Base class that all functions which return a boolean value should extend.
- Parent(s)
- \AbstractExpression
- Children
- \ContainsExpression
- \AndExpression
- \IsValidDateExpression
- \EqualExpression
- \IsAlphaNumericExpression
- \OrExpression
- \IsValidDBNameExpression
- \IsAlphaExpression
- \NotExpression
- \IsValidEmailExpression
- \FalseExpression
- \TrueExpression
- \IsNumericExpression
- \GreaterThanExpression
- \IsValidPhoneExpression
- \IsInRangeExpression
- \isBeforeExpression
- \IsRequiredCollectionExpression
- \BinaryDependencyExpression
- \IsInEnumExpression
- \isAfterExpression
- \IsValidTimeExpression
Properties
$BOOLEAN_TYPE= '"boolean"'
Default value
"boolean"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$BOOLEAN_TYPE
$DATE_TYPE= '"date"'
Default value
"date"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$DATE_TYPE
$ENUM_TYPE= '"enum"'
Default value
"enum"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$ENUM_TYPE
$GENERIC_TYPE= '"generic"'
Default value
"generic"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$GENERIC_TYPE
$NUMERIC_TYPE= '"number"'
Default value
"number"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$NUMERIC_TYPE
$RELATE_TYPE= '"relate"'
Default value
"relate"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$RELATE_TYPE
$STRING_TYPE= '"string"'
Default value
"string"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$STRING_TYPE
$TIME_TYPE= '"time"'
Default value
"time"Details- Type
- n/a
- Inherited_from
- \AbstractExpression::$$TIME_TYPE
$TYPE_MAP= 'array(
"number" => "NumericExpression",
"string" => "StringExpression",
"date" => "DateExpression",
"time" => "TimeExpression",
"boolean" => "BooleanExpression",
"enum" => "EnumExpression",
"relate" => "RelateExpression",
"generic" => "AbstractExpression",
)'
Default value
array(
"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
$params= ''
inheritedInherited from:
\AbstractExpression::$$params
Details
- Type
- n/a
- Inherited_from
- \AbstractExpression::$$params
Methods
AbstractExpression(
$params
=
null
)
:
void
inherited
Constructs an Expression object given the parameters.
Inherited from: \AbstractExpression::AbstractExpression()
Parameters
| Name | Type | Description |
|---|---|---|
| $params |
evaluate(
)
:
void
abstractinherited
Evaluates this expression and returns the resulting value.
Inherited from: \AbstractExpression::evaluate()getJSEvaluate(
)
:
void
staticabstractinherited
Returns the JavaScript equivalent for the evaluate function.
Inherited from: \AbstractExpression::getJSEvaluate()getParamCount(
)
:
void
staticinherited
Returns the exact number of parameters needed which is set as infinite by default.
Inherited from: \AbstractExpression::getParamCount()getParameterTypes(
)
:
void
static
All parameters have to be a string.
getParameters(
)
:
void
inherited
Returns the parameter list for this Expression.
Inherited from: \AbstractExpression::getParameters()isProperType(
$variable, $type
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $variable | ||
| $type |
toString(
)
:
void
inherited
Returns a string representation of this expression.
Inherited from: \AbstractExpression::toString()TODO: Make this an abstract method.
validateParameters(
)
:
void
inherited
Validates the parameters and throws an Exception if invalid.
Inherited from: \AbstractExpression::validateParameters()