Search moodle.org's
Developer Documentation
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.
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 1092 lines (41 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
AutoFilter:: (43 methods):
getEvaluated()
setEvaluated()
__construct()
getParent()
setParent()
getRange()
setRange()
setRangeToMaxRow()
getColumns()
testColumnInRange()
getColumnOffset()
getColumn()
getColumnByOffset()
setColumn()
clearColumn()
shiftColumn()
filterTestInSimpleDataSet()
filterTestInDateGroupSet()
filterTestInCustomDataSet()
filterTestInPeriodDateSet()
makeDateObject()
dynamicLastMonth()
firstDayOfQuarter()
dynamicLastQuarter()
dynamicLastWeek()
dynamicLastYear()
dynamicNextMonth()
dynamicNextQuarter()
dynamicNextWeek()
dynamicNextYear()
dynamicThisMonth()
dynamicThisQuarter()
dynamicThisWeek()
dynamicThisYear()
dynamicToday()
dynamicTomorrow()
dynamicYearToDate()
dynamicYesterday()
dynamicFilterDateRange()
calculateTopTenValue()
showHideRows()
__clone()
__toString()
Class: AutoFilter - X-Ref
| getEvaluated() X-Ref |
| No description |
| setEvaluated(bool $value) X-Ref |
| No description |
| __construct($range = '', ?Worksheet $worksheet = null) X-Ref |
| Create a new AutoFilter. param: AddressRange|array<int>|string $range |
| getParent() X-Ref |
| Get AutoFilter Parent Worksheet. return: null|Worksheet |
| setParent(?Worksheet $worksheet = null) X-Ref |
| Set AutoFilter Parent Worksheet. return: $this |
| getRange() X-Ref |
| Get AutoFilter Range. return: string |
| setRange($range = '') X-Ref |
| Set AutoFilter Cell Range. param: AddressRange|array<int>|string $range |
| setRangeToMaxRow() X-Ref |
| No description |
| 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($column) X-Ref |
| Get a specified AutoFilter Column Offset within the defined AutoFilter range. param: string $column Column name (e.g. A) return: int The offset of the specified column within the autofilter range |
| getColumn($column) X-Ref |
| Get a specified AutoFilter Column. param: string $column Column name (e.g. A) return: AutoFilter\Column |
| getColumnByOffset($columnOffset) X-Ref |
| Get a specified AutoFilter Column by it's offset. param: int $columnOffset Column offset within range (starting from 0) return: AutoFilter\Column |
| setColumn($columnObjectOrString) X-Ref |
| Set AutoFilter. param: AutoFilter\Column|string $columnObjectOrString return: $this |
| clearColumn($column) X-Ref |
| Clear a specified AutoFilter Column. param: string $column 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 |
| makeDateObject(int $year, int $month, int $day, int $hour = 0, int $minute = 0, int $second = 0) X-Ref |
| No description |
| dynamicLastMonth() X-Ref |
| No description |
| firstDayOfQuarter() X-Ref |
| No description |
| dynamicLastQuarter() X-Ref |
| No description |
| dynamicLastWeek() X-Ref |
| No description |
| dynamicLastYear() X-Ref |
| No description |
| dynamicNextMonth() X-Ref |
| No description |
| dynamicNextQuarter() X-Ref |
| No description |
| dynamicNextWeek() X-Ref |
| No description |
| dynamicNextYear() X-Ref |
| No description |
| dynamicThisMonth() X-Ref |
| No description |
| dynamicThisQuarter() X-Ref |
| No description |
| dynamicThisWeek() X-Ref |
| No description |
| dynamicThisYear() X-Ref |
| No description |
| dynamicToday() X-Ref |
| No description |
| dynamicTomorrow() X-Ref |
| No description |
| dynamicYearToDate() X-Ref |
| No description |
| dynamicYesterday() X-Ref |
| No description |
| dynamicFilterDateRange($dynamicRuleType, AutoFilter\Column &$filterColumn) X-Ref |
| Convert a dynamic rule daterange to a custom filter range expression for ease of calculation. param: string $dynamicRuleType return: mixed[] |
| calculateTopTenValue($columnID, $startRow, $endRow, $ruleType, $ruleValue) X-Ref |
| Apply the AutoFilter rules to the AutoFilter Range. param: string $columnID param: int $startRow param: int $endRow param: ?string $ruleType param: mixed $ruleValue return: mixed |
| 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. |
