include/Expressions/Expression/Date/DateExpression.php

Show: inherited
Table of Contents

\DateExpression

Package:

Base expression class

Parent(s)
\AbstractExpression
Children
\TodayExpression
\NowExpression
\AddDaysExpression
\DefineDateExpression

Properties

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

Methods

methodpublicAbstractExpression(  $params = null ) : void
inherited

Constructs an Expression object given the parameters.

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

Evaluates this expression and returns the resulting value.

Inherited from: \AbstractExpression::evaluate()
methodpublicgetJSEvaluate( ) : void
staticabstractinherited

Returns the JavaScript equivalent for the evaluate function.

Inherited from: \AbstractExpression::getJSEvaluate()
methodpublicgetParamCount( ) : void
staticinherited

Returns the exact number of parameters needed which is set as infinite by default.

Inherited from: \AbstractExpression::getParamCount()
methodpublicgetParameterTypes( ) : void
static

All parameters have to be a string.

methodpublicgetParameters( ) : void
inherited

Returns the parameter list for this Expression.

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

Enforces the parameter types.

Inherited from: \AbstractExpression::isProperType()
Parameters
Name Type Description
$variable
$type
methodpublicparse( String $date ) : \DateTime,
static

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
 
methodpublicroundTime( \DateTime $date ) : \DateTime
static

Parameters
Name Type Description
$date \DateTime
Returns
Type Description
\DateTime $date rounded to the nearest 15 minute interval.
Details
Static
 
methodpublictoString( ) : void
inherited

Returns a string representation of this expression.

Inherited from: \AbstractExpression::toString()

TODO: Make this an abstract method.

methodpublicvalidateParameters( ) : void
inherited

Validates the parameters and throws an Exception if invalid.

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