class Rule (View source)

Constants

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

Methods

__construct(Column $pParent = null)

Create a new Rule.

string
getRuleType()

Get AutoFilter Rule Type.

setRuleType(string $pRuleType)

Set AutoFilter Rule Type.

string
getValue()

Get AutoFilter Rule Value.

setValue(string|string[] $pValue)

Set AutoFilter Rule Value.

string
getOperator()

Get AutoFilter Rule Operator.

setOperator(string $pOperator)

Set AutoFilter Rule Operator.

string
getGrouping()

Get AutoFilter Rule Grouping.

setGrouping(string $pGrouping)

Set AutoFilter Rule Grouping.

setRule(string $pOperator, string|string[] $pValue, string $pGrouping = null)

Set AutoFilter Rule.

getParent()

Get this Rule's AutoFilter Column Parent.

setParent(Column $pParent = null)

Set this Rule's AutoFilter Column Parent.

__clone()

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

Details

__construct(Column $pParent = null)

Create a new Rule.

Parameters

Column $pParent

string getRuleType()

Get AutoFilter Rule Type.

Return Value

string

Rule setRuleType(string $pRuleType)

Set AutoFilter Rule Type.

Parameters

string $pRuleType see self::AUTOFILTER_RULETYPE_*

Return Value

Rule

Exceptions

Exception

string getValue()

Get AutoFilter Rule Value.

Return Value

string

Rule setValue(string|string[] $pValue)

Set AutoFilter Rule Value.

Parameters

string|string[] $pValue

Return Value

Rule

Exceptions

Exception

string getOperator()

Get AutoFilter Rule Operator.

Return Value

string

Rule setOperator(string $pOperator)

Set AutoFilter Rule Operator.

Parameters

string $pOperator see self::AUTOFILTER_COLUMN_RULE_*

Return Value

Rule

Exceptions

Exception

string getGrouping()

Get AutoFilter Rule Grouping.

Return Value

string

Rule setGrouping(string $pGrouping)

Set AutoFilter Rule Grouping.

Parameters

string $pGrouping

Return Value

Rule

Exceptions

Exception

Rule setRule(string $pOperator, string|string[] $pValue, string $pGrouping = null)

Set AutoFilter Rule.

Parameters

string $pOperator see self::AUTOFILTER_COLUMN_RULE_*
string|string[] $pValue
string $pGrouping

Return Value

Rule

Exceptions

Exception

Column getParent()

Get this Rule's AutoFilter Column Parent.

Return Value

Column

Rule setParent(Column $pParent = null)

Set this Rule's AutoFilter Column Parent.

Parameters

Column $pParent

Return Value

Rule

__clone()

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