class PHPExcel_Worksheet_AutoFilter_Column_Rule

PHPExcelWorksheetAutoFilterColumnRule

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

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(PHPExcel_Worksheet_AutoFilter_Column $pParent = null)

Create a new PHPExcelWorksheetAutoFilterColumnRule

string
getRuleType()

Get AutoFilter Rule Type

setRuleType($pRuleType = self::AUTOFILTER_RULETYPE_FILTER)

Set AutoFilter Rule Type

string
getValue()

Get AutoFilter Rule Value

setValue($pValue = '')

Set AutoFilter Rule Value

string
getOperator()

Get AutoFilter Rule Operator

setOperator($pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL)

Set AutoFilter Rule Operator

string
getGrouping()

Get AutoFilter Rule Grouping

setGrouping($pGrouping = null)

Set AutoFilter Rule Grouping

setRule($pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL, $pValue = '', $pGrouping = null)

Set AutoFilter Rule

getParent()

Get this Rule's AutoFilter Column Parent

setParent(PHPExcel_Worksheet_AutoFilter_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

at line 276
__construct(PHPExcel_Worksheet_AutoFilter_Column $pParent = null)

Create a new PHPExcelWorksheetAutoFilterColumnRule

at line 286
string getRuleType()

Get AutoFilter Rule Type

Return Value

string

at line 298
setRuleType($pRuleType = self::AUTOFILTER_RULETYPE_FILTER)

Set AutoFilter Rule Type

@param string $pRuleType

Parameters

$pRuleType

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilter_Column

at line 314
string getValue()

Get AutoFilter Rule Value

Return Value

string

at line 326
setValue($pValue = '')

Set AutoFilter Rule Value

@param string|string[] $pValue

Parameters

$pValue

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilterColumnRule

at line 356
string getOperator()

Get AutoFilter Rule Operator

Return Value

string

at line 368
setOperator($pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL)

Set AutoFilter Rule Operator

@param string $pOperator

Parameters

$pOperator

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilterColumnRule

at line 387
string getGrouping()

Get AutoFilter Rule Grouping

Return Value

string

at line 399
setGrouping($pGrouping = null)

Set AutoFilter Rule Grouping

@param string $pGrouping

Parameters

$pGrouping

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilterColumnRule

at line 421
setRule($pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL, $pValue = '', $pGrouping = null)

Set AutoFilter Rule

@param string $pOperator

Parameters

$pOperator
$pValue
$pGrouping

at line 440
PHPExcel_Worksheet_AutoFilter_Column getParent()

Get this Rule's AutoFilter Column Parent

at line 451
PHPExcel_Worksheet_AutoFilter_Column_Rule setParent(PHPExcel_Worksheet_AutoFilter_Column $pParent = null)

Set this Rule's AutoFilter Column Parent

at line 461
__clone()

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