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: | 416 lines (17 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
| cellAddress($row, $column, $relativity = 1, $referenceStyle = true, $sheetText = '') X-Ref |
| CELL_ADDRESS. Creates a cell address as text, given specified row and column numbers. Excel Function: =ADDRESS(row, column, [relativity], [referenceStyle], [sheetText]) param: mixed $row Row number to use in the cell reference param: mixed $column Column number to use in the cell reference param: int $relativity Flag indicating the type of reference to return param: bool $referenceStyle A logical value that specifies the A1 or R1C1 reference style. param: array|string $sheetText Optional Name of worksheet to use return: array|string |
| COLUMN($cellAddress = null, ?Cell $cell = null) X-Ref |
| COLUMN. Returns the column number of the given cell reference If the cell reference is a range of cells, COLUMN returns the column numbers of each column in the reference as a horizontal array. If cell reference is omitted, and the function is being called through the calculation engine, then it is assumed to be the reference of the cell in which the COLUMN function appears; otherwise this function returns 1. Excel Function: =COLUMN([cellAddress]) param: null|array|string $cellAddress A reference to a range of cells for which you want the column numbers return: int|int[]|string |
| COLUMNS($cellAddress = null) X-Ref |
| COLUMNS. Returns the number of columns in an array or reference. Excel Function: =COLUMNS(cellAddress) param: null|array|string $cellAddress An array or array formula, or a reference to a range of cells return: int|string The number of columns in cellAddress, or a string if arguments are invalid |
| ROW($cellAddress = null, ?Cell $cell = null) X-Ref |
| ROW. Returns the row number of the given cell reference If the cell reference is a range of cells, ROW returns the row numbers of each row in the reference as a vertical array. If cell reference is omitted, and the function is being called through the calculation engine, then it is assumed to be the reference of the cell in which the ROW function appears; otherwise this function returns 1. Excel Function: =ROW([cellAddress]) param: null|array|string $cellAddress A reference to a range of cells for which you want the row numbers return: int|mixed[]|string |
| ROWS($cellAddress = null) X-Ref |
| ROWS. Returns the number of rows in an array or reference. Excel Function: =ROWS(cellAddress) param: null|array|string $cellAddress An array or array formula, or a reference to a range of cells return: int|string The number of rows in cellAddress, or a string if arguments are invalid |
| HYPERLINK($linkURL = '', $displayName = null, ?Cell $cell = null) X-Ref |
| HYPERLINK. Excel Function: =HYPERLINK(linkURL,displayName) param: mixed $linkURL Expect string. Value to check, is also the value returned when no error param: mixed $displayName Expect string. Value to return when testValue is an error condition param: Cell $cell The cell to set the hyperlink in return: string The value of $displayName (or $linkURL if $displayName was blank) |
| INDIRECT($cellAddress, Cell $cell) X-Ref |
| INDIRECT. Returns the reference specified by a text string. References are immediately evaluated to display their contents. Excel Function: =INDIRECT(cellAddress) param: array|string $cellAddress $cellAddress The cell address of the current cell (containing this formula) param: Cell $cell The current cell (containing this formula) return: array|string An array containing a cell or range of cells, or a string on error |
| OFFSET($cellAddress = null, $rows = 0, $columns = 0, $height = null, $width = null, ?Cell $cell = null) X-Ref |
| OFFSET. Returns a reference to a range that is a specified number of rows and columns from a cell or range of cells. The reference that is returned can be a single cell or a range of cells. You can specify the number of rows and the number of columns to be returned. Excel Function: =OFFSET(cellAddress, rows, cols, [height], [width]) param: null|string $cellAddress The reference from which you want to base the offset. param: mixed $rows The number of rows, up or down, that you want the upper-left cell to refer to. param: mixed $columns The number of columns, to the left or right, that you want the upper-left cell param: mixed $height The height, in number of rows, that you want the returned reference to be. param: mixed $width The width, in number of columns, that you want the returned reference to be. return: array|string An array containing a cell or range of cells, or a string on error |
| CHOOSE(...$chooseArgs) X-Ref |
| CHOOSE. Uses lookup_value to return a value from the list of value arguments. Use CHOOSE to select one of up to 254 values based on the lookup_value. Excel Function: =CHOOSE(index_num, value1, [value2], ...) return: mixed The selected value |
| MATCH($lookupValue, $lookupArray, $matchType = 1) X-Ref |
| MATCH. The MATCH function searches for a specified item in a range of cells Excel Function: =MATCH(lookup_value, lookup_array, [match_type]) param: mixed $lookupValue The value that you want to match in lookup_array param: mixed $lookupArray The range of cells being searched param: mixed $matchType The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. return: array|int|string The relative position of the found item |
| INDEX($matrix, $rowNum = 0, $columnNum = 0) X-Ref |
| INDEX. Uses an index to choose a value from a reference or array Excel Function: =INDEX(range_array, row_num, [column_num]) param: mixed $rowNum The row in the array or range from which to return a value. param: mixed $columnNum The column in the array or range from which to return a value. param: mixed $matrix return: mixed the value of a specified cell or array of cells |
| TRANSPOSE($matrixData) X-Ref |
| TRANSPOSE. param: array $matrixData A matrix of values return: array |
| VLOOKUP($lookup_value, $lookup_array, $index_number, $not_exact_match = true) X-Ref |
| VLOOKUP The VLOOKUP function searches for value in the left-most column of lookup_array and returns the value in the same row based on the index_number. param: mixed $lookup_value The value that you want to match in lookup_array param: mixed $lookup_array The range of cells being searched param: mixed $index_number The column number in table_array from which the matching value must be returned. param: mixed $not_exact_match determines if you are looking for an exact match based on lookup_value return: mixed The value of the found cell |
| HLOOKUP($lookup_value, $lookup_array, $index_number, $not_exact_match = true) X-Ref |
| HLOOKUP The HLOOKUP function searches for value in the top-most row of lookup_array and returns the value in the same column based on the index_number. param: mixed $lookup_value The value that you want to match in lookup_array param: mixed $lookup_array The range of cells being searched param: mixed $index_number The row number in table_array from which the matching value must be returned. param: mixed $not_exact_match determines if you are looking for an exact match based on lookup_value return: mixed The value of the found cell |
| LOOKUP($lookup_value, $lookup_vector, $result_vector = null) X-Ref |
| LOOKUP The LOOKUP function searches for value either from a one-row or one-column range or from an array. param: mixed $lookup_value The value that you want to match in lookup_array param: mixed $lookup_vector The range of cells being searched param: null|mixed $result_vector The column from which the matching value must be returned return: mixed The value of the found cell |
| FORMULATEXT($cellReference = '', ?Cell $cell = null) X-Ref |
| FORMULATEXT. param: mixed $cellReference The cell to check param: Cell $cell The current cell (containing this formula) return: string |
