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\RichText\RichText;
use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;

class AdvancedValueBinder extends DefaultValueBinder implements IValueBinder
{
    /**
     * Bind value to a cell.
     *
     * @param Cell $cell Cell to bind value to
     * @param mixed $value Value to bind in cell
     *
     * @return bool
     */
    public function bindValue(Cell $cell, $value = null)
    {
> if ($value === null) { // sanitize UTF-8 strings > return parent::bindValue($cell, $value); if (is_string($value)) { > } elseif (is_string($value)) {
< if (is_string($value)) {
} // Find out data type $dataType = parent::dataTypeForValue($value); // Style logic - strings if ($dataType === DataType::TYPE_STRING && !$value instanceof RichText) { // Test for booleans using locale-setting if ($value == Calculation::getTRUE()) { $cell->setValueExplicit(true, DataType::TYPE_BOOL); return true; } elseif ($value == Calculation::getFALSE()) { $cell->setValueExplicit(false, DataType::TYPE_BOOL); return true; }
< // Check for number in scientific format < if (preg_match('/^' . Calculation::CALCULATION_REGEXP_NUMBER . '$/', $value)) { < $cell->setValueExplicit((float) $value, DataType::TYPE_NUMERIC); < < return true; < } < < // Check for fraction
> // Check for fractions
if (preg_match('/^([+-]?)\s*(\d+)\s?\/\s*(\d+)$/', $value, $matches)) {
< // Convert value to number < $value = $matches[2] / $matches[3]; < if ($matches[1] == '-') { < $value = 0 - $value; < } < $cell->setValueExplicit((float) $value, DataType::TYPE_NUMERIC); < // Set style < $cell->getWorksheet()->getStyle($cell->getCoordinate()) < ->getNumberFormat()->setFormatCode('??/??'); < < return true;
> return $this->setProperFraction($matches, $cell);
} elseif (preg_match('/^([+-]?)(\d*) +(\d*)\s?\/\s*(\d*)$/', $value, $matches)) {
< // Convert value to number < $value = $matches[2] + ($matches[3] / $matches[4]); < if ($matches[1] == '-') { < $value = 0 - $value; < } < $cell->setValueExplicit((float) $value, DataType::TYPE_NUMERIC); < // Set style < $cell->getWorksheet()->getStyle($cell->getCoordinate()) < ->getNumberFormat()->setFormatCode('# ??/??'); < < return true;
> return $this->setImproperFraction($matches, $cell);
} // Check for percentage if (preg_match('/^\-?\d*\.?\d*\s?\%$/', $value)) {
< // Convert value to number < $value = (float) str_replace('%', '', $value) / 100; < $cell->setValueExplicit($value, DataType::TYPE_NUMERIC); < // Set style < $cell->getWorksheet()->getStyle($cell->getCoordinate()) < ->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_PERCENTAGE_00); < < return true;
> return $this->setPercentage($value, $cell);
} // Check for currency $currencyCode = StringHelper::getCurrencyCode(); $decimalSeparator = StringHelper::getDecimalSeparator(); $thousandsSeparator = StringHelper::getThousandsSeparator(); if (preg_match('/^' . preg_quote($currencyCode, '/') . ' *(\d{1,3}(' . preg_quote($thousandsSeparator, '/') . '\d{3})*|(\d+))(' . preg_quote($decimalSeparator, '/') . '\d{2})?$/', $value)) { // Convert value to number $value = (float) trim(str_replace([$currencyCode, $thousandsSeparator, $decimalSeparator], ['', '', '.'], $value)); $cell->setValueExplicit($value, DataType::TYPE_NUMERIC); // Set style $cell->getWorksheet()->getStyle($cell->getCoordinate()) ->getNumberFormat()->setFormatCode( str_replace('$', $currencyCode, NumberFormat::FORMAT_CURRENCY_USD_SIMPLE) ); return true; } elseif (preg_match('/^\$ *(\d{1,3}(\,\d{3})*|(\d+))(\.\d{2})?$/', $value)) { // Convert value to number $value = (float) trim(str_replace(['$', ','], '', $value)); $cell->setValueExplicit($value, DataType::TYPE_NUMERIC); // Set style $cell->getWorksheet()->getStyle($cell->getCoordinate()) ->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_CURRENCY_USD_SIMPLE); return true; } // Check for time without seconds e.g. '9:45', '09:45' if (preg_match('/^(\d|[0-1]\d|2[0-3]):[0-5]\d$/', $value)) {
< // Convert value to number < [$h, $m] = explode(':', $value); < $days = $h / 24 + $m / 1440; < $cell->setValueExplicit($days, DataType::TYPE_NUMERIC); < // Set style < $cell->getWorksheet()->getStyle($cell->getCoordinate()) < ->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_TIME3); < < return true;
> return $this->setTimeHoursMinutes($value, $cell);
} // Check for time with seconds '9:45:59', '09:45:59' if (preg_match('/^(\d|[0-1]\d|2[0-3]):[0-5]\d:[0-5]\d$/', $value)) {
< // Convert value to number < [$h, $m, $s] = explode(':', $value); < $days = $h / 24 + $m / 1440 + $s / 86400; < // Convert value to number < $cell->setValueExplicit($days, DataType::TYPE_NUMERIC); < // Set style < $cell->getWorksheet()->getStyle($cell->getCoordinate()) < ->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_TIME4); < < return true;
> return $this->setTimeHoursMinutesSeconds($value, $cell);
} // Check for datetime, e.g. '2008-12-31', '2008-12-31 15:59', '2008-12-31 15:59:10' if (($d = Date::stringToExcel($value)) !== false) { // Convert value to number $cell->setValueExplicit($d, DataType::TYPE_NUMERIC); // Determine style. Either there is a time part or not. Look for ':' if (strpos($value, ':') !== false) { $formatCode = 'yyyy-mm-dd h:mm'; } else { $formatCode = 'yyyy-mm-dd'; } $cell->getWorksheet()->getStyle($cell->getCoordinate()) ->getNumberFormat()->setFormatCode($formatCode); return true; } // Check for newline character "\n" if (strpos($value, "\n") !== false) {
< $value = StringHelper::sanitizeUTF8($value);
$cell->setValueExplicit($value, DataType::TYPE_STRING); // Set style $cell->getWorksheet()->getStyle($cell->getCoordinate()) ->getAlignment()->setWrapText(true); return true; } } // Not bound yet? Use parent... return parent::bindValue($cell, $value);
> } } > } > protected function setImproperFraction(array $matches, Cell $cell): bool > { > // Convert value to number > $value = $matches[2] + ($matches[3] / $matches[4]); > if ($matches[1] === '-') { > $value = 0 - $value; > } > $cell->setValueExplicit((float) $value, DataType::TYPE_NUMERIC); > > // Build the number format mask based on the size of the matched values > $dividend = str_repeat('?', strlen($matches[3])); > $divisor = str_repeat('?', strlen($matches[4])); > $fractionMask = "# {$dividend}/{$divisor}"; > // Set style > $cell->getWorksheet()->getStyle($cell->getCoordinate()) > ->getNumberFormat()->setFormatCode($fractionMask); > > return true; > } > > protected function setProperFraction(array $matches, Cell $cell): bool > { > // Convert value to number > $value = $matches[2] / $matches[3]; > if ($matches[1] === '-') { > $value = 0 - $value; > } > $cell->setValueExplicit((float) $value, DataType::TYPE_NUMERIC); > > // Build the number format mask based on the size of the matched values > $dividend = str_repeat('?', strlen($matches[2])); > $divisor = str_repeat('?', strlen($matches[3])); > $fractionMask = "{$dividend}/{$divisor}"; > // Set style > $cell->getWorksheet()->getStyle($cell->getCoordinate()) > ->getNumberFormat()->setFormatCode($fractionMask); > > return true; > } > > protected function setPercentage(string $value, Cell $cell): bool > { > // Convert value to number > $value = ((float) str_replace('%', '', $value)) / 100; > $cell->setValueExplicit($value, DataType::TYPE_NUMERIC); > > // Set style > $cell->getWorksheet()->getStyle($cell->getCoordinate()) > ->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_PERCENTAGE_00); > > return true; > } > > protected function setTimeHoursMinutes(string $value, Cell $cell): bool > { > // Convert value to number > [$hours, $minutes] = explode(':', $value); > $hours = (int) $hours; > $minutes = (int) $minutes; > $days = ($hours / 24) + ($minutes / 1440); > $cell->setValueExplicit($days, DataType::TYPE_NUMERIC); > > // Set style > $cell->getWorksheet()->getStyle($cell->getCoordinate()) > ->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_TIME3); > > return true; > } > > protected function setTimeHoursMinutesSeconds(string $value, Cell $cell): bool > { > // Convert value to number > [$hours, $minutes, $seconds] = explode(':', $value); > $hours = (int) $hours; > $minutes = (int) $minutes; > $seconds = (int) $seconds; > $days = ($hours / 24) + ($minutes / 1440) + ($seconds / 86400); > $cell->setValueExplicit($days, DataType::TYPE_NUMERIC); > > // Set style > $cell->getWorksheet()->getStyle($cell->getCoordinate()) > ->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_TIME4); > > return true;