Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/lib/phpspreadsheet/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/AutoFilter/ -> Column.php (source)

[Source view]

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

(no description)

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

Defines 1 class

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


Class: Column  - X-Ref

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

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

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

return: string

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

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

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

return: AutoFilter

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

param: AutoFilter $pParent
return: $this

getFilterType()   X-Ref
Get AutoFilter Type.

return: string

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

param: string $pFilterType
return: $this

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

return: string

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

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

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

param: string[] $attributes
return: $this

setAttribute($pName, $pValue)   X-Ref
Set An AutoFilter Attribute.

param: string $pName Attribute Name
param: string $pValue Attribute Value
return: $this

getAttributes()   X-Ref
Get AutoFilter Column Attributes.

return: string[]

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

param: string $pName Attribute Name
return: string

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

return: Column\Rule[]

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

param: int $pIndex 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 $pRule)   X-Ref
Add a new AutoFilter Column Rule to the ruleset.

return: $this

deleteRule($pIndex)   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 $pIndex 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.