\PHPExcel_Worksheet_AutoFilter_Column

PHPExcel_Worksheet_AutoFilter_Column

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

Summary

Methods

Properties

Constants

__construct()
getColumnIndex()
setColumnIndex()
getParent()
setParent()
getFilterType()
setFilterType()
getJoin()
setJoin()
setAttributes()
setAttribute()
getAttributes()
getAttribute()
getRules()
getRule()
createRule()
addRule()
deleteRule()
clearRules()
__clone()

No public properties found

AUTOFILTER_FILTERTYPE_FILTER
AUTOFILTER_FILTERTYPE_CUSTOMFILTER
AUTOFILTER_FILTERTYPE_DYNAMICFILTER
AUTOFILTER_FILTERTYPE_TOPTENFILTER
AUTOFILTER_COLUMN_JOIN_AND
AUTOFILTER_COLUMN_JOIN_OR

No protected methods found

No protected properties found

N/A

No private methods found

$filterTypes
$ruleJoins
$parent
$columnIndex
$filterType
$join
$ruleset
$attributes

N/A

File: vendor/Execl/PHPExcel/Worksheet/AutoFilter/Column.php
Package: PHPExcel_Worksheet
Class hierarchy: \PHPExcel_Worksheet_AutoFilter_Column

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 : array<mixed,string>

Types of autofilter rules

Type

array<mixed,string>

$ruleJoins

$ruleJoins : array<mixed,string>

Join options for autofilter rules

Type

array<mixed,string>

$parent

$parent : \PHPExcel_Worksheet_AutoFilter

Autofilter

Type

\PHPExcel_Worksheet_AutoFilter

$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(  $pColumn, \PHPExcel_Worksheet_AutoFilter  $pParent = null)

Create a new PHPExcel_Worksheet_AutoFilter_Column

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

Parameters

	$pColumn
\PHPExcel_Worksheet_AutoFilter	$pParent	Autofilter for this column

getColumnIndex()

getColumnIndex() : string

Get AutoFilter Column Index

Returns

string

setColumnIndex()

setColumnIndex(  $pColumn)

Set AutoFilter Column Index

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

Parameters

$pColumn

Throws

\PHPExcel_Exception: @return 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(  $pFilterType = self::AUTOFILTER_FILTERTYPE_FILTER)

Set AutoFilter Type

@param string $pFilterType

Parameters

$pFilterType

Throws

\PHPExcel_Exception: @return PHPExcel_Worksheet_AutoFilter_Column

getJoin()

getJoin() : string

Get AutoFilter Multiple Rules And/Or Join

Returns

string

setJoin()

setJoin(  $pJoin = self::AUTOFILTER_COLUMN_JOIN_OR)

Set AutoFilter Multiple Rules And/Or

@param string $pJoin And/Or

Parameters

$pJoin

Throws

\PHPExcel_Exception: @return PHPExcel_Worksheet_AutoFilter_Column

setAttributes()

setAttributes(  $pAttributes = array())

Set AutoFilter Attributes

@param string[] $pAttributes

Parameters

$pAttributes

Throws

\PHPExcel_Exception: @return PHPExcel_Worksheet_AutoFilter_Column

setAttribute()

setAttribute(  $pName, string  $pValue)

Set An AutoFilter Attribute

@param string $pName Attribute Name

Parameters

	$pName
string	$pValue	Attribute Value @throws PHPExcel_Exception @return PHPExcel_Worksheet_AutoFilter_Column

getAttributes()

getAttributes() : string

Get AutoFilter Column Attributes

Returns

string

getAttribute()

getAttribute(  $pName) : string

Get specific AutoFilter Column Attribute

@param string $pName Attribute Name

Parameters

$pName

Returns

string

getRules()

getRules() : array

Get all AutoFilter Column Rules

Throws

\PHPExcel_Exception

Returns

array —

of PHPExcel_Worksheet_AutoFilter_Column_Rule

getRule()

getRule(integer  $pIndex) : \PHPExcel_Worksheet_AutoFilter_Column_Rule

Get a specified AutoFilter Column Rule

Parameters

integer

$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, boolean  $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
boolean	$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(integer  $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

integer

$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()

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

category	PHPExcel
copyright	Copyright (c) 2006 - 2015 PHPExcel (http://www.codeplex.com/PHPExcel)
license	http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
version	VERSION##, ##DATE