include/Expressions/Expression/Date/TodayExpression.php

Show:

inherited

Classes
- \TodayExpression

Table of Contents

\TodayExpression
jump to top

Package: SugarCRM

<b>today()</b><br> Returns a date object representing todays date.

Parent(s): \DateExpression < \AbstractExpression

Properties


                 $BOOLEAN_TYPE= '"boolean"'

staticinheritedInherited from: \AbstractExpression::$$BOOLEAN_TYPE \DateExpression::$$BOOLEAN_TYPE

Default value"boolean"Details

Type: n/a
Inherited_from: \AbstractExpression::$$BOOLEAN_TYPE
Inherited_from: \DateExpression::$$BOOLEAN_TYPE


                 $DATE_TYPE= '"date"'

staticinheritedInherited from: \AbstractExpression::$$DATE_TYPE \DateExpression::$$DATE_TYPE

Default value"date"Details

Type: n/a
Inherited_from: \AbstractExpression::$$DATE_TYPE
Inherited_from: \DateExpression::$$DATE_TYPE


                 $ENUM_TYPE= '"enum"'

staticinheritedInherited from: \AbstractExpression::$$ENUM_TYPE \DateExpression::$$ENUM_TYPE

Default value"enum"Details

Type: n/a
Inherited_from: \AbstractExpression::$$ENUM_TYPE
Inherited_from: \DateExpression::$$ENUM_TYPE


                 $FALSE= '"false"'

staticinheritedInherited from: \AbstractExpression::$$FALSE \DateExpression::$$FALSE

Default value"false"Details

Type: n/a
Inherited_from: \AbstractExpression::$$FALSE
Inherited_from: \DateExpression::$$FALSE


                 $GENERIC_TYPE= '"generic"'

staticinheritedInherited from: \AbstractExpression::$$GENERIC_TYPE \DateExpression::$$GENERIC_TYPE

Default value"generic"Details

Type: n/a
Inherited_from: \AbstractExpression::$$GENERIC_TYPE
Inherited_from: \DateExpression::$$GENERIC_TYPE


                 $INFINITY= '-1'

staticinheritedInherited from: \AbstractExpression::$$INFINITY \DateExpression::$$INFINITY

Default value-1Details

Type: n/a
Inherited_from: \AbstractExpression::$$INFINITY
Inherited_from: \DateExpression::$$INFINITY


                 $NUMERIC_TYPE= '"number"'

staticinheritedInherited from: \AbstractExpression::$$NUMERIC_TYPE \DateExpression::$$NUMERIC_TYPE

Default value"number"Details

Type: n/a
Inherited_from: \AbstractExpression::$$NUMERIC_TYPE
Inherited_from: \DateExpression::$$NUMERIC_TYPE


                 $RELATE_TYPE= '"relate"'

staticinheritedInherited from: \AbstractExpression::$$RELATE_TYPE \DateExpression::$$RELATE_TYPE

Default value"relate"Details

Type: n/a
Inherited_from: \AbstractExpression::$$RELATE_TYPE
Inherited_from: \DateExpression::$$RELATE_TYPE


                 $STRING_TYPE= '"string"'

staticinheritedInherited from: \AbstractExpression::$$STRING_TYPE \DateExpression::$$STRING_TYPE

Default value"string"Details

Type: n/a
Inherited_from: \AbstractExpression::$$STRING_TYPE
Inherited_from: \DateExpression::$$STRING_TYPE


                 $TIME_TYPE= '"time"'

staticinheritedInherited from: \AbstractExpression::$$TIME_TYPE \DateExpression::$$TIME_TYPE

Default value"time"Details

Type: n/a
Inherited_from: \AbstractExpression::$$TIME_TYPE
Inherited_from: \DateExpression::$$TIME_TYPE


                 $TRUE= '"true"'

staticinheritedInherited from: \AbstractExpression::$$TRUE \DateExpression::$$TRUE

Default value"true"Details

Type: n/a
Inherited_from: \AbstractExpression::$$TRUE
Inherited_from: \DateExpression::$$TRUE


                 $TYPE_MAP= 'array(
											"number" 	=> "NumericExpression",
											"string" 	=> "StringExpression",
											"date" 		=> "DateExpression",
											"time" 		=> "TimeExpression",
											"boolean" 	=> "BooleanExpression",
											"enum" 		=> "EnumExpression",
                                            "relate"	=> "RelateExpression",
											"generic" 	=> "AbstractExpression",
										)'

staticinheritedInherited from: \AbstractExpression::$$TYPE_MAP \DateExpression::$$TYPE_MAP

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
Inherited_from: \DateExpression::$$TYPE_MAP


                 $params= ''

inheritedInherited from: \AbstractExpression::$$params \DateExpression::$$params

Details

Type: n/a
Inherited_from: \AbstractExpression::$$params
Inherited_from: \DateExpression::$$params

Methods

AbstractExpression(
           $params
              =
              null
          )
        
        :
          void

inherited

Constructs an Expression object given the parameters.

Inherited from: \AbstractExpression::AbstractExpression()\DateExpression::AbstractExpression()

Parameters

Name	Type	Description
$params

evaluate(
          
          )
        
        :
          void

The today function is sensitive to the current users timezone since it returns a day without time.

getJSEvaluate(
          
          )
        
        :
          void

static

Returns the JS Equivalent of the evaluate function.

getOperationName(
          
          )
        
        :
          void

static

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

getParamCount(
          
          )
        
        :
          void

static

Returns the maximum number of parameters needed.

getParameterTypes(
          
          )
        
        :
          void

staticinherited

All parameters have to be a string.

Inherited from: \DateExpression::getParameterTypes()

getParameters(
          
          )
        
        :
          void

inherited

Returns the parameter list for this Expression.

Inherited from: \AbstractExpression::getParameters()\DateExpression::getParameters()

isProperType(
           $variable,  $type
          )
        
        :
          void

inherited

Enforces the parameter types.

Inherited from: \AbstractExpression::isProperType()\DateExpression::isProperType()

Parameters

Name	Type	Description
$variable
$type

parse(
          String $date
          )
        
        :
          \DateTime,

staticinherited

Inherited from: \DateExpression::parse()

Parameters

Name	Type	Description
$date	String

Returns

Type	Description
\DateTime,	returns the DateTime object representing the string passed in or false if the string could not be converted to a valid date.

Details

Static

roundTime(
          \DateTime $date
          )
        
        :
          \DateTime

staticinherited

Inherited from: \DateExpression::roundTime()

Parameters

Name	Type	Description
$date	\DateTime

Returns

Type	Description
\DateTime	$date rounded to the nearest 15 minute interval.

Details

Static

toString(
          
          )
        
        :
          void

Returns the String representation of this Expression.

TODO: Make this an abstract method.

validateParameters(
          
          )
        
        :
          void

inherited

Validates the parameters and throws an Exception if invalid.

Inherited from: \AbstractExpression::validateParameters()\DateExpression::validateParameters()

include/Expressions/Expression/Date/TodayExpression.php

\TodayExpressionjump to top

Properties

Methods

\TodayExpression
jump to top