mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-09-02 13:41:21 +00:00
oleibman
e4e99b8a73
* Permit Date/Time Entered on Spreadsheet to be Calculated as Float Fix #1416. I do not entirely understand the use case for this old issue, but resolving it seems straightforward. Issue complains that user-entered date/time fields may be interpreted as either float or int when PhpSpreadsheet reads them. Issue suggests getCalculatedValue treat all date/time fields as float; that seems like a breaking change. However, adding an option to permit it seems okay. That option might be implemented as either a property of Calculation, or a static property of Cell. Since the changed logic is found in Cell (and Shared/Date), I opted for the latter. In Cell, the property `$parent` is incorrectly described in doc block as `Cells`, and should be `?Cells`. This change eliminates some Phpstan and Scrutinizer problems, and should allow the elimination of some try/catch blocks - I have not done an exhaustive search for those. Calls to `isDateTime` could have affected activeSheet and selectedCells; they no longer can. Optional parameters are added to it and the functions it calls to accommodate the new functionality; the defaults for the new parameters will, of course, return the same result as the earlier versions of the functions would have returned. * Scrutinizer - Self-inflicted Tests used constant which I deprecated.
213 lines
9.7 KiB
PHP
213 lines
9.7 KiB
PHP
<?php
|
|
|
|
namespace PhpOffice\PhpSpreadsheetTests\Shared;
|
|
|
|
use PhpOffice\PhpSpreadsheet\Calculation\Exception as CalculationException;
|
|
use PhpOffice\PhpSpreadsheet\Cell\Cell;
|
|
use PhpOffice\PhpSpreadsheet\Spreadsheet;
|
|
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class Date2Test extends TestCase
|
|
{
|
|
/** @var ?Spreadsheet */
|
|
private $spreadsheet;
|
|
|
|
/** @var int */
|
|
private $calculateDateTimeType;
|
|
|
|
protected function setUp(): void
|
|
{
|
|
$this->calculateDateTimeType = Cell::getCalculateDateTimeType();
|
|
}
|
|
|
|
protected function tearDown(): void
|
|
{
|
|
Cell::setCalculateDateTimeType($this->calculateDateTimeType);
|
|
if ($this->spreadsheet !== null) {
|
|
$this->spreadsheet->disconnectWorksheets();
|
|
$this->spreadsheet = null;
|
|
}
|
|
}
|
|
|
|
public function testInvalidType(): void
|
|
{
|
|
$this->expectException(CalculationException::class);
|
|
$this->expectExceptionMessage('for calculated date time type');
|
|
Cell::setCalculateDateTimeType(-1);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerTimeOnly
|
|
*
|
|
* @param float|int $expectedResult
|
|
* @param float|int $value
|
|
* @param string $format
|
|
*/
|
|
public function testTimeOnly($expectedResult, $value, ?string $format = null): void
|
|
{
|
|
Cell::setCalculateDateTimeType(Cell::CALCULATE_TIME_FLOAT);
|
|
$this->spreadsheet = new Spreadsheet();
|
|
self::assertSame(0, $this->spreadsheet->getActiveSheetIndex());
|
|
$sheet = $this->spreadsheet->getActiveSheet();
|
|
$newSheet = $this->spreadsheet->createSheet();
|
|
$newSheet->getCell('B7')->setValue('Here');
|
|
$sheet->getCell('A1')->setValue($value);
|
|
if ($format !== null) {
|
|
$sheet->getStyle('A1')->getNumberFormat()->setFormatCode($format);
|
|
}
|
|
$sheet->setSelectedCells('B7');
|
|
$this->spreadsheet->setActiveSheetIndex(1);
|
|
self::assertSame($expectedResult, $sheet->getCell('A1')->getCalculatedValue());
|
|
self::assertSame('B7', $sheet->getSelectedCells());
|
|
self::assertSame(1, $this->spreadsheet->getActiveSheetIndex());
|
|
}
|
|
|
|
public function providerTimeOnly(): array
|
|
{
|
|
$integerValue = 44046;
|
|
$integerValueAsFloat = (float) $integerValue;
|
|
$integerValueAsDateFormula = '=DATEVALUE("2020-08-03")';
|
|
$floatValue = 44015.25;
|
|
$floatValueAsDateFormula = '=DATEVALUE("2020-07-03")+TIMEVALUE("06:00")';
|
|
|
|
return [
|
|
'default format integer' => [$integerValue, $integerValue],
|
|
'default format float' => [$floatValue, $floatValue],
|
|
'date format integer' => [$integerValue, $integerValue, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
'date format float' => [$floatValue, $floatValue, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
'datetime format integer' => [$integerValueAsFloat, $integerValue, 'yyyy-mm-dd h:mm'],
|
|
'datetime format float' => [$floatValue, $floatValue, 'yyyy-mm-dd h:mm'],
|
|
'time format integer' => [$integerValueAsFloat, $integerValue, NumberFormat::FORMAT_DATE_TIME1],
|
|
'time format float' => [$floatValue, $floatValue, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula integer fltfmt' => [$integerValueAsFloat, $integerValueAsDateFormula, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula float' => [$floatValue, $floatValueAsDateFormula, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula integer intfmt but formula returns float' => [$integerValueAsFloat, $integerValueAsDateFormula, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerDateAndTime
|
|
*
|
|
* @param float|int $expectedResult
|
|
* @param float|int $value
|
|
* @param string $format
|
|
*/
|
|
public function testDateAndTime($expectedResult, $value, ?string $format = null): void
|
|
{
|
|
Cell::setCalculateDateTimeType(Cell::CALCULATE_DATE_TIME_FLOAT);
|
|
$this->spreadsheet = new Spreadsheet();
|
|
self::assertSame(0, $this->spreadsheet->getActiveSheetIndex());
|
|
$sheet = $this->spreadsheet->getActiveSheet();
|
|
$newSheet = $this->spreadsheet->createSheet();
|
|
$newSheet->getCell('B7')->setValue('Here');
|
|
$sheet->getCell('A1')->setValue($value);
|
|
if ($format !== null) {
|
|
$sheet->getStyle('A1')->getNumberFormat()->setFormatCode($format);
|
|
}
|
|
$sheet->setSelectedCells('B7');
|
|
$this->spreadsheet->setActiveSheetIndex(1);
|
|
self::assertSame($expectedResult, $sheet->getCell('A1')->getCalculatedValue());
|
|
self::assertSame('B7', $sheet->getSelectedCells());
|
|
self::assertSame(1, $this->spreadsheet->getActiveSheetIndex());
|
|
}
|
|
|
|
public function providerDateAndTime(): array
|
|
{
|
|
$integerValue = 44046;
|
|
$integerValueAsFloat = (float) $integerValue;
|
|
$integerValueAsDateFormula = '=DATEVALUE("2020-08-03")';
|
|
$floatValue = 44015.25;
|
|
$floatValueAsDateFormula = '=DATEVALUE("2020-07-03")+TIMEVALUE("06:00")';
|
|
|
|
return [
|
|
'default format integer' => [$integerValue, $integerValue],
|
|
'default format float' => [$floatValue, $floatValue],
|
|
'date format integer' => [$integerValueAsFloat, $integerValue, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
'date format float' => [$floatValue, $floatValue, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
'datetime format integer' => [$integerValueAsFloat, $integerValue, 'yyyy-mm-dd h:mm'],
|
|
'datetime format float' => [$floatValue, $floatValue, 'yyyy-mm-dd h:mm'],
|
|
'time format integer' => [$integerValueAsFloat, $integerValue, NumberFormat::FORMAT_DATE_TIME1],
|
|
'time format float' => [$floatValue, $floatValue, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula integer fltfmt' => [$integerValueAsFloat, $integerValueAsDateFormula, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula float' => [$floatValue, $floatValueAsDateFormula, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula integer intfmt but formula returns float' => [$integerValueAsFloat, $integerValueAsDateFormula, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerAsis
|
|
*
|
|
* @param float|int $expectedResult
|
|
* @param float|int $value
|
|
* @param string $format
|
|
*/
|
|
public function testDefault($expectedResult, $value, ?string $format = null): void
|
|
{
|
|
//Cell::setCalculateDateTimeType(Cell::CALCULATE_DATE_TIME_ASIS);
|
|
$this->spreadsheet = new Spreadsheet();
|
|
self::assertSame(0, $this->spreadsheet->getActiveSheetIndex());
|
|
$sheet = $this->spreadsheet->getActiveSheet();
|
|
$newSheet = $this->spreadsheet->createSheet();
|
|
$newSheet->getCell('B7')->setValue('Here');
|
|
$sheet->getCell('A1')->setValue($value);
|
|
if ($format !== null) {
|
|
$sheet->getStyle('A1')->getNumberFormat()->setFormatCode($format);
|
|
}
|
|
$sheet->setSelectedCells('B7');
|
|
$this->spreadsheet->setActiveSheetIndex(1);
|
|
self::assertSame($expectedResult, $sheet->getCell('A1')->getCalculatedValue());
|
|
self::assertSame('B7', $sheet->getSelectedCells());
|
|
self::assertSame(1, $this->spreadsheet->getActiveSheetIndex());
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerAsis
|
|
*
|
|
* @param float|int $expectedResult
|
|
* @param float|int $value
|
|
* @param string $format
|
|
*/
|
|
public function testAsis($expectedResult, $value, ?string $format = null): void
|
|
{
|
|
Cell::setCalculateDateTimeType(Cell::CALCULATE_DATE_TIME_ASIS);
|
|
$this->spreadsheet = new Spreadsheet();
|
|
self::assertSame(0, $this->spreadsheet->getActiveSheetIndex());
|
|
$sheet = $this->spreadsheet->getActiveSheet();
|
|
$newSheet = $this->spreadsheet->createSheet();
|
|
$newSheet->getCell('B7')->setValue('Here');
|
|
$sheet->getCell('A1')->setValue($value);
|
|
if ($format !== null) {
|
|
$sheet->getStyle('A1')->getNumberFormat()->setFormatCode($format);
|
|
}
|
|
$sheet->setSelectedCells('B7');
|
|
$this->spreadsheet->setActiveSheetIndex(1);
|
|
self::assertSame($expectedResult, $sheet->getCell('A1')->getCalculatedValue());
|
|
self::assertSame('B7', $sheet->getSelectedCells());
|
|
self::assertSame(1, $this->spreadsheet->getActiveSheetIndex());
|
|
}
|
|
|
|
public function providerAsis(): array
|
|
{
|
|
$integerValue = 44046;
|
|
$integerValueAsFloat = (float) $integerValue;
|
|
$integerValueAsDateFormula = '=DATEVALUE("2020-08-03")';
|
|
$floatValue = 44015.25;
|
|
$floatValueAsDateFormula = '=DATEVALUE("2020-07-03")+TIMEVALUE("06:00")';
|
|
|
|
return [
|
|
'default format integer' => [$integerValue, $integerValue],
|
|
'default format float' => [$floatValue, $floatValue],
|
|
'date format integer' => [$integerValue, $integerValue, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
'date format float' => [$floatValue, $floatValue, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
'datetime format integer' => [$integerValue, $integerValue, 'yyyy-mm-dd h:mm'],
|
|
'datetime format float' => [$floatValue, $floatValue, 'yyyy-mm-dd h:mm'],
|
|
'time format integer' => [$integerValue, $integerValue, NumberFormat::FORMAT_DATE_TIME1],
|
|
'time format float' => [$floatValue, $floatValue, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula integer fltfmt' => [$integerValueAsFloat, $integerValueAsDateFormula, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula float' => [$floatValue, $floatValueAsDateFormula, NumberFormat::FORMAT_DATE_TIME1],
|
|
'date formula integer intfmt but formula returns float' => [$integerValueAsFloat, $integerValueAsDateFormula, NumberFormat::FORMAT_DATE_YYYYMMDD],
|
|
];
|
|
}
|
|
}
|