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.
<?php

namespace PhpOffice\PhpSpreadsheet\Cell;

> use PhpOffice\PhpSpreadsheet\Calculation\Calculation; use PhpOffice\PhpSpreadsheet\Exception; > use PhpOffice\PhpSpreadsheet\Calculation\Functions;
class AddressHelper {
> public const R1C1_COORDINATE_REGEX = '/(R((?:\[-?\d*\])|(?:\d*))?)(C((?:\[-?\d*\])|(?:\d*))?)/i'; /** > * Converts an R1C1 format cell address to an A1 format cell address. > /** @return string[] */ */ > public static function getRowAndColumnChars() public static function convertToA1( > { string $address, > $rowChar = 'R'; int $currentRowNumber = 1, > $colChar = 'C'; int $currentColumnNumber = 1 > if (Functions::getCompatibilityMode() === Functions::COMPATIBILITY_EXCEL) { ): string { > $rowColChars = Calculation::localeFunc('*RC'); $validityCheck = preg_match('/^(R(\[?-?\d*\]?))(C(\[?-?\d*\]?))$/i', $address, $cellReference); > if (mb_strlen($rowColChars) === 2) { > $rowChar = mb_substr($rowColChars, 0, 1); if ($validityCheck === 0) { > $colChar = mb_substr($rowColChars, 1, 1); throw new Exception('Invalid R1C1-format Cell Reference'); > } } > } > $rowReference = $cellReference[2]; > return [$rowChar, $colChar]; // Empty R reference is the current row > } if ($rowReference === '') { >
< int $currentColumnNumber = 1
> int $currentColumnNumber = 1, > bool $useLocale = true
< $validityCheck = preg_match('/^(R(\[?-?\d*\]?))(C(\[?-?\d*\]?))$/i', $address, $cellReference);
> [$rowChar, $colChar] = $useLocale ? self::getRowAndColumnChars() : ['R', 'C']; > $regex = '/^(' . $rowChar . '(\[?[-+]?\d*\]?))(' . $colChar . '(\[?[-+]?\d*\]?))$/i'; > $validityCheck = preg_match($regex, $address, $cellReference);
< if ($validityCheck === 0) {
> if (empty($validityCheck)) {
if ($rowReference[0] === '[') {
< $rowReference = $currentRowNumber + trim($rowReference, '[]');
> $rowReference = $currentRowNumber + (int) trim($rowReference, '[]');
} $columnReference = $cellReference[4]; // Empty C reference is the current column if ($columnReference === '') { $columnReference = (string) $currentColumnNumber; } // Bracketed C references are relative to the current column if (is_string($columnReference) && $columnReference[0] === '[') {
< $columnReference = $currentColumnNumber + trim($columnReference, '[]');
> $columnReference = $currentColumnNumber + (int) trim($columnReference, '[]');
} if ($columnReference <= 0 || $rowReference <= 0) { throw new Exception('Invalid R1C1-format Cell Reference, Value out of range'); } $A1CellReference = Coordinate::stringFromColumnIndex($columnReference) . $rowReference; return $A1CellReference; }
> protected static function convertSpreadsheetMLFormula(string $formula): string /** > { * Converts a formula that uses R1C1 format cell address to an A1 format cell address. > $formula = substr($formula, 3); */ > $temp = explode('"', $formula); public static function convertFormulaToA1( > $key = false; string $formula, > foreach ($temp as &$value) { int $currentRowNumber = 1, > // Only replace in alternate array entries (i.e. non-quoted blocks) int $currentColumnNumber = 1 > if ($key = !$key) { ): string { > $value = str_replace(['[.', ':.', ']'], ['', ':', ''], $value); if (substr($formula, 0, 3) == 'of:') { > } $formula = substr($formula, 3); > } $temp = explode('"', $formula); > unset($value); $key = false; > foreach ($temp as &$value) { > return implode('"', $temp); // Only replace in alternate array entries (i.e. non-quoted blocks) > } if ($key = !$key) { >
< * Converts a formula that uses R1C1 format cell address to an A1 format cell address.
> * Converts a formula that uses R1C1/SpreadsheetXML format cell address to an A1 format cell address.
< $formula = substr($formula, 3); < $temp = explode('"', $formula); < $key = false; < foreach ($temp as &$value) { < // Only replace in alternate array entries (i.e. non-quoted blocks) < if ($key = !$key) { < $value = str_replace(['[.', '.', ']'], '', $value); < }
> // We have an old-style SpreadsheetML Formula > return self::convertSpreadsheetMLFormula($formula);
< } else {
>
< preg_match_all('/(R(\[?-?\d*\]?))(C(\[?-?\d*\]?))/', $value, $cellReferences, PREG_SET_ORDER + PREG_OFFSET_CAPTURE);
> preg_match_all(self::R1C1_COORDINATE_REGEX, $value, $cellReferences, PREG_SET_ORDER + PREG_OFFSET_CAPTURE);
// Reverse the matches array, otherwise all our offsets will become incorrect if we modify our way // through the formula from left to right. Reversing means that we work right to left.through // the formula $cellReferences = array_reverse($cellReferences); // Loop through each R1C1 style reference in turn, converting it to its A1 style equivalent, // then modify the formula to use that new reference foreach ($cellReferences as $cellReference) {
< $A1CellReference = self::convertToA1($cellReference[0][0], $currentRowNumber, $currentColumnNumber);
> $A1CellReference = self::convertToA1($cellReference[0][0], $currentRowNumber, $currentColumnNumber, false);
$value = substr_replace($value, $A1CellReference, $cellReference[0][1], strlen($cellReference[0][0])); } } }
< }
unset($value);
< // Then rebuild the formula string < $formula = implode('"', $temp);
< return $formula;
> // Then rebuild the formula string > return implode('"', $temp);
} /** * Converts an A1 format cell address to an R1C1 format cell address. * If $currentRowNumber or $currentColumnNumber are provided, then the R1C1 address will be formatted as a relative address. */ public static function convertToR1C1( string $address, ?int $currentRowNumber = null, ?int $currentColumnNumber = null ): string {
< $validityCheck = preg_match('/^\$?([A-Z]{1,3})\$?(\d{1,7})$/i', $address, $cellReference);
> $validityCheck = preg_match(Coordinate::A1_COORDINATE_REGEX, $address, $cellReference);
if ($validityCheck === 0) { throw new Exception('Invalid A1-format Cell Reference'); }
< $columnId = Coordinate::columnIndexFromString($cellReference[1]); < $rowId = (int) $cellReference[2];
> if ($cellReference['col'][0] === '$') { > // Column must be absolute address > $currentColumnNumber = null; > } > $columnId = Coordinate::columnIndexFromString(ltrim($cellReference['col'], '$')); > > if ($cellReference['row'][0] === '$') { > // Row must be absolute address > $currentRowNumber = null; > } > $rowId = (int) ltrim($cellReference['row'], '$');
if ($currentRowNumber !== null) { if ($rowId === $currentRowNumber) { $rowId = ''; } else { $rowId = '[' . ($rowId - $currentRowNumber) . ']'; } } if ($currentColumnNumber !== null) { if ($columnId === $currentColumnNumber) { $columnId = ''; } else { $columnId = '[' . ($columnId - $currentColumnNumber) . ']'; } } $R1C1Address = "R{$rowId}C{$columnId}"; return $R1C1Address; } }