Documentation

Column
in package

Table of Contents

Constants

AUTOFILTER_COLUMN_JOIN_AND  = 'and'
AUTOFILTER_COLUMN_JOIN_OR  = 'or'
AUTOFILTER_FILTERTYPE_CUSTOMFILTER  = 'customFilters'
AUTOFILTER_FILTERTYPE_DYNAMICFILTER  = 'dynamicFilter'
AUTOFILTER_FILTERTYPE_FILTER  = 'filters'
AUTOFILTER_FILTERTYPE_TOPTENFILTER  = 'top10'

Properties

$attributes  : array<string|int, mixed>
Autofilter Column Dynamic Attributes.
$columnIndex  : string
Autofilter Column Index.
$filterType  : string
Autofilter Column Filter Type.
$filterTypes  : array<string|int, string>
Types of autofilter rules.
$join  : string
Autofilter Multiple Rules And/Or.
$parent  : AutoFilter|null
Autofilter.
$ruleJoins  : array<string|int, string>
Join options for autofilter rules.
$ruleset  : array<string|int, Rule>
Autofilter Column Rules.

Methods

__clone()  : mixed
Implement PHP __clone to create a deep clone, not just a shallow copy.
__construct()  : mixed
Create a new Column.
addRule()  : $this
Add a new AutoFilter Column Rule to the ruleset.
clearRules()  : $this
Delete all AutoFilter Column Rules.
createRule()  : Rule
Create a new AutoFilter Column Rule in the ruleset.
deleteRule()  : $this
Delete a specified AutoFilter Column Rule If the number of rules is reduced to 1, then we reset And/Or logic to Or.
getAttribute()  : null|int|string
Get specific AutoFilter Column Attribute.
getAttributes()  : array<string|int, int>|array<string|int, string>
Get AutoFilter Column Attributes.
getColumnIndex()  : string
Get AutoFilter column index as string eg: 'A'.
getFilterType()  : string
Get AutoFilter Type.
getJoin()  : string
Get AutoFilter Multiple Rules And/Or Join.
getParent()  : AutoFilter|null
Get this Column's AutoFilter Parent.
getRule()  : Rule
Get a specified AutoFilter Column Rule.
getRules()  : array<string|int, Rule>
Get all AutoFilter Column Rules.
ruleCount()  : int
setAttribute()  : $this
Set An AutoFilter Attribute.
setAttributes()  : $this
Set AutoFilter Attributes.
setColumnIndex()  : $this
Set AutoFilter column index as string eg: 'A'.
setEvaluatedFalse()  : void
setFilterType()  : $this
Set AutoFilter Type.
setJoin()  : $this
Set AutoFilter Multiple Rules And/Or.
setParent()  : $this
Set this Column's AutoFilter Parent.

Constants

AUTOFILTER_COLUMN_JOIN_AND

public mixed AUTOFILTER_COLUMN_JOIN_AND = 'and'

AUTOFILTER_COLUMN_JOIN_OR

public mixed AUTOFILTER_COLUMN_JOIN_OR = 'or'

AUTOFILTER_FILTERTYPE_CUSTOMFILTER

public mixed AUTOFILTER_FILTERTYPE_CUSTOMFILTER = 'customFilters'

AUTOFILTER_FILTERTYPE_DYNAMICFILTER

public mixed AUTOFILTER_FILTERTYPE_DYNAMICFILTER = 'dynamicFilter'

AUTOFILTER_FILTERTYPE_FILTER

public mixed AUTOFILTER_FILTERTYPE_FILTER = 'filters'

AUTOFILTER_FILTERTYPE_TOPTENFILTER

public mixed AUTOFILTER_FILTERTYPE_TOPTENFILTER = 'top10'

Properties

$attributes

Autofilter Column Dynamic Attributes.

private array<string|int, mixed> $attributes = []

$columnIndex

Autofilter Column Index.

private string $columnIndex

$filterType

Autofilter Column Filter Type.

private string $filterType = self::AUTOFILTER_FILTERTYPE_FILTER

$filterTypes

Types of autofilter rules.

private static array<string|int, string> $filterTypes = [ // Currently we're not handling // colorFilter // extLst // iconFilter self::AUTOFILTER_FILTERTYPE_FILTER, self::AUTOFILTER_FILTERTYPE_CUSTOMFILTER, self::AUTOFILTER_FILTERTYPE_DYNAMICFILTER, self::AUTOFILTER_FILTERTYPE_TOPTENFILTER, ]

$join

Autofilter Multiple Rules And/Or.

private string $join = self::AUTOFILTER_COLUMN_JOIN_OR

$ruleJoins

Join options for autofilter rules.

private static array<string|int, string> $ruleJoins = [self::AUTOFILTER_COLUMN_JOIN_AND, self::AUTOFILTER_COLUMN_JOIN_OR]

$ruleset

Autofilter Column Rules.

private array<string|int, Rule> $ruleset = []

Methods

__clone()

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

public __clone() : mixed

__construct()

Create a new Column.

public __construct(string $column[, AutoFilter|null $parent = null ]) : mixed
Parameters
$column : string

Column (e.g. A)

$parent : AutoFilter|null = null

Autofilter for this column

addRule()

Add a new AutoFilter Column Rule to the ruleset.

public addRule(Rule $rule) : $this
Parameters
$rule : Rule
Return values
$this

clearRules()

Delete all AutoFilter Column Rules.

public clearRules() : $this
Return values
$this

createRule()

Create a new AutoFilter Column Rule in the ruleset.

public createRule() : Rule
Return values
Rule

deleteRule()

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

public deleteRule(int $index) : $this
Parameters
$index : int

Rule index in the ruleset array

Return values
$this

getAttribute()

Get specific AutoFilter Column Attribute.

public getAttribute(string $name) : null|int|string
Parameters
$name : string

Attribute Name

Return values
null|int|string

getAttributes()

Get AutoFilter Column Attributes.

public getAttributes() : array<string|int, int>|array<string|int, string>
Return values
array<string|int, int>|array<string|int, string>

getColumnIndex()

Get AutoFilter column index as string eg: 'A'.

public getColumnIndex() : string
Return values
string

getFilterType()

Get AutoFilter Type.

public getFilterType() : string
Return values
string

getJoin()

Get AutoFilter Multiple Rules And/Or Join.

public getJoin() : string
Return values
string

getRule()

Get a specified AutoFilter Column Rule.

public getRule(int $index) : Rule
Parameters
$index : int

Rule index in the ruleset array

Return values
Rule

getRules()

Get all AutoFilter Column Rules.

public getRules() : array<string|int, Rule>
Return values
array<string|int, Rule>

ruleCount()

public ruleCount() : int
Return values
int

setAttribute()

Set An AutoFilter Attribute.

public setAttribute(string $name, int|string $value) : $this
Parameters
$name : string

Attribute Name

$value : int|string

Attribute Value

Return values
$this

setAttributes()

Set AutoFilter Attributes.

public setAttributes(array<string|int, mixed> $attributes) : $this
Parameters
$attributes : array<string|int, mixed>
Return values
$this

setColumnIndex()

Set AutoFilter column index as string eg: 'A'.

public setColumnIndex(string $column) : $this
Parameters
$column : string

Column (e.g. A)

Return values
$this

setEvaluatedFalse()

public setEvaluatedFalse() : void

setFilterType()

Set AutoFilter Type.

public setFilterType(string $filterType) : $this
Parameters
$filterType : string
Return values
$this

setJoin()

Set AutoFilter Multiple Rules And/Or.

public setJoin(string $join) : $this
Parameters
$join : string

And/Or

Return values
$this

setParent()

Set this Column's AutoFilter Parent.

public setParent([AutoFilter|null $parent = null ]) : $this
Parameters
$parent : AutoFilter|null = null
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results