Constants

AUTOFILTER_FILTERTYPE_FILTER

AUTOFILTER_FILTERTYPE_FILTER = 'filters'

AUTOFILTER_FILTERTYPE_CUSTOMFILTER

AUTOFILTER_FILTERTYPE_CUSTOMFILTER = 'customFilters'

AUTOFILTER_FILTERTYPE_DYNAMICFILTER

AUTOFILTER_FILTERTYPE_DYNAMICFILTER = 'dynamicFilter'

AUTOFILTER_FILTERTYPE_TOPTENFILTER

AUTOFILTER_FILTERTYPE_TOPTENFILTER = 'top10'

AUTOFILTER_COLUMN_JOIN_AND

AUTOFILTER_COLUMN_JOIN_AND = 'and'

AUTOFILTER_COLUMN_JOIN_OR

AUTOFILTER_COLUMN_JOIN_OR = 'or'

Properties

$_filterTypes

$_filterTypes : string[]

Types of autofilter rules

Type

string[]

$_ruleJoins

$_ruleJoins : string[]

Join options for autofilter rules

Type

string[]

$_columnIndex

$_columnIndex : string

Autofilter Column Index

Type

string

$_filterType

$_filterType : string

Autofilter Column Filter Type

Type

string

$_join

$_join : string

Autofilter Multiple Rules And/Or

Type

string

$_ruleset

$_ruleset : array

Autofilter Column Rules

Type

array — of PHPExcel_Worksheet_AutoFilter_Column_Rule

$_attributes

$_attributes : array

Autofilter Column Dynamic Attributes

Type

array — of mixed

Methods

__construct()

__construct(string  $pColumn, \PHPExcel_Worksheet_AutoFilter  $pParent = NULL) : mixed

Create a new PHPExcel_Worksheet_AutoFilter_Column

Parameters

string $pColumn

Column (e.g. A)

\PHPExcel_Worksheet_AutoFilter $pParent

Autofilter for this column

Returns

mixed —

getColumnIndex()

getColumnIndex() : string

Get AutoFilter Column Index

Returns

string —

setColumnIndex()

setColumnIndex(string  $pColumn) : \PHPExcel_Worksheet_AutoFilter_Column

Set AutoFilter Column Index

Parameters

string $pColumn

Column (e.g. A)

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

getParent()

getParent() : \PHPExcel_Worksheet_AutoFilter

Get this Column's AutoFilter Parent

Returns

\PHPExcel_Worksheet_AutoFilter —

setParent()

setParent(\PHPExcel_Worksheet_AutoFilter  $pParent = NULL) : \PHPExcel_Worksheet_AutoFilter_Column

Set this Column's AutoFilter Parent

Parameters

\PHPExcel_Worksheet_AutoFilter $pParent

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

getFilterType()

getFilterType() : string

Get AutoFilter Type

Returns

string —

setFilterType()

setFilterType(string  $pFilterType = self::AUTOFILTER_FILTERTYPE_FILTER) : \PHPExcel_Worksheet_AutoFilter_Column

Set AutoFilter Type

Parameters

string $pFilterType

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

getJoin()

getJoin() : string

Get AutoFilter Multiple Rules And/Or Join

Returns

string —

setJoin()

setJoin(string  $pJoin = self::AUTOFILTER_COLUMN_JOIN_OR) : \PHPExcel_Worksheet_AutoFilter_Column

Set AutoFilter Multiple Rules And/Or

Parameters

string $pJoin

And/Or

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

setAttributes()

setAttributes(string[]  $pAttributes = array()) : \PHPExcel_Worksheet_AutoFilter_Column

Set AutoFilter Attributes

Parameters

string[] $pAttributes

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

setAttribute()

setAttribute(string  $pName, string  $pValue) : \PHPExcel_Worksheet_AutoFilter_Column

Set An AutoFilter Attribute

Parameters

string $pName

Attribute Name

string $pValue

Attribute Value

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

getAttributes()

getAttributes() : string

Get AutoFilter Column Attributes

Returns

string —

getAttribute()

getAttribute(string  $pName) : string

Get specific AutoFilter Column Attribute

Parameters

string $pName

Attribute Name

Returns

string —

getRules()

getRules() : array

Get all AutoFilter Column Rules

Throws

\PHPExcel_Exception

Returns

array —

of PHPExcel_Worksheet_AutoFilter_Column_Rule

getRule()

getRule(int  $pIndex) : \PHPExcel_Worksheet_AutoFilter_Column_Rule

Get a specified AutoFilter Column Rule

Parameters

int $pIndex

Rule index in the ruleset array

Returns

\PHPExcel_Worksheet_AutoFilter_Column_Rule —

createRule()

createRule() : \PHPExcel_Worksheet_AutoFilter_Column_Rule

Create a new AutoFilter Column Rule in the ruleset

Returns

\PHPExcel_Worksheet_AutoFilter_Column_Rule —

addRule()

addRule(\PHPExcel_Worksheet_AutoFilter_Column_Rule  $pRule, bool  $returnRule = TRUE) : \PHPExcel_Worksheet_AutoFilter_Column|\PHPExcel_Worksheet_AutoFilter_Column_Rule

Add a new AutoFilter Column Rule to the ruleset

Parameters

\PHPExcel_Worksheet_AutoFilter_Column_Rule $pRule
bool $returnRule

Flag indicating whether the rule object or the column object should be returned

Returns

\PHPExcel_Worksheet_AutoFilter_Column|\PHPExcel_Worksheet_AutoFilter_Column_Rule —

deleteRule()

deleteRule(int  $pIndex) : \PHPExcel_Worksheet_AutoFilter_Column

Delete a specified AutoFilter Column Rule If the number of rules is reduced to 1, then we reset And/Or logic to Or

Parameters

int $pIndex

Rule index in the ruleset array

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

clearRules()

clearRules() : \PHPExcel_Worksheet_AutoFilter_Column

Delete all AutoFilter Column Rules

Returns

\PHPExcel_Worksheet_AutoFilter_Column —

__clone()

__clone() : mixed

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

Returns

mixed —