Documentation

Rule
in package

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'

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.

Constants

AUTOFILTER_COLUMN_RULE_EQUAL

public mixed AUTOFILTER_COLUMN_RULE_EQUAL = 'equal'

AUTOFILTER_COLUMN_RULE_GREATERTHAN

public mixed AUTOFILTER_COLUMN_RULE_GREATERTHAN = 'greaterThan'

AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL

public mixed AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL = 'greaterThanOrEqual'

AUTOFILTER_COLUMN_RULE_LESSTHAN

public mixed AUTOFILTER_COLUMN_RULE_LESSTHAN = 'lessThan'

AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL

public mixed AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL = 'lessThanOrEqual'

AUTOFILTER_COLUMN_RULE_NOTEQUAL

public mixed AUTOFILTER_COLUMN_RULE_NOTEQUAL = 'notEqual'

AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM

public mixed AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM = 'bottom'

AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE

public mixed AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE = 'byValue'

AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT

public mixed AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT = 'byPercent'

AUTOFILTER_COLUMN_RULE_TOPTEN_TOP

public mixed AUTOFILTER_COLUMN_RULE_TOPTEN_TOP = 'top'

AUTOFILTER_RULETYPE_CUSTOMFILTER

public mixed AUTOFILTER_RULETYPE_CUSTOMFILTER = 'customFilter'

AUTOFILTER_RULETYPE_DATEGROUP

public mixed AUTOFILTER_RULETYPE_DATEGROUP = 'dateGroupItem'

AUTOFILTER_RULETYPE_DATEGROUP_DAY

public mixed AUTOFILTER_RULETYPE_DATEGROUP_DAY = 'day'

AUTOFILTER_RULETYPE_DATEGROUP_HOUR

public mixed AUTOFILTER_RULETYPE_DATEGROUP_HOUR = 'hour'

AUTOFILTER_RULETYPE_DATEGROUP_MINUTE

public mixed AUTOFILTER_RULETYPE_DATEGROUP_MINUTE = 'minute'

AUTOFILTER_RULETYPE_DATEGROUP_MONTH

public mixed AUTOFILTER_RULETYPE_DATEGROUP_MONTH = 'month'

AUTOFILTER_RULETYPE_DATEGROUP_SECOND

public mixed AUTOFILTER_RULETYPE_DATEGROUP_SECOND = 'second'

AUTOFILTER_RULETYPE_DATEGROUP_YEAR

public mixed AUTOFILTER_RULETYPE_DATEGROUP_YEAR = 'year'

AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE

public mixed AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE = 'aboveAverage'

AUTOFILTER_RULETYPE_DYNAMIC_APRIL

public mixed AUTOFILTER_RULETYPE_DYNAMIC_APRIL = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4

AUTOFILTER_RULETYPE_DYNAMIC_AUGUST

public mixed AUTOFILTER_RULETYPE_DYNAMIC_AUGUST = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8

AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE

public mixed AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE = 'belowAverage'

AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER

public mixed AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12

AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY

public mixed AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2

AUTOFILTER_RULETYPE_DYNAMIC_JANUARY

public mixed AUTOFILTER_RULETYPE_DYNAMIC_JANUARY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1

AUTOFILTER_RULETYPE_DYNAMIC_JULY

public mixed AUTOFILTER_RULETYPE_DYNAMIC_JULY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7

AUTOFILTER_RULETYPE_DYNAMIC_JUNE

public mixed AUTOFILTER_RULETYPE_DYNAMIC_JUNE = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6

AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH

public mixed AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH = 'lastMonth'

AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER

public mixed AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER = 'lastQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK

public mixed AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK = 'lastWeek'

AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR

public mixed AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR = 'lastYear'

AUTOFILTER_RULETYPE_DYNAMIC_MARCH

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MARCH = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3

AUTOFILTER_RULETYPE_DYNAMIC_MAY

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MAY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1 = 'M1'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10 = 'M10'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11 = 'M11'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12 = 'M12'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2 = 'M2'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3 = 'M3'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4 = 'M4'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5 = 'M5'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6 = 'M6'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7 = 'M7'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8 = 'M8'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9

public mixed AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9 = 'M9'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH

public mixed AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH = 'nextMonth'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER

public mixed AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER = 'nextQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK

public mixed AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK = 'nextWeek'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR

public mixed AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR = 'nextYear'

AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER

public mixed AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11

AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER

public mixed AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1

public mixed AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1 = 'Q1'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2

public mixed AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2 = 'Q2'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3

public mixed AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3 = 'Q3'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4

public mixed AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4 = 'Q4'

AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER

public mixed AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9

AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH

public mixed AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH = 'thisMonth'

AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER

public mixed AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER = 'thisQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK

public mixed AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK = 'thisWeek'

AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR

public mixed AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR = 'thisYear'

AUTOFILTER_RULETYPE_DYNAMIC_TODAY

public mixed AUTOFILTER_RULETYPE_DYNAMIC_TODAY = 'today'

AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW

public mixed AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW = 'tomorrow'

AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE

public mixed AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE = 'yearToDate'

AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY

public mixed AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY = 'yesterday'

AUTOFILTER_RULETYPE_DYNAMICFILTER

public mixed AUTOFILTER_RULETYPE_DYNAMICFILTER = 'dynamicFilter'

AUTOFILTER_RULETYPE_FILTER

public mixed AUTOFILTER_RULETYPE_FILTER = 'filter'

AUTOFILTER_RULETYPE_TOPTENFILTER

public mixed AUTOFILTER_RULETYPE_TOPTENFILTER = 'top10Filter'

Methods

__clone()

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

public __clone() : mixed

__construct()

Create a new Rule.

public __construct([Column|null $parent = null ]) : mixed
Parameters
$parent : Column|null = null

getGrouping()

Get AutoFilter Rule Grouping.

public getGrouping() : string
Return values
string

getOperator()

Get AutoFilter Rule Operator.

public getOperator() : string
Return values
string

getParent()

Get this Rule's AutoFilter Column Parent.

public getParent() : Column|null
Return values
Column|null

getRuleType()

Get AutoFilter Rule Type.

public getRuleType() : string
Return values
string

getValue()

Get AutoFilter Rule Value.

public getValue() : int|array<string|int, int>|string|array<string|int, string>
Return values
int|array<string|int, int>|string|array<string|int, string>

setGrouping()

Set AutoFilter Rule Grouping.

public setGrouping(string $grouping) : $this
Parameters
$grouping : string
Return values
$this

setOperator()

Set AutoFilter Rule Operator.

public setOperator(string $operator) : $this
Parameters
$operator : string

see self::AUTOFILTER_COLUMN_RULE_*

Return values
$this

setParent()

Set this Rule's AutoFilter Column Parent.

public setParent([Column|null $parent = null ]) : $this
Parameters
$parent : Column|null = null
Return values
$this

setRule()

Set AutoFilter Rule.

public setRule(string $operator, int|array<string|int, int>|string|array<string|int, string> $value[, string|null $grouping = null ]) : $this
Parameters
$operator : string

see self::AUTOFILTER_COLUMN_RULE_*

$value : int|array<string|int, int>|string|array<string|int, string>
$grouping : string|null = null
Return values
$this

setRuleType()

Set AutoFilter Rule Type.

public setRuleType(string $ruleType) : $this
Parameters
$ruleType : string

see self::AUTOFILTER_RULETYPE_*

Return values
$this

setValue()

Set AutoFilter Rule Value.

public setValue(int|array<string|int, int>|string|array<string|int, string> $value) : $this
Parameters
$value : int|array<string|int, int>|string|array<string|int, string>
Return values
$this

        
On this page

Search results