\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\ColumnRule

Summary

Methods

Properties

Constants

__construct()
getRuleType()
setRuleType()
getValue()
setValue()
getOperator()
setOperator()
getGrouping()
setGrouping()
setRule()
getParent()
setParent()
__clone()

No public properties found

AUTOFILTER_RULETYPE_FILTER
AUTOFILTER_RULETYPE_DATEGROUP
AUTOFILTER_RULETYPE_CUSTOMFILTER
AUTOFILTER_RULETYPE_DYNAMICFILTER
AUTOFILTER_RULETYPE_TOPTENFILTER
AUTOFILTER_RULETYPE_DATEGROUP_YEAR
AUTOFILTER_RULETYPE_DATEGROUP_MONTH
AUTOFILTER_RULETYPE_DATEGROUP_DAY
AUTOFILTER_RULETYPE_DATEGROUP_HOUR
AUTOFILTER_RULETYPE_DATEGROUP_MINUTE
AUTOFILTER_RULETYPE_DATEGROUP_SECOND
AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY
AUTOFILTER_RULETYPE_DYNAMIC_TODAY
AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW
AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE
AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR
AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER
AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH
AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK
AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR
AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER
AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH
AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK
AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR
AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER
AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH
AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1
AUTOFILTER_RULETYPE_DYNAMIC_JANUARY
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2
AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3
AUTOFILTER_RULETYPE_DYNAMIC_MARCH
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4
AUTOFILTER_RULETYPE_DYNAMIC_APRIL
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5
AUTOFILTER_RULETYPE_DYNAMIC_MAY
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6
AUTOFILTER_RULETYPE_DYNAMIC_JUNE
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7
AUTOFILTER_RULETYPE_DYNAMIC_JULY
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8
AUTOFILTER_RULETYPE_DYNAMIC_AUGUST
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9
AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10
AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11
AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER
AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12
AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3
AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4
AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE
AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE
AUTOFILTER_COLUMN_RULE_EQUAL
AUTOFILTER_COLUMN_RULE_NOTEQUAL
AUTOFILTER_COLUMN_RULE_GREATERTHAN
AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL
AUTOFILTER_COLUMN_RULE_LESSTHAN
AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL
AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE
AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT
AUTOFILTER_COLUMN_RULE_TOPTEN_TOP
AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM

No protected methods found

No protected properties found

N/A

No private methods found

$ruleTypes
$dateTimeGroups
$dynamicTypes
$operators
$topTenValue
$topTenType
$parent
$ruleType
$value
$operator
$grouping

N/A

File: vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php
Package: Default
Class hierarchy: \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule

Constants

AUTOFILTER_RULETYPE_FILTER

AUTOFILTER_RULETYPE_FILTER = 'filter'

AUTOFILTER_RULETYPE_DATEGROUP

AUTOFILTER_RULETYPE_DATEGROUP = 'dateGroupItem'

AUTOFILTER_RULETYPE_CUSTOMFILTER

AUTOFILTER_RULETYPE_CUSTOMFILTER = 'customFilter'

AUTOFILTER_RULETYPE_DYNAMICFILTER

AUTOFILTER_RULETYPE_DYNAMICFILTER = 'dynamicFilter'

AUTOFILTER_RULETYPE_TOPTENFILTER

AUTOFILTER_RULETYPE_TOPTENFILTER = 'top10Filter'

AUTOFILTER_RULETYPE_DATEGROUP_YEAR

AUTOFILTER_RULETYPE_DATEGROUP_YEAR = 'year'

AUTOFILTER_RULETYPE_DATEGROUP_MONTH

AUTOFILTER_RULETYPE_DATEGROUP_MONTH = 'month'

AUTOFILTER_RULETYPE_DATEGROUP_DAY

AUTOFILTER_RULETYPE_DATEGROUP_DAY = 'day'

AUTOFILTER_RULETYPE_DATEGROUP_HOUR

AUTOFILTER_RULETYPE_DATEGROUP_HOUR = 'hour'

AUTOFILTER_RULETYPE_DATEGROUP_MINUTE

AUTOFILTER_RULETYPE_DATEGROUP_MINUTE = 'minute'

AUTOFILTER_RULETYPE_DATEGROUP_SECOND

AUTOFILTER_RULETYPE_DATEGROUP_SECOND = 'second'

AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY

AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY = 'yesterday'

AUTOFILTER_RULETYPE_DYNAMIC_TODAY

AUTOFILTER_RULETYPE_DYNAMIC_TODAY = 'today'

AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW

AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW = 'tomorrow'

AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE

AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE = 'yearToDate'

AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR

AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR = 'thisYear'

AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER

AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER = 'thisQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH

AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH = 'thisMonth'

AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK

AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK = 'thisWeek'

AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR

AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR = 'lastYear'

AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER

AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER = 'lastQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH

AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH = 'lastMonth'

AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK

AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK = 'lastWeek'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR

AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR = 'nextYear'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER

AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER = 'nextQuarter'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH

AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH = 'nextMonth'

AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK

AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK = 'nextWeek'

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1 = 'M1'

AUTOFILTER_RULETYPE_DYNAMIC_JANUARY

AUTOFILTER_RULETYPE_DYNAMIC_JANUARY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2 = 'M2'

AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY

AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3 = 'M3'

AUTOFILTER_RULETYPE_DYNAMIC_MARCH

AUTOFILTER_RULETYPE_DYNAMIC_MARCH = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4 = 'M4'

AUTOFILTER_RULETYPE_DYNAMIC_APRIL

AUTOFILTER_RULETYPE_DYNAMIC_APRIL = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5 = 'M5'

AUTOFILTER_RULETYPE_DYNAMIC_MAY

AUTOFILTER_RULETYPE_DYNAMIC_MAY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6 = 'M6'

AUTOFILTER_RULETYPE_DYNAMIC_JUNE

AUTOFILTER_RULETYPE_DYNAMIC_JUNE = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7 = 'M7'

AUTOFILTER_RULETYPE_DYNAMIC_JULY

AUTOFILTER_RULETYPE_DYNAMIC_JULY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8 = 'M8'

AUTOFILTER_RULETYPE_DYNAMIC_AUGUST

AUTOFILTER_RULETYPE_DYNAMIC_AUGUST = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9 = 'M9'

AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER

AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10 = 'M10'

AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER

AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11 = 'M11'

AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER

AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12

AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12 = 'M12'

AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER

AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1 = 'Q1'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2 = 'Q2'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3 = 'Q3'

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4

AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4 = 'Q4'

AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE

AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE = 'aboveAverage'

AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE

AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE = 'belowAverage'

AUTOFILTER_COLUMN_RULE_EQUAL

AUTOFILTER_COLUMN_RULE_EQUAL = 'equal'

AUTOFILTER_COLUMN_RULE_NOTEQUAL

AUTOFILTER_COLUMN_RULE_NOTEQUAL = 'notEqual'

AUTOFILTER_COLUMN_RULE_GREATERTHAN

AUTOFILTER_COLUMN_RULE_GREATERTHAN = 'greaterThan'

AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL

AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL = 'greaterThanOrEqual'

AUTOFILTER_COLUMN_RULE_LESSTHAN

AUTOFILTER_COLUMN_RULE_LESSTHAN = 'lessThan'

AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL

AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL = 'lessThanOrEqual'

AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE

AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE = 'byValue'

AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT

AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT = 'byPercent'

AUTOFILTER_COLUMN_RULE_TOPTEN_TOP

AUTOFILTER_COLUMN_RULE_TOPTEN_TOP = 'top'

AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM

AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM = 'bottom'

Properties

$ruleTypes

$ruleTypes :

Type

$dateTimeGroups

$dateTimeGroups :

Type

$dynamicTypes

$dynamicTypes :

Type

$operators

$operators :

Type

$topTenValue

$topTenValue :

Type

$topTenType

$topTenType :

Type

$parent

$parent : \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

Autofilter Column.

Type

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

$ruleType

$ruleType : string

Autofilter Rule Type.

Type

string

$value

$value : string

Autofilter Rule Value.

Type

string

$operator

$operator : string

Autofilter Rule Operator.

Type

string

$grouping

$grouping : string

DateTimeGrouping Group Value.

Type

string

Methods

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column  $pParent = null)

Create a new Rule.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

$pParent

getRuleType()

getRuleType() : string

Get AutoFilter Rule Type.

Returns

string

setRuleType()

setRuleType(string  $pRuleType) : $this

Set AutoFilter Rule Type.

Parameters

string

$pRuleType

see self::AUTOFILTERRULETYPE*

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getValue()

getValue() : string

Get AutoFilter Rule Value.

Returns

string

setValue()

setValue(string|array<mixed,string>  $pValue) : $this

Set AutoFilter Rule Value.

Parameters

string|array<mixed,string>

$pValue

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getOperator()

getOperator() : string

Get AutoFilter Rule Operator.

Returns

string

setOperator()

setOperator(string  $pOperator) : $this

Set AutoFilter Rule Operator.

Parameters

string

$pOperator

see self::AUTOFILTER_COLUMNRULE*

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getGrouping()

getGrouping() : string

Get AutoFilter Rule Grouping.

Returns

string

setGrouping()

setGrouping(string  $pGrouping) : $this

Set AutoFilter Rule Grouping.

Parameters

string

$pGrouping

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

setRule()

setRule(string  $pOperator, string|array<mixed,string>  $pValue, string  $pGrouping = null) : $this

Set AutoFilter Rule.

Parameters

string	$pOperator	see self::AUTOFILTER_COLUMNRULE*
string\|array<mixed,string>	$pValue
string	$pGrouping

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

$this

getParent()

getParent() : \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

Get this Rule's AutoFilter Column Parent.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

setParent()

setParent(\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column  $pParent = null) : $this

Set this Rule's AutoFilter Column Parent.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column

$pParent

Returns

$this

__clone()

__clone()

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