PHPExcel_Worksheet

# Class: PHPExcel_Worksheet_AutoFilter_Column_Rule Source Location: /PHPExcel/Worksheet/AutoFilter/Column/Rule.php
### Class Overview
PHPExcel_Worksheet_AutoFilter_Column_Rule #### Author(s): #### Copyright: Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Constants AUTOFILTER_COLUMN_RULE_EQUAL AUTOFILTER_COLUMN_RULE_GREATERTHAN AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL AUTOFILTER_COLUMN_RULE_LESSTHAN AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL AUTOFILTER_COLUMN_RULE_NOTEQUAL AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT AUTOFILTER_COLUMN_RULE_TOPTEN_TOP AUTOFILTER_RULETYPE_CUSTOMFILTER AUTOFILTER_RULETYPE_DATEGROUP AUTOFILTER_RULETYPE_DATEGROUP_DAY AUTOFILTER_RULETYPE_DATEGROUP_HOUR AUTOFILTER_RULETYPE_DATEGROUP_MINUTE AUTOFILTER_RULETYPE_DATEGROUP_MONTH AUTOFILTER_RULETYPE_DATEGROUP_SECOND AUTOFILTER_RULETYPE_DATEGROUP_YEAR AUTOFILTER_RULETYPE_DYNAMICFILTER AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE AUTOFILTER_RULETYPE_DYNAMIC_APRIL AUTOFILTER_RULETYPE_DYNAMIC_AUGUST AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY AUTOFILTER_RULETYPE_DYNAMIC_JANUARY AUTOFILTER_RULETYPE_DYNAMIC_JULY AUTOFILTER_RULETYPE_DYNAMIC_JUNE AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR AUTOFILTER_RULETYPE_DYNAMIC_MARCH AUTOFILTER_RULETYPE_DYNAMIC_MAY AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11 AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12 AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1 AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2 AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3 AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4 AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR AUTOFILTER_RULETYPE_DYNAMIC_TODAY AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY AUTOFILTER_RULETYPE_FILTER AUTOFILTER_RULETYPE_TOPTENFILTER | ### Methods __construct getGrouping getOperator getParent getRuleType getValue setGrouping setOperator setParent setRule setRuleType setValue __clone
### Class Details [line 36] PHPExcel_Worksheet_AutoFilter_Column_Rule #### Tags:
copyright: | Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Methods ### constructor __construct [line 273]
`PHPExcel_Worksheet_AutoFilter_Column_Rule __construct( [PHPExcel_Worksheet_AutoFilter_Column $pParent = NULL])`
Create a new PHPExcel_Worksheet_AutoFilter_Column_Rule #### Tags:
access: | public
#### Parameters:
PHPExcel_Worksheet_AutoFilter_Column | $pParent |
[ Top ] ### method getGrouping [line 377]
`string getGrouping( )`
Get AutoFilter Rule Grouping #### Tags:
access: | public
[ Top ] ### method getOperator [line 349]
`string getOperator( )`
Get AutoFilter Rule Operator #### Tags:
access: | public
[ Top ] ### method getParent [line 427]
`PHPExcel_Worksheet_AutoFilter_Column getParent( )`
Get this Rule's AutoFilter Column Parent #### Tags:
access: | public
[ Top ] ### method getRuleType [line 283]
`string getRuleType( )`
Get AutoFilter Rule Type #### Tags:
access: | public
[ Top ] ### method getValue [line 309]
`string getValue( )`
Get AutoFilter Rule Value #### Tags:
access: | public
[ Top ] ### method setGrouping [line 388]
`PHPExcel_Worksheet_AutoFilter_Column_Rule setGrouping( [string $pGrouping = NULL])`
Set AutoFilter Rule Grouping #### Tags:
throws: | Exception
access: | public
#### Parameters:
string | $pGrouping |
[ Top ] ### method setOperator [line 360]
`PHPExcel_Worksheet_AutoFilter_Column_Rule setOperator( [string $pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL])`
Set AutoFilter Rule Operator #### Tags:
throws: | Exception
access: | public
#### Parameters:
string | $pOperator |
[ Top ] ### method setParent [line 437]
`PHPExcel_Worksheet_AutoFilter_Column_Rule setParent( [PHPExcel_Worksheet_AutoFilter_Column $pParent = NULL])`
Set this Rule's AutoFilter Column Parent #### Tags:
access: | public
#### Parameters:
PHPExcel_Worksheet_AutoFilter_Column | $pParent |
[ Top ] ### method setRule [line 410]
`PHPExcel_Worksheet_AutoFilter_Column_Rule setRule( [string $pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL], [string|string[] $pValue = ''], [string $pGrouping = NULL])`
Set AutoFilter Rule #### Tags:
throws: | Exception
access: | public
#### Parameters:
string | $pOperator |
string|string[] | $pValue |
string | $pGrouping |
[ Top ] ### method setRuleType [line 294]
`PHPExcel_Worksheet_AutoFilter_Column setRuleType( [string $pRuleType = self::AUTOFILTER_RULETYPE_FILTER])`
Set AutoFilter Rule Type #### Tags:
throws: | Exception
access: | public
#### Parameters:
string | $pRuleType |
[ Top ] ### method setValue [line 320]
`PHPExcel_Worksheet_AutoFilter_Column_Rule setValue( [string|string[] $pValue = ''])`
Set AutoFilter Rule Value #### Tags:
throws: | Exception
access: | public
#### Parameters:
string|string[] | $pValue |
[ Top ] ### method __clone [line 446]
`void __clone( )`
Implement PHP __clone to create a deep clone, not just a shallow copy. #### Tags:
access: | public
[ Top ] ### Class Constants #### AUTOFILTER_COLUMN_RULE_EQUAL = 'equal' [line 165] [ Top ] #### AUTOFILTER_COLUMN_RULE_GREATERTHAN = 'greaterThan' [line 167] [ Top ] #### AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL = 'greaterThanOrEqual' [line 168] [ Top ] #### AUTOFILTER_COLUMN_RULE_LESSTHAN = 'lessThan' [line 169] [ Top ] #### AUTOFILTER_COLUMN_RULE_LESSTHANOREQUAL = 'lessThanOrEqual' [line 170] [ Top ] #### AUTOFILTER_COLUMN_RULE_NOTEQUAL = 'notEqual' [line 166] [ Top ] #### AUTOFILTER_COLUMN_RULE_TOPTEN_BOTTOM = 'bottom' [line 190] [ Top ] #### AUTOFILTER_COLUMN_RULE_TOPTEN_BY_VALUE = 'byValue' [line 181] [ Top ] #### AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT = 'byPercent' [line 182] [ Top ] #### AUTOFILTER_COLUMN_RULE_TOPTEN_TOP = 'top' [line 189] [ Top ] #### AUTOFILTER_RULETYPE_CUSTOMFILTER = 'customFilter' [line 40] [ Top ] #### AUTOFILTER_RULETYPE_DATEGROUP = 'dateGroupItem' [line 39] [ Top ] #### AUTOFILTER_RULETYPE_DATEGROUP_DAY = 'day' [line 58] [ Top ] #### AUTOFILTER_RULETYPE_DATEGROUP_HOUR = 'hour' [line 59] [ Top ] #### AUTOFILTER_RULETYPE_DATEGROUP_MINUTE = 'minute' [line 60] [ Top ] #### AUTOFILTER_RULETYPE_DATEGROUP_MONTH = 'month' [line 57] [ Top ] #### AUTOFILTER_RULETYPE_DATEGROUP_SECOND = 'second' [line 61] [ Top ] #### AUTOFILTER_RULETYPE_DATEGROUP_YEAR = 'year' [line 56] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMICFILTER = 'dynamicFilter' [line 41] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_ABOVEAVERAGE = 'aboveAverage' [line 116] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_APRIL = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4 [line 95] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_AUGUST = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8 [line 103] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_BELOWAVERAGE = 'belowAverage' [line 117] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_DECEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12 [line 111] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_FEBRUARY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2 [line 91] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_JANUARY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1 [line 89] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_JULY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7 [line 101] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_JUNE = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6 [line 99] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_LASTMONTH = 'lastMonth' [line 82] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_LASTQUARTER = 'lastQuarter' [line 81] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_LASTWEEK = 'lastWeek' [line 83] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_LASTYEAR = 'lastYear' [line 80] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MARCH = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3 [line 93] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MAY = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5 [line 97] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_1 = 'M1' [line 88] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_2 = 'M2' [line 90] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_3 = 'M3' [line 92] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_4 = 'M4' [line 94] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_5 = 'M5' [line 96] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_6 = 'M6' [line 98] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_7 = 'M7' [line 100] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_8 = 'M8' [line 102] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9 = 'M9' [line 104] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10 = 'M10' [line 106] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11 = 'M11' [line 108] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_MONTH_12 = 'M12' [line 110] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_NEXTMONTH = 'nextMonth' [line 86] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_NEXTQUARTER = 'nextQuarter' [line 85] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_NEXTWEEK = 'nextWeek' [line 87] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_NEXTYEAR = 'nextYear' [line 84] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_NOVEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_11 [line 109] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_OCTOBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_10 [line 107] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_1 = 'Q1' [line 112] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_2 = 'Q2' [line 113] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_3 = 'Q3' [line 114] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_QUARTER_4 = 'Q4' [line 115] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_SEPTEMBER = self::AUTOFILTER_RULETYPE_DYNAMIC_MONTH_9 [line 105] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_THISMONTH = 'thisMonth' [line 78] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_THISQUARTER = 'thisQuarter' [line 77] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_THISWEEK = 'thisWeek' [line 79] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_THISYEAR = 'thisYear' [line 76] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_TODAY = 'today' [line 73] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_TOMORROW = 'tomorrow' [line 74] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_YEARTODATE = 'yearToDate' [line 75] [ Top ] #### AUTOFILTER_RULETYPE_DYNAMIC_YESTERDAY = 'yesterday' [line 72] [ Top ] #### AUTOFILTER_RULETYPE_FILTER = 'filter' [line 38] [ Top ] #### AUTOFILTER_RULETYPE_TOPTENFILTER = 'top10Filter' [line 42] [ Top ] Documentation generated on Fri, 12 Oct 2012 00:25:27 +0200 by phpDocumentor 1.4.4