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: | 871 lines (35 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
AutoFilter:: (22 methods):
__construct()
getParent()
setParent()
getRange()
setRange()
getColumns()
testColumnInRange()
getColumnOffset()
getColumn()
getColumnByOffset()
setColumn()
clearColumn()
shiftColumn()
filterTestInSimpleDataSet()
filterTestInDateGroupSet()
filterTestInCustomDataSet()
filterTestInPeriodDateSet()
dynamicFilterDateRange()
calculateTopTenValue()
showHideRows()
__clone()
__toString()
Class: AutoFilter - X-Ref
__construct($pRange = '', ?Worksheet $pSheet = null) X-Ref |
Create a new AutoFilter. param: string $pRange Cell range (i.e. A1:E10) param: Worksheet $pSheet |
getParent() X-Ref |
Get AutoFilter Parent Worksheet. return: Worksheet |
setParent(?Worksheet $pSheet = null) X-Ref |
Set AutoFilter Parent Worksheet. param: Worksheet $pSheet return: $this |
getRange() X-Ref |
Get AutoFilter Range. return: string |
setRange($pRange) X-Ref |
Set AutoFilter Range. param: string $pRange Cell range (i.e. A1:E10) return: $this |
getColumns() X-Ref |
Get all AutoFilter Columns. return: AutoFilter\Column[] |
testColumnInRange($column) X-Ref |
Validate that the specified column is in the AutoFilter range. param: string $column Column name (e.g. A) return: int The column offset within the autofilter range |
getColumnOffset($pColumn) X-Ref |
Get a specified AutoFilter Column Offset within the defined AutoFilter range. param: string $pColumn Column name (e.g. A) return: int The offset of the specified column within the autofilter range |
getColumn($pColumn) X-Ref |
Get a specified AutoFilter Column. param: string $pColumn Column name (e.g. A) return: AutoFilter\Column |
getColumnByOffset($pColumnOffset) X-Ref |
Get a specified AutoFilter Column by it's offset. param: int $pColumnOffset Column offset within range (starting from 0) return: AutoFilter\Column |
setColumn($pColumn) X-Ref |
Set AutoFilter. param: AutoFilter\Column|string $pColumn return: $this |
clearColumn($pColumn) X-Ref |
Clear a specified AutoFilter Column. param: string $pColumn Column name (e.g. A) return: $this |
shiftColumn($fromColumn, $toColumn) X-Ref |
Shift an AutoFilter Column Rule to a different column. Note: This method bypasses validation of the destination column to ensure it is within this AutoFilter range. Nor does it verify whether any column rule already exists at $toColumn, but will simply override any existing value. Use with caution. param: string $fromColumn Column name (e.g. A) param: string $toColumn Column name (e.g. B) return: $this |
filterTestInSimpleDataSet($cellValue, $dataSet) X-Ref |
Test if cell value is in the defined set of values. param: mixed $cellValue param: mixed[] $dataSet return: bool |
filterTestInDateGroupSet($cellValue, $dataSet) X-Ref |
Test if cell value is in the defined set of Excel date values. param: mixed $cellValue param: mixed[] $dataSet return: bool |
filterTestInCustomDataSet($cellValue, $ruleSet) X-Ref |
Test if cell value is within a set of values defined by a ruleset. param: mixed $cellValue param: mixed[] $ruleSet return: bool |
filterTestInPeriodDateSet($cellValue, $monthSet) X-Ref |
Test if cell date value is matches a set of values defined by a set of months. param: mixed $cellValue param: mixed[] $monthSet return: bool |
dynamicFilterDateRange($dynamicRuleType, &$filterColumn) X-Ref |
Convert a dynamic rule daterange to a custom filter range expression for ease of calculation. param: string $dynamicRuleType param: AutoFilter\Column $filterColumn return: mixed[] |
calculateTopTenValue($columnID, $startRow, $endRow, $ruleType, $ruleValue) X-Ref |
No description |
showHideRows() X-Ref |
Apply the AutoFilter rules to the AutoFilter Range. return: $this |
__clone() X-Ref |
Implement PHP __clone to create a deep clone, not just a shallow copy. |
__toString() X-Ref |
toString method replicates previous behavior by returning the range if object is referenced as a property of its parent. |