Documentation

Conditional

in package

• Application

implements IComparable

Table of Contents

Interfaces

IComparable

Constants

CONDITION_BEGINSWITH  = 'beginsWith'

CONDITION_CELLIS  = 'cellIs'

CONDITION_COLORSCALE  = 'colorScale'

CONDITION_CONTAINSBLANKS  = 'containsBlanks'

CONDITION_CONTAINSERRORS  = 'containsErrors'

CONDITION_CONTAINSTEXT  = 'containsText'

CONDITION_DATABAR  = 'dataBar'

CONDITION_DUPLICATES  = 'duplicateValues'

CONDITION_ENDSWITH  = 'endsWith'

CONDITION_EXPRESSION  = 'expression'

CONDITION_NONE  = 'none'

CONDITION_NOTCONTAINSBLANKS  = 'notContainsBlanks'

CONDITION_NOTCONTAINSERRORS  = 'notContainsErrors'

CONDITION_NOTCONTAINSTEXT  = 'notContainsText'

CONDITION_TIMEPERIOD  = 'timePeriod'

CONDITION_UNIQUE  = 'uniqueValues'

OPERATOR_BEGINSWITH  = 'beginsWith'

OPERATOR_BETWEEN  = 'between'

OPERATOR_CONTAINSTEXT  = 'containsText'

OPERATOR_ENDSWITH  = 'endsWith'

OPERATOR_EQUAL  = 'equal'

OPERATOR_GREATERTHAN  = 'greaterThan'

OPERATOR_GREATERTHANOREQUAL  = 'greaterThanOrEqual'

OPERATOR_LESSTHAN  = 'lessThan'

OPERATOR_LESSTHANOREQUAL  = 'lessThanOrEqual'

OPERATOR_NONE  = ''

OPERATOR_NOTBETWEEN  = 'notBetween'

OPERATOR_NOTCONTAINS  = 'notContains'

OPERATOR_NOTEQUAL  = 'notEqual'

TIMEPERIOD_LAST_7_DAYS  = 'last7Days'

TIMEPERIOD_LAST_MONTH  = 'lastMonth'

TIMEPERIOD_LAST_WEEK  = 'lastWeek'

TIMEPERIOD_NEXT_MONTH  = 'nextMonth'

TIMEPERIOD_NEXT_WEEK  = 'nextWeek'

TIMEPERIOD_THIS_MONTH  = 'thisMonth'

TIMEPERIOD_THIS_WEEK  = 'thisWeek'

TIMEPERIOD_TODAY  = 'today'

TIMEPERIOD_TOMORROW  = 'tomorrow'

TIMEPERIOD_YESTERDAY  = 'yesterday'

CONDITION_TYPES  = [self::CONDITION_BEGINSWITH, self::CONDITION_CELLIS, self::CONDITION_COLORSCALE, self::CONDITION_CONTAINSBLANKS, self::CONDITION_CONTAINSERRORS, self::CONDITION_CONTAINSTEXT, self::CONDITION_DATABAR, self::CONDITION_DUPLICATES, self::CONDITION_ENDSWITH, self::CONDITION_EXPRESSION, self::CONDITION_NONE, self::CONDITION_NOTCONTAINSBLANKS, self::CONDITION_NOTCONTAINSERRORS, self::CONDITION_NOTCONTAINSTEXT, self::CONDITION_TIMEPERIOD, self::CONDITION_UNIQUE]

Properties

$colorScale  : ConditionalColorScale|null

$condition  : array<string|int, bool|float|int|string>

Condition.

$conditionType  : string

Condition type.

$dataBar  : ConditionalDataBar|null

$noFormatSet  : bool

$operatorType  : string

Operator type.

$stopIfTrue  : bool

Stop on this condition, if it matches.

$style  : Style

$text  : string

Text.

Methods

__clone()  : mixed

Implement PHP __clone to create a deep clone, not just a shallow copy.

__construct()  : mixed

Create a new Conditional.

addCondition()  : $this

Add Condition.

getColorScale()  : ConditionalColorScale|null

getConditions()  : array<string|int, bool|float|int|string>

Get Conditions.

getConditionType()  : string

Get Condition type.

getDataBar()  : ConditionalDataBar|null

getHashCode()  : string

Get hash code.

getNoFormatSet()  : bool

getOperatorType()  : string

Get Operator type.

getStopIfTrue()  : bool

Get StopIfTrue.

getStyle()  : Style

Get Style.

getText()  : string

Get text.

isValidConditionType()  : bool

Verify if param is valid condition type.

setColorScale()  : static

setConditions()  : $this

Set Conditions.

setConditionType()  : $this

Set Condition type.

setDataBar()  : static

setNoFormatSet()  : self

setOperatorType()  : $this

Set Operator type.

setStopIfTrue()  : $this

Set StopIfTrue.

setStyle()  : $this

Set Style.

setText()  : $this

Set text.