Documentation

Rule

in package

• Application

Table of Contents

Constants

AUTOFILTER_COLUMN_RULE_EQUAL  = 'equal'

AUTOFILTER_COLUMN_RULE_GREATERTHAN  = 'greaterThan'

AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL  = 'greaterThanOrEqual'

AUTOFILTER_COLUMN_RULE_LESSTHAN  = 'lessThan'

AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL  = 'lessThanOrEqual'

AUTOFILTER_COLUMN_RULE_NOTEQUAL  = 'notEqual'

AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM  = 'bottom'

AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE  = 'byValue'

AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT  = 'byPercent'

AUTOFILTER_COLUMN_RULE_TOPTEN_TOP  = 'top'

AUTOFILTER_RULETYPE_CUSTOMFILTER  = 'customFilter'

AUTOFILTER_RULETYPE_DATEGROUP  = 'dateGroupItem'

AUTOFILTER_RULETYPE_DATEGROUP_DAY  = 'day'

AUTOFILTER_RULETYPE_DATEGROUP_HOUR  = 'hour'

AUTOFILTER_RULETYPE_DATEGROUP_MINUTE  = 'minute'

AUTOFILTER_RULETYPE_DATEGROUP_MONTH  = 'month'

AUTOFILTER_RULETYPE_DATEGROUP_SECOND  = 'second'

AUTOFILTER_RULETYPE_DATEGROUP_YEAR  = 'year'

AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE  = 'aboveAverage'

AUTOFILTER_RULETYPE_DYNAMIC_APRIL  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4

AUTOFILTER_RULETYPE_DYNAMIC_AUGUST  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8

AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE  = 'belowAverage'

AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12

AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2

AUTOFILTER_RULETYPE_DYNAMIC_JANUARY  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1

AUTOFILTER_RULETYPE_DYNAMIC_JULY  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7

AUTOFILTER_RULETYPE_DYNAMIC_JUNE  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6

AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH  = 'lastMonth'

AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER  = 'lastQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK  = 'lastWeek'

AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR  = 'lastYear'

AUTOFILTER_RULETYPE_DYNAMIC_MARCH  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3

AUTOFILTER_RULETYPE_DYNAMIC_MAY  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1  = 'M1'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10  = 'M10'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11  = 'M11'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12  = 'M12'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2  = 'M2'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3  = 'M3'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4  = 'M4'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5  = 'M5'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6  = 'M6'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7  = 'M7'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8  = 'M8'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9  = 'M9'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH  = 'nextMonth'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER  = 'nextQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK  = 'nextWeek'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR  = 'nextYear'

AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11

AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1  = 'Q1'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2  = 'Q2'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3  = 'Q3'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4  = 'Q4'

AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER  = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9

AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH  = 'thisMonth'

AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER  = 'thisQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK  = 'thisWeek'

AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR  = 'thisYear'

AUTOFILTER_RULETYPE_DYNAMIC_TODAY  = 'today'

AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW  = 'tomorrow'

AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE  = 'yearToDate'

AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY  = 'yesterday'

AUTOFILTER_RULETYPE_DYNAMICFILTER  = 'dynamicFilter'

AUTOFILTER_RULETYPE_FILTER  = 'filter'

AUTOFILTER_RULETYPE_TOPTENFILTER  = 'top10Filter'

DATE_TIME_GROUPS  = [self::AUTOFILTER_RULETYPE_DATEGROUP_YEAR, self::AUTOFILTER_RULETYPE_DATEGROUP_MONTH, self::AUTOFILTER_RULETYPE_DATEGROUP_DAY, self::AUTOFILTER_RULETYPE_DATEGROUP_HOUR, self::AUTOFILTER_RULETYPE_DATEGROUP_MINUTE, self::AUTOFILTER_RULETYPE_DATEGROUP_SECOND]

DYNAMIC_TYPES  = [self::AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY, self::AUTOFILTER_RULETYPE_DYNAMIC_TODAY, self::AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW, self::AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE, self::AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR, self::AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER, self::AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH, self::AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK, self::AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR, self::AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER, self::AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH, self::AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK, self::AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR, self::AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER, self::AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH, self::AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11, self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12, self::AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1, self::AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2, self::AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3, self::AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4, self::AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE, self::AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE]

OPERATORS  = [self::AUTOFILTER_COLUMN_RULE_EQUAL, self::AUTOFILTER_COLUMN_RULE_NOTEQUAL, self::AUTOFILTER_COLUMN_RULE_GREATERTHAN, self::AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL, self::AUTOFILTER_COLUMN_RULE_LESSTHAN, self::AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL]

RULE_TYPES  = [ // Currently we're not handling // colorFilter // extLst // iconFilter self::AUTOFILTER_RULETYPE_FILTER, self::AUTOFILTER_RULETYPE_DATEGROUP, self::AUTOFILTER_RULETYPE_CUSTOMFILTER, self::AUTOFILTER_RULETYPE_DYNAMICFILTER, self::AUTOFILTER_RULETYPE_TOPTENFILTER, ]

TOP_TEN_TYPE  = [self::AUTOFILTER_COLUMN_RULE_TOPTEN_TOP, self::AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM]

TOP_TEN_VALUE  = [self::AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE, self::AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT]

Properties

$grouping  : string

DateTimeGrouping Group Value.

$operator  : string

Autofilter Rule Operator.

$parent  : Column|null

Autofilter Column.

$ruleType  : string

Autofilter Rule Type.

$value  : int|array<string|int, int>|string|array<string|int, string>

Autofilter Rule Value.

Methods

__clone()  : mixed

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

__construct()  : mixed

Create a new Rule.

getGrouping()  : string

Get AutoFilter Rule Grouping.

getOperator()  : string

Get AutoFilter Rule Operator.

getParent()  : Column|null

Get this Rule's AutoFilter Column Parent.

getRuleType()  : string

Get AutoFilter Rule Type.

getValue()  : int|array<string|int, int>|string|array<string|int, string>

Get AutoFilter Rule Value.

setGrouping()  : $this

Set AutoFilter Rule Grouping.

setOperator()  : $this

Set AutoFilter Rule Operator.

setParent()  : $this

Set this Rule's AutoFilter Column Parent.

setRule()  : $this

Set AutoFilter Rule.

setRuleType()  : $this

Set AutoFilter Rule Type.

setValue()  : $this

Set AutoFilter Rule Value.

setEvaluatedFalse()  : void