class PHPExcel_Worksheet_AutoFilter_Column

PHPExcelWorksheetAutoFilter_Column

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_FILTERTYPE_FILTER

AUTOFILTER_FILTERTYPE_CUSTOMFILTER

AUTOFILTER_FILTERTYPE_DYNAMICFILTER

AUTOFILTER_FILTERTYPE_TOPTENFILTER

AUTOFILTER_COLUMN_JOIN_AND

AUTOFILTER_COLUMN_JOIN_OR

Methods

__construct($pColumn, PHPExcel_Worksheet_AutoFilter $pParent = null)

Create a new PHPExcelWorksheetAutoFilter_Column

string
getColumnIndex()

Get AutoFilter Column Index

setColumnIndex($pColumn)

Set AutoFilter Column Index

getParent()

Get this Column's AutoFilter Parent

setParent(PHPExcel_Worksheet_AutoFilter $pParent = null)

Set this Column's AutoFilter Parent

string
getFilterType()

Get AutoFilter Type

setFilterType($pFilterType = self::AUTOFILTER_FILTERTYPE_FILTER)

Set AutoFilter Type

string
getJoin()

Get AutoFilter Multiple Rules And/Or Join

setJoin($pJoin = self::AUTOFILTER_COLUMN_JOIN_OR)

Set AutoFilter Multiple Rules And/Or

setAttributes($pAttributes = array())

Set AutoFilter Attributes

setAttribute($pName, $pValue)

Set An AutoFilter Attribute

string
getAttributes()

Get AutoFilter Column Attributes

string
getAttribute($pName)

Get specific AutoFilter Column Attribute

array
getRules()

Get all AutoFilter Column Rules

getRule(integer $pIndex)

Get a specified AutoFilter Column Rule

createRule()

Create a new AutoFilter Column Rule in the ruleset

addRule(PHPExcel_Worksheet_AutoFilter_Column_Rule $pRule, boolean $returnRule = true)

Add a new AutoFilter Column Rule to the ruleset

deleteRule(integer $pIndex)

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

clearRules()

Delete all AutoFilter Column Rules

__clone()

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

Details

at line 132
__construct($pColumn, PHPExcel_Worksheet_AutoFilter $pParent = null)

Create a new PHPExcelWorksheetAutoFilter_Column

@param string $pColumn Column (e.g. A)

Parameters

$pColumn
PHPExcel_Worksheet_AutoFilter $pParent

at line 143
string getColumnIndex()

Get AutoFilter Column Index

Return Value

string

at line 155
setColumnIndex($pColumn)

Set AutoFilter Column Index

@param string $pColumn Column (e.g. A)

Parameters

$pColumn

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilter_Column

at line 173
PHPExcel_Worksheet_AutoFilter getParent()

Get this Column's AutoFilter Parent

at line 184
PHPExcel_Worksheet_AutoFilter_Column setParent(PHPExcel_Worksheet_AutoFilter $pParent = null)

Set this Column's AutoFilter Parent

at line 196
string getFilterType()

Get AutoFilter Type

Return Value

string

at line 208
setFilterType($pFilterType = self::AUTOFILTER_FILTERTYPE_FILTER)

Set AutoFilter Type

@param string $pFilterType

Parameters

$pFilterType

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilter_Column

at line 224
string getJoin()

Get AutoFilter Multiple Rules And/Or Join

Return Value

string

at line 236
setJoin($pJoin = self::AUTOFILTER_COLUMN_JOIN_OR)

Set AutoFilter Multiple Rules And/Or

@param string $pJoin And/Or

Parameters

$pJoin

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilter_Column

at line 256
setAttributes($pAttributes = array())

Set AutoFilter Attributes

@param string[] $pAttributes

Parameters

$pAttributes

Exceptions

PHPExcel_Exception @return PHPExcelWorksheetAutoFilter_Column

at line 271
setAttribute($pName, $pValue)

Set An AutoFilter Attribute

@param string $pName Attribute Name

Parameters

$pName
$pValue

at line 283
string getAttributes()

Get AutoFilter Column Attributes

Return Value

string

at line 294
string getAttribute($pName)

Get specific AutoFilter Column Attribute

@param string $pName Attribute Name

Parameters

$pName

Return Value

string

at line 308
array getRules()

Get all AutoFilter Column Rules

Return Value

array of PHPExcelWorksheetAutoFilterColumnRule

Exceptions

PHPExcel_Exception

at line 319
PHPExcel_Worksheet_AutoFilter_Column_Rule getRule(integer $pIndex)

Get a specified AutoFilter Column Rule

Parameters

integer $pIndex Rule index in the ruleset array

Return Value

PHPExcel_Worksheet_AutoFilter_Column_Rule

at line 332
PHPExcel_Worksheet_AutoFilter_Column_Rule createRule()

Create a new AutoFilter Column Rule in the ruleset

at line 346
PHPExcel_Worksheet_AutoFilter_Column|PHPExcel_Worksheet_AutoFilter_Column_Rule addRule(PHPExcel_Worksheet_AutoFilter_Column_Rule $pRule, boolean $returnRule = true)

Add a new AutoFilter Column Rule to the ruleset

Parameters

PHPExcel_Worksheet_AutoFilter_Column_Rule $pRule
boolean $returnRule Flag indicating whether the rule object or the column object should be returned

Return Value

PHPExcel_Worksheet_AutoFilter_Column|PHPExcel_Worksheet_AutoFilter_Column_Rule

at line 361
PHPExcel_Worksheet_AutoFilter_Column deleteRule(integer $pIndex)

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

Parameters

integer $pIndex Rule index in the ruleset array

Return Value

PHPExcel_Worksheet_AutoFilter_Column

at line 379
PHPExcel_Worksheet_AutoFilter_Column clearRules()

Delete all AutoFilter Column Rules

at line 390
__clone()

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