Search moodle.org's
Developer Documentation
Developer Documentation
- 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.
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: | 133 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
IReader:: (14 methods):
__construct()
canRead()
getReadDataOnly()
setReadDataOnly()
getReadEmptyCells()
setReadEmptyCells()
getIncludeCharts()
setIncludeCharts()
getLoadSheetsOnly()
setLoadSheetsOnly()
setLoadAllSheets()
getReadFilter()
setReadFilter()
load()
| __construct() X-Ref |
| IReader constructor. |
| canRead($pFilename) X-Ref |
| Can the current IReader read the file? param: string $pFilename return: bool |
| getReadDataOnly() X-Ref |
| Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information. If false (the default) it will read data and formatting. return: bool |
| setReadDataOnly($pValue) X-Ref |
| Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information. Set to false (the default) to advise the Reader to read both data and formatting for cells. param: bool $pValue return: IReader |
| getReadEmptyCells() X-Ref |
| Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value. If false it will not read data for cells containing a null value or an empty string. return: bool |
| setReadEmptyCells($pValue) X-Ref |
| Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value. Set to false to advise the Reader to ignore cells containing a null value or an empty string. param: bool $pValue return: IReader |
| getIncludeCharts() X-Ref |
| Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook. Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. If false (the default) it will ignore any charts defined in the workbook file. return: bool |
| setIncludeCharts($pValue) X-Ref |
| Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook. Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. Set to false (the default) to discard charts. param: bool $pValue return: IReader |
| getLoadSheetsOnly() X-Ref |
| Get which sheets to load Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null indicating that all worksheets in the workbook should be loaded. return: mixed |
| setLoadSheetsOnly($value) X-Ref |
| Set which sheets to load. param: mixed $value return: IReader |
| setLoadAllSheets() X-Ref |
| Set all sheets to load Tells the Reader to load all worksheets from the workbook. return: IReader |
| getReadFilter() X-Ref |
| Read filter. return: IReadFilter |
| setReadFilter(IReadFilter $pValue) X-Ref |
| Set read filter. return: IReader |
| load($pFilename) X-Ref |
| Loads PhpSpreadsheet from file. param: string $pFilename return: \PhpOffice\PhpSpreadsheet\Spreadsheet |
