geckon01/PhpSpreadsheet
1
0
Fork 0
mirror of https://github.com/PHPOffice/PhpSpreadsheet.git synced 2026-09-19 06:26:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Populate Rest of Array Cells, UNIQUE Changes

Browse Source 
See issue #4062. When calculating an array formula, populate all the cells associated with the result. This is almost the same as Excel's behavior. As yet, there is no attempt to create a #SPILL error, so cells may be inappropriately overwritten. Also, if the array size shrinks (e.g. there are fewer unique values than before),  no attempt is made to unpopulate the cells which were in range but are now outside the new dimensions. Spill and unpopulation are somewhat related, and will probably be handled at the same time, but their time has not yet come.

UNIQUE, at least for rows, was treating all cell (calculated) values as strings. This is not the same behavior as Excel, which will preserve datatypes, and treat int 3 and string 3 as unique values. Excel will, however, treat int 3 and float 3.0 as non-unique. Within UNIQUE, private function uniqueByRow is changed to try to preserve the the datatype when executing (it will probably treat 3.0 as int - I don't know how I can, or even if I should attempt to, do better - but no int nor float should be treated as a string).
This commit is contained in:
oleibman
2024-06-06 06:52:14 -07:00
parent b79cd20f75
commit 08ba00b575
6 changed files with 411 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/PhpSpreadsheet/Calculation/LookupRef/Unique.php
+19 -2
View File
@@ -40,7 +40,17 @@ class Unique
array_walk(
$lookupVector,
function (array &$value): void {
$value = implode(chr(0x00), $value);
$valuex = '';
$separator = '';
$numericIndicator = "\x01";
foreach ($value as $cellValue) {
$valuex .= $separator . $cellValue;
$separator = "\x00";
if (is_int($cellValue) || is_float($cellValue)) {
$valuex .= $numericIndicator;
}
}
$value = $valuex;
}
);
@@ -60,7 +70,14 @@ class Unique
array_walk(
$result,
function (string &$value): void {
$value = explode(chr(0x00), $value);
$value = explode("\x00", $value);
foreach ($value as &$stringValue) {
if (str_ends_with($stringValue, "\x01")) {
// x01 should only end a string which is otherwise a float or int,
// so phpstan is technically correct but what it fears should not happen.
$stringValue = 0 + substr($stringValue, 0, -1); //@phpstan-ignore-line
}
}
}
);
src/PhpSpreadsheet/Cell/Cell.php
+16
View File
@@ -390,6 +390,22 @@ class Cell implements Stringable
}
}
}
if (is_array($result)) {
$newRow = $row = $this->getRow();
$column = $this->getColumn();
foreach ($result as $resultRow) {
$newColumn = $column;
$resultRowx = is_array($resultRow) ? $resultRow : [$resultRow];
foreach ($resultRowx as $resultValue) {
if ($row !== $newRow || $column !== $newColumn) {
$this->getWorksheet()->getCell($newColumn . $newRow)->setValue($resultValue);
}
++$newColumn;
}
++$newRow;
}
$this->getWorksheet()->getCell($column . $row);
}
} catch (SpreadsheetException $ex) {
if (($ex->getMessage() === 'Unable to access External Workbook') && ($this->calculatedValue !== null)) {
return $this->calculatedValue; // Fallback for calculations referencing external files.
tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/UniqueTest.php
+7 -4
View File
@@ -16,7 +16,7 @@ class UniqueTest extends TestCase
public function testUnique(array $expectedResult, array $lookupRef, bool $byColumn = false, bool $exactlyOnce = false): void
{
$result = LookupRef\Unique::unique($lookupRef, $byColumn, $exactlyOnce);
self::assertEquals($expectedResult, $result);
self::assertSame($expectedResult, $result);
}
public function testUniqueException(): void
@@ -36,10 +36,10 @@ class UniqueTest extends TestCase
];
$result = LookupRef\Unique::unique($rowLookupData, false, true);
self::assertEquals(ExcelError::CALC(), $result);
self::assertSame(ExcelError::CALC(), $result);
$result = LookupRef\Unique::unique($columnLookupData, true, true);
self::assertEquals(ExcelError::CALC(), $result);
self::assertSame(ExcelError::CALC(), $result);
}
public function testUniqueWithScalar(): void
@@ -145,13 +145,16 @@ class UniqueTest extends TestCase
],
],
[
[[1.2], [2.1], [2.2], [3.0]],
[[1.2], [2.1], [2.2], [3], ['3'], [8.7]],
[
[1.2],
[1.2],
[2.1],
[2.2],
[3.0],
[3],
['3'],
[8.7],
],
],
];
tests/PhpSpreadsheetTests/Writer/Xlsx/ArrayFunctions2Test.php
+307
View File
@@ -0,0 +1,307 @@
<?php
// not yet ready for prime time
declare(strict_types=1);
namespace PhpOffice\PhpSpreadsheetTests\Writer\Xlsx;
use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
use PhpOffice\PhpSpreadsheet\Cell\DataValidation;
use PhpOffice\PhpSpreadsheet\NamedRange;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\Alignment;
use PhpOffice\PhpSpreadsheet\Style\Border;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use PHPUnit\Framework\TestCase;
class ArrayFunctions2Test extends TestCase
{
private const STYLESIZE14 = [
'font' => [
'size' => 14,
],
];
private const STYLEBOLD = [
'font' => [
'bold' => true,
],
];
private const STYLEBOLD14 = [
'font' => [
'bold' => true,
'size' => 14,
],
];
private const STYLECENTER = [
'alignment' => [
'horizontal' => Alignment::HORIZONTAL_CENTER,
],
];
private const STYLETHICKBORDER = [
'borders' => [
'outline' => [
'borderStyle' => Border::BORDER_THICK,
'color' => ['argb' => '00000000'],
],
],
];
private array $trn;
private string $arrayReturnType;
private string $outputFile = '';
protected function setUp(): void
{
$this->arrayReturnType = Calculation::getArrayReturnType();
}
protected function tearDown(): void
{
Calculation::setArrayReturnType($this->arrayReturnType);
if ($this->outputFile !== '') {
unlink($this->outputFile);
$this->outputFile = '';
}
}
private function odd(int $i): bool
{
return ($i % 2) === 1;
}
private function doPartijen(Worksheet $ws): int
{
$saring = explode("\n", $this->trn['PARINGEN']);
$s = $this->trn['PLAYERSNOID'];
$g = $this->trn['RONDEGAMES'];
$KD = $this->trn['KALENDERDATA'];
$si = $this->trn['PLAYERSIDS'];
$a = [
['Wit', null, null, null, 'Zwart', null, null, null, 'Wit', 'Uitslag', 'Zwart', 'Opmerking', 'Datum'],
['Winstpunten', 'Weerstandspunten', 'punten', 'Tegenpunten', 'Winstpunten', 'Weerstandspunten', 'punten', 'Tegenpunten'],
];
$ws->fromArray($a, null, 'A1');
$ws->getStyle('A1:L1')->applyFromArray(self::STYLEBOLD);
$ws->getStyle('A1:L1')->applyFromArray(self::STYLESIZE14);
$lijn = 1;
for ($i = 1; $i <= $this->trn['RONDEN']; ++$i) {//aantal ronden oneven->heen en even->terug
for ($j = 0; $j < count($saring); ++$j) {//subronden
++$lijn;
if (isset($KD[(($i - 1) * $this->trn['SUB_RONDEN']) + $j], $KD[(($i - 1) * $this->trn['SUB_RONDEN']) + $j]['RONDE'])) {
$ws->setCellValue([9, $lijn], $KD[(($i - 1) * $this->trn['SUB_RONDEN']) + $j]['RONDE']);
} else {
$ws->setCellValue([9, $lijn], 'Kalenderdata zijn niet(volledig) ingevuld');
}
if (isset($KD[(($i - 1) * $this->trn['SUB_RONDEN']) + $j], $KD[(($i - 1) * $this->trn['SUB_RONDEN']) + $j]['TXT'])) {
$ws->setCellValue([10, $lijn], $KD[(($i - 1) * $this->trn['SUB_RONDEN']) + $j]['TXT']);
} else {
$ws->setCellValue([10, $lijn], 'Kalenderdata zijn niet(volledig) ingevuld');
}
$ws->getStyle('A' . $lijn . ':L' . $lijn . '')->applyFromArray(self::STYLEBOLD14);
$s2 = explode(' ', $saring[$j]);
for ($k = 0; $k < count($s2); ++$k) {//borden
if (trim($s2[$k]) == '') {
continue;
}
$s3 = explode('-', $s2[$k]); //wit-zwart
$s3[0] = (int) $s3[0];
$s3[1] = (int) $s3[1];
++$lijn;
$ws->setCellValue([1, $lijn], '=IF(SUBSTITUTE(TRIM($J' . $lijn . '),"-","")="","",XLOOKUP($K' . $lijn . ',Spelers!$B$2:$B$' . (count($s) + 1) . ',Spelers!$C$2:$C$' . (count($s) + 1) . ',FALSE) * VLOOKUP(J' . $lijn . ', PuntenLijst,4,FALSE))');
$ws->setCellValue([2, $lijn], '=IF(SUBSTITUTE(TRIM($J' . $lijn . '),"-","")="","",VLOOKUP($K' . $lijn . ',Spelers!$B$2:$D$' . (count($s) + 1) . ',3,FALSE) * VLOOKUP(J' . $lijn . ', PuntenLijst,5,FALSE))');
$ws->setCellValue([3, $lijn], '=IF(TRIM($J' . $lijn . ')="","",XLOOKUP($J' . $lijn . ', Punten!$A$2:$A$50,Punten!$B$2:$B$50,0,0))');
$ws->setCellValue([4, $lijn], '=IF(TRIM($J' . $lijn . ')="","",XLOOKUP($J' . $lijn . ', Punten!$A$2:$A$50,Punten!$G$2:$G$50,0,0))');
$ws->setCellValue([5, $lijn], '=IF(SUBSTITUTE(TRIM($J' . $lijn . '),"-","")="","",VLOOKUP($I' . $lijn . ',Spelers!$B$2:$D$' . (count($s) + 1) . ',3,FALSE) * VLOOKUP(J' . $lijn . ', PuntenLijst,6,FALSE))');
$ws->setCellValue([6, $lijn], '=IF(SUBSTITUTE(TRIM($J' . $lijn . '),"-","")="","",VLOOKUP($I' . $lijn . ',Spelers!$B$2:$D$' . (count($s) + 1) . ',3,FALSE) * VLOOKUP(J' . $lijn . ', PuntenLijst,5,FALSE))');
$ws->setCellValue([7, $lijn], '=IF(TRIM($J' . $lijn . ')="","",XLOOKUP($J' . $lijn . ', Punten!$A$2:$A$50,Punten!$C$2:$C$50,0,0))');
$ws->setCellValue([8, $lijn], '=IF(TRIM($J' . $lijn . ')="","",XLOOKUP($J' . $lijn . ', Punten!$A$2:$A$50,Punten!$H$2:$H$50,0,0))');
if ($this->odd($i)) {
if (
isset($g[$i][$si[((int) $s3[0]) - 1]][$si[((int) $s3[1]) - 1]])
) {
$pw = $g[$i][$si[((int) $s3[0]) - 1]][$si[((int) $s3[1]) - 1]];
} else {
$pw = ['SYMBOOLWIT' => '', 'SYMBOOLZWART' => '', 'UITSLAG' => '', 'OPMERKING' => '', 'DATUM' => ''];
}
$ws->setCellValue([9, $lijn], '=Spelers!$B$' . ($s3[0] + 1));
$ws->setCellValue([11, $lijn], '=Spelers!$B$' . ($s3[1] + 1));
} else {
if (
isset($g[$i][$si[((int) $s3[1]) - 1]][$si[((int) $s3[0]) - 1]])
) {
$pw = $g[$i][$si[((int) $s3[1]) - 1]][$si[((int) $s3[0]) - 1]];
} else {
$pw = ['SYMBOOLWIT' => '', 'SYMBOOLZWART' => '', 'UITSLAG' => '', 'OPMERKING' => '', 'DATUM' => ''];
}
$ws->setCellValue([9, $lijn], '=Spelers!$B$' . ($s3[1] + 1));
$ws->setCellValue([11, $lijn], '=Spelers!$B$' . ($s3[0] + 1));
}
if ($pw['SYMBOOLWIT'] != '') {
$ws->setCellValue([10, $lijn], $pw['SYMBOOLWIT'] . '-' . $pw['SYMBOOLZWART']);
}
$ws->setCellValue([13, $lijn], $pw['OPMERKING']);
$ws->setCellValue([14, $lijn], $pw['DATUM']);
$this->doValidationPunten($ws, 'J' . $lijn);
$ws->getRowDimension($lijn)->setOutlineLevel(1);
}
++$lijn;
}
++$lijn;
}
$ws->getStyle('J1:J' . $lijn)->applyFromArray(self::STYLECENTER);
$ws->getColumnDimension('A')->setVisible(false);
$ws->getColumnDimension('B')->setVisible(false);
$ws->getColumnDimension('C')->setVisible(false);
$ws->getColumnDimension('D')->setVisible(false);
$ws->getColumnDimension('E')->setVisible(false);
$ws->getColumnDimension('F')->setVisible(false);
$ws->getColumnDimension('G')->setVisible(false);
$ws->getColumnDimension('H')->setVisible(false);
for ($i = 65; $i < ord('M'); ++$i) {
$ws->getColumnDimension(chr($i))->setAutoSize(true);
}
$ws->setAutoFilter('A2:M' . $lijn);
$ws->setSelectedCell('A1');
return $lijn;
}
private function doValidationPunten(Worksheet $s, string $cel): void
{
$validation = $s->getCell($cel)->getDataValidation();
$validation->setType(DataValidation::TYPE_LIST);
$validation->setErrorStyle(DataValidation::STYLE_STOP);
$validation->setAllowBlank(false);
$validation->setShowInputMessage(false);
$validation->setShowErrorMessage(true);
$validation->setShowDropDown(true);
$validation->setFormula1('=punten');
}
private function doPunten(Spreadsheet $ss, Worksheet $ws): void
{
$ws->fromArray(['Uitslag', 'Wit', 'Zwart', 'Winstverhouding WIT', 'Weerstandverhouding', 'Winstverhouding ZWART', 'Tegenpunten Wit', 'Tegenpunten Zwart'], null, 'A1');
$ws->fromArray(['0-3', '0', '3', '0', '1', '1', '0', '0'], null, 'A2');
$ws->fromArray(['1-3', '1', '3', '0', '1', '1', '0', '-1'], null, 'A3');
$ws->fromArray(['2-3', '2', '3', '0', '1', '1', '0', '-2'], null, 'A4');
$ws->fromArray(['3-0', '3', '0', '1', '1', '0', '0', '0'], null, 'A5');
$ws->fromArray(['3-1', '3', '1', '1', '1', '0', '-1', '0'], null, 'A6');
$ws->fromArray(['3-2', '3', '2', '1', '1', '0', '-2', '0'], null, 'A7');
$ws->fromArray(['U-U', '0', '0', '0', '0', '0', '0', '0'], null, 'A8');
$ss->addNamedRange(new NamedRange('Punten', $ws, '=$A$2:$A$8'));
$ss->addNamedRange(new NamedRange('PuntenLijst', $ws, '=$A$2:$H$8'));
$ws->getStyle('A1:H1')->applyFromArray(self::STYLETHICKBORDER);
$ws->getStyle('A1:A8')->applyFromArray(self::STYLETHICKBORDER);
$ws->getStyle('B2:H8')->applyFromArray(self::STYLETHICKBORDER);
for ($i = 65; $i < ord('I'); ++$i) {
$ws->getColumnDimension(chr($i))->setAutoSize(true);
}
$ws->setSelectedCell('A1');
}
private function doSpelers(Worksheet $ws, int $maxLijn): void
{
$this->doKoppen($ws);
$i = 1;
foreach ($this->trn['SPELERS'] as $speler) {
$ws->setCellValue([1, ++$i], '=RANK(D' . $i . ',$D$2:$D$' . (count($this->trn['SPELERS']) + 1) . ',0)-1+COUNTIF($D$2:D' . $i . ',D' . $i . ')');
$ws->setCellValue([2, $i], $speler);
$ws->setCellValue([3, $i], '=COUNTIFS(Partijen!$I$3:$I$' . $maxLijn . ',$B' . $i . ',Partijen!$J$3:$J$' . $maxLijn . ',"<>")+COUNTIFS(Partijen!$K$3:$K$' . $maxLijn . ',Spelers!$B' . $i . ',Partijen!$J$3:$J$' . $maxLijn . ',"<>")'); // - SUM(H' . $i . ':I' . $i . ')
$ws->setCellValue([4, $i], '=SUMIFS(Partijen!C$3:C$' . $maxLijn . ',Partijen!$I$3:$I$' . $maxLijn . ',$B' . $i . ')+SUMIFS(Partijen!G$3:G$' . $maxLijn . ',Partijen!$K$3:$K$' . $maxLijn . ',$B' . $i . ')');
$ws->setCellValue([5, $i], '=SUMIFS(Partijen!D$3:D$' . $maxLijn . ',Partijen!$I$3:$I$' . $maxLijn . ',$B' . $i . ')+SUMIFS(Partijen!H$3:H$' . $maxLijn . ',Partijen!$K$3:$K$' . $maxLijn . ',$B' . $i . ')');
$ws->setCellValue([6, $i], '=SUMIFS(Partijen!A$3:A$' . $maxLijn . ',Partijen!$I$3:$I$' . $maxLijn . ',$B' . $i . ')+SUMIFS(Partijen!E$3:E$' . $maxLijn . ',Partijen!$K$3:$K$' . $maxLijn . ',$B' . $i . ')');
$ws->setCellValue([7, $i], '=SUMIFS(Partijen!B$3:B$' . $maxLijn . ',Partijen!$I$3:$I$' . $maxLijn . ',$B' . $i . ')+SUMIFS(Partijen!F$3:F$' . $maxLijn . ',Partijen!$K$3:$K$' . $maxLijn . ',$B' . $i . ')');
$ws->setCellValue([8, $i], '=C' . $i . '*MAX(Punten!$B$2:$B$50)-D' . $i . '');
}
$ws->setSelectedCell('A1');
}
private function doSort1(Worksheet $ws): void
{
$ws->setCellValue('A2', '=FILTER(SORTBY(Spelers!A2:H101,Spelers!D2:D101,-1,Spelers!E2:E101,1),(Spelers!B2:B101<>"Bye")*(NOT(ISBLANK(Spelers!B2:B101))))');
$this->doKoppen($ws);
$ws->setSelectedCell('A1');
}
private function doSort2(Worksheet $ws): void
{
$ws->setCellValue('A2', '=SORT(FILTER(Spelers!A2:H101,(Spelers!B2:B101<>"Bye") * (NOT(ISBLANK(Spelers!B2:B101)))),7,1,FALSE)');
$this->doKoppen($ws);
$ws->setSelectedCell('A1');
}
private function doKoppen(Worksheet $ws): void
{
$ws->setCellValue('A1', 'Plaats');
$ws->setCellValue('B1', 'Naam');
$ws->setCellValue('C1', 'Partijen');
$ws->setCellValue('D1', 'Punten');
$ws->setCellValue('E1', 'Tegenpunten');
$ws->setCellValue('F1', 'Winstpunten');
$ws->setCellValue('G1', 'Weerstandspunten');
$ws->setCellValue('H1', 'Verlorenpunten');
for ($i = 65; $i < ord('I'); ++$i) {
$ws->getColumnDimension(chr($i))->setAutoSize(true);
}
$ws->getStyle('A1:H1')->applyFromArray(self::STYLEBOLD);
}
public function testManyArraysOutput(): void
{
Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_ARRAY);
$json = file_get_contents('tests/data/Writer/Xlsx/ArrayFunctions2.json');
self::assertNotFalse($json);
$this->trn = json_decode($json, true);
$spreadsheet = new Spreadsheet();
$wsPartijen = $spreadsheet->getActiveSheet();
$wsPartijen->setTitle('Partijen');
$wsPunten = new Worksheet($spreadsheet, 'Punten');
$wsSpelers = new Worksheet($spreadsheet, 'Spelers');
$wsSort1 = new Worksheet($spreadsheet, 'Gesorteerd punten');
$wsSort2 = new Worksheet($spreadsheet, 'Gesorteerd verlorenpunten');
$wsPartijen->getTabColor()->setRGB('FF0000');
$wsPunten->getTabColor()->setRGB('00FF00');
$wsSpelers->getTabColor()->setRGB('0000FF');
$wsSort1->getTabColor()->setRGB('FFFF00');
$wsSort2->getTabColor()->setRGB('00FFFF');
foreach ([$wsPunten, $wsSpelers, $wsSort1, $wsSort2] as $ws) {
$spreadsheet->addSheet($ws);
}
$this->doPunten($spreadsheet, $wsPunten);
$maxLijn = $this->doPartijen($wsPartijen);
$this->doSpelers($wsSpelers, $maxLijn);
$this->doSort1($wsSort1);
$this->doSort2($wsSort2);
self::assertSame('Dirk', $wsPartijen->getCell('I3')->getCalculatedValue());
self::assertSame('Rudy', $wsPartijen->getCell('K4')->getCalculatedValue());
$calcArray = $wsSort2->getCell('A2')->getCalculatedValue();
$spreadsheet->disconnectWorksheets();
}
}
tests/PhpSpreadsheetTests/Writer/Xlsx/ArrayFunctionsTest.php
+61 -15
View File
@@ -69,24 +69,27 @@ class ArrayFunctionsTest extends TestCase
$spreadsheet2 = $reader->load($this->outputFile);
$sheet2 = $spreadsheet2->getActiveSheet();
$expectedUnique = [
['41'],
['57'],
['51'],
['54'],
['49'],
['43'],
['35'],
['44'],
['47'],
['48'],
['26'],
['34'],
['61'],
['28'],
['29'],
[41],
[57],
[51],
[54],
[49],
[43],
[35],
[44],
[47],
[48],
[26],
[34],
[61],
[28],
[29],
];
self::assertCount(15, $expectedUnique);
self::assertSame($expectedUnique, $sheet2->getCell('C1')->getCalculatedValue());
for ($row = 2; $row <= 15; ++$row) {
self::assertSame($expectedUnique[$row - 1][0], $sheet2->getCell("C$row")->getCalculatedValue(), "cell C$row");
}
$expectedSort = [
[26],
[28],
@@ -160,4 +163,47 @@ class ArrayFunctionsTest extends TestCase
self::assertStringContainsString('<f t="array" ref="F1:G5" aca="1" ca="1">_xlfn.CHOOSECOLS(A1:C5,3,1)</f><v>11</v>', $data);
}
}
public function testArrayMultipleColumns(): void
{
Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_ARRAY);
$spreadsheet = new Spreadsheet();
$sheet = $spreadsheet->getActiveSheet();
$columnArray = [
[100, 91],
[85, 1],
[100, 92],
[734, 12],
[100, 91],
[5,2],
];
$sheet->fromArray($columnArray);
$sheet->setCellValue('H1', '=UNIQUE(A1:B6)');
$writer = new XlsxWriter($spreadsheet);
$this->outputFile = File::temporaryFilename();
$writer->save($this->outputFile);
$spreadsheet->disconnectWorksheets();
$reader = new XlsxReader();
$spreadsheet2 = $reader->load($this->outputFile);
$sheet2 = $spreadsheet2->getActiveSheet();
$expectedUnique = [
[100, 91],
[85, 1],
[100, 92],
[734, 12],
//[100, 91], // not unique
[5,2],
];
self::assertCount(5, $expectedUnique);
self::assertSame($expectedUnique, $sheet2->getCell('H1')->getCalculatedValue());
for ($row = 1; $row <= 5; ++$row) {
if ($row > 1) {
self::assertSame($expectedUnique[$row - 1][0], $sheet2->getCell("H$row")->getCalculatedValue(), "cell H$row");
}
self::assertSame($expectedUnique[$row - 1][1], $sheet2->getCell("I$row")->getCalculatedValue(), "cell I$row");
}
$spreadsheet2->disconnectWorksheets();
}
}
tests/data/Writer/XLSX/ArrayFunctions2.json
+1
View File
File diff suppressed because one or more lines are too long