Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/phpspreadsheet/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/AutoFilter/ -> Column.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

(no description)

File Size: 404 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Column:: (22 methods):
  __construct()
  setEvaluatedFalse()
  getColumnIndex()
  setColumnIndex()
  getParent()
  setParent()
  getFilterType()
  setFilterType()
  getJoin()
  setJoin()
  setAttributes()
  setAttribute()
  getAttributes()
  getAttribute()
  ruleCount()
  getRules()
  getRule()
  createRule()
  addRule()
  deleteRule()
  clearRules()
  __clone()


Class: Column  - X-Ref

__construct($column, ?AutoFilter $parent = null)   X-Ref
Create a new Column.

param: string $column Column (e.g. A)
param: AutoFilter $parent Autofilter for this column

setEvaluatedFalse()   X-Ref
No description

getColumnIndex()   X-Ref
Get AutoFilter column index as string eg: 'A'.

return: string

setColumnIndex($column)   X-Ref
Set AutoFilter column index as string eg: 'A'.

param: string $column Column (e.g. A)
return: $this

getParent()   X-Ref
Get this Column's AutoFilter Parent.

return: null|AutoFilter

setParent(?AutoFilter $parent = null)   X-Ref
Set this Column's AutoFilter Parent.

return: $this

getFilterType()   X-Ref
Get AutoFilter Type.

return: string

setFilterType($filterType)   X-Ref
Set AutoFilter Type.

param: string $filterType
return: $this

getJoin()   X-Ref
Get AutoFilter Multiple Rules And/Or Join.

return: string

setJoin($join)   X-Ref
Set AutoFilter Multiple Rules And/Or.

param: string $join And/Or
return: $this

setAttributes($attributes)   X-Ref
Set AutoFilter Attributes.

param: mixed[] $attributes
return: $this

setAttribute($name, $value)   X-Ref
Set An AutoFilter Attribute.

param: string $name Attribute Name
param: int|string $value Attribute Value
return: $this

getAttributes()   X-Ref
Get AutoFilter Column Attributes.

return: int[]|string[]

getAttribute($name)   X-Ref
Get specific AutoFilter Column Attribute.

param: string $name Attribute Name
return: null|int|string

ruleCount()   X-Ref
No description

getRules()   X-Ref
Get all AutoFilter Column Rules.

return: Column\Rule[]

getRule($index)   X-Ref
Get a specified AutoFilter Column Rule.

param: int $index Rule index in the ruleset array
return: Column\Rule

createRule()   X-Ref
Create a new AutoFilter Column Rule in the ruleset.

return: Column\Rule

addRule(Column\Rule $rule)   X-Ref
Add a new AutoFilter Column Rule to the ruleset.

return: $this

deleteRule($index)   X-Ref
Delete a specified AutoFilter Column Rule
If the number of rules is reduced to 1, then we reset And/Or logic to Or.

param: int $index Rule index in the ruleset array
return: $this

clearRules()   X-Ref
Delete all AutoFilter Column Rules.

return: $this

__clone()   X-Ref
Implement PHP __clone to create a deep clone, not just a shallow copy.