class Column (View source)

Constants

AUTOFILTER_FILTERTYPE_FILTER

AUTOFILTER_FILTERTYPE_CUSTOMFILTER

AUTOFILTER_FILTERTYPE_DYNAMICFILTER

AUTOFILTER_FILTERTYPE_TOPTENFILTER

AUTOFILTER_COLUMN_JOIN_AND

AUTOFILTER_COLUMN_JOIN_OR

Methods

__construct(string $pColumn, AutoFilter $pParent = null)

Create a new Column.

string
getColumnIndex()

Get AutoFilter Column Index.

setColumnIndex(string $pColumn)

Set AutoFilter Column Index.

getParent()

Get this Column's AutoFilter Parent.

setParent(AutoFilter $pParent = null)

Set this Column's AutoFilter Parent.

string
getFilterType()

Get AutoFilter Type.

setFilterType(string $pFilterType)

Set AutoFilter Type.

string
getJoin()

Get AutoFilter Multiple Rules And/Or Join.

setJoin(string $pJoin)

Set AutoFilter Multiple Rules And/Or.

setAttributes(array $attributes)

Set AutoFilter Attributes.

setAttribute(string $pName, string $pValue)

Set An AutoFilter Attribute.

string[]
getAttributes()

Get AutoFilter Column Attributes.

string
getAttribute(string $pName)

Get specific AutoFilter Column Attribute.

Rule[]
getRules()

Get all AutoFilter Column Rules.

getRule(int $pIndex)

Get a specified AutoFilter Column Rule.

createRule()

Create a new AutoFilter Column Rule in the ruleset.

addRule(Rule $pRule)

Add a new AutoFilter Column Rule to the ruleset.

deleteRule(int $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

__construct(string $pColumn, AutoFilter $pParent = null)

Create a new Column.

Parameters

string $pColumn Column (e.g. A)
AutoFilter $pParent Autofilter for this column

string getColumnIndex()

Get AutoFilter Column Index.

Return Value

string

Column setColumnIndex(string $pColumn)

Set AutoFilter Column Index.

Parameters

string $pColumn Column (e.g. A)

Return Value

Column

Exceptions

Exception

AutoFilter getParent()

Get this Column's AutoFilter Parent.

Return Value

AutoFilter

Column setParent(AutoFilter $pParent = null)

Set this Column's AutoFilter Parent.

Parameters

AutoFilter $pParent

Return Value

Column

string getFilterType()

Get AutoFilter Type.

Return Value

string

Column setFilterType(string $pFilterType)

Set AutoFilter Type.

Parameters

string $pFilterType

Return Value

Column

Exceptions

Exception

string getJoin()

Get AutoFilter Multiple Rules And/Or Join.

Return Value

string

Column setJoin(string $pJoin)

Set AutoFilter Multiple Rules And/Or.

Parameters

string $pJoin And/Or

Return Value

Column

Exceptions

Exception

Column setAttributes(array $attributes)

Set AutoFilter Attributes.

Parameters

array $attributes

Return Value

Column

Column setAttribute(string $pName, string $pValue)

Set An AutoFilter Attribute.

Parameters

string $pName Attribute Name
string $pValue Attribute Value

Return Value

Column

string[] getAttributes()

Get AutoFilter Column Attributes.

Return Value

string[]

string getAttribute(string $pName)

Get specific AutoFilter Column Attribute.

Parameters

string $pName Attribute Name

Return Value

string

Rule[] getRules()

Get all AutoFilter Column Rules.

Return Value

Rule[]

Rule getRule(int $pIndex)

Get a specified AutoFilter Column Rule.

Parameters

int $pIndex Rule index in the ruleset array

Return Value

Rule

Rule createRule()

Create a new AutoFilter Column Rule in the ruleset.

Return Value

Rule

Column addRule(Rule $pRule)

Add a new AutoFilter Column Rule to the ruleset.

Parameters

Rule $pRule

Return Value

Column

Column deleteRule(int $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

int $pIndex Rule index in the ruleset array

Return Value

Column

Column clearRules()

Delete all AutoFilter Column Rules.

Return Value

Column

__clone()

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