mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-09-13 03:26:26 +00:00
ad2194d737
The CONCATENATE function has been treated as equivalent to CONCAT. This is not how it is treated in Excel; it is closer to (and probably identical to) the ampersand concatenate operator. The difference manifests itself when any of the arguments is an array (typically a cell range). Code is added to support this difference. Support for array results is added to Csv Writer, Html Writer, and Ods Reader and Writer. I have not figured out how to get it to work with Xls.
356 lines
11 KiB
PHP
356 lines
11 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpOffice\PhpSpreadsheetTests\Writer\Xlsx;
|
|
|
|
use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
|
|
use PhpOffice\PhpSpreadsheet\Reader\Xlsx as XlsxReader;
|
|
use PhpOffice\PhpSpreadsheet\Shared\File;
|
|
use PhpOffice\PhpSpreadsheet\Spreadsheet;
|
|
use PhpOffice\PhpSpreadsheet\Writer\Xlsx as XlsxWriter;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class ArrayFunctionsTest extends TestCase
|
|
{
|
|
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 = '';
|
|
}
|
|
}
|
|
|
|
public function testArrayOutput(): void
|
|
{
|
|
Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_ARRAY);
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$columnArray = [
|
|
[41],
|
|
[57],
|
|
[51],
|
|
[54],
|
|
[49],
|
|
[43],
|
|
[35],
|
|
[35],
|
|
[44],
|
|
[47],
|
|
[48],
|
|
[26],
|
|
[57],
|
|
[34],
|
|
[61],
|
|
[34],
|
|
[28],
|
|
[29],
|
|
[41],
|
|
];
|
|
$sheet->fromArray($columnArray, 'A1');
|
|
$sheet->setCellValue('C1', '=UNIQUE(A1:A19)');
|
|
$sheet->setCellValue('D1', '=SORT(A1:A19)');
|
|
$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 = [
|
|
[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],
|
|
[29],
|
|
[34],
|
|
[34],
|
|
[35],
|
|
[35],
|
|
[41],
|
|
[41],
|
|
[43],
|
|
[44],
|
|
[47],
|
|
[48],
|
|
[49],
|
|
[51],
|
|
[54],
|
|
[57],
|
|
[57],
|
|
[61],
|
|
];
|
|
self::assertCount(19, $expectedSort);
|
|
self::assertCount(19, $columnArray);
|
|
self::assertSame($expectedSort, $sheet2->getCell('D1')->getCalculatedValue());
|
|
$spreadsheet2->disconnectWorksheets();
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#xl/worksheets/sheet1.xml';
|
|
$data = file_get_contents($file);
|
|
if ($data === false) {
|
|
self::fail('Unable to read file');
|
|
} else {
|
|
self::assertStringContainsString('<c r="C1" cm="1"><f t="array" ref="C1:C15" aca="1" ca="1">_xlfn.UNIQUE(A1:A19)</f><v>41</v></c>', $data, '15 results for UNIQUE');
|
|
self::assertStringContainsString('<c r="D1" cm="1"><f t="array" ref="D1:D19" aca="1" ca="1">_xlfn._xlws.SORT(A1:A19)</f><v>26</v></c>', $data, '19 results for SORT');
|
|
}
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#xl/metadata.xml';
|
|
$data = @file_get_contents($file);
|
|
self::assertNotFalse($data, 'metadata.xml should exist');
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#[Content_Types].xml';
|
|
$data = file_get_contents($file);
|
|
self::assertStringContainsString('metadata', $data);
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#xl/_rels/workbook.xml.rels';
|
|
$data = file_get_contents($file);
|
|
self::assertStringContainsString('metadata', $data);
|
|
}
|
|
|
|
public function testArrayOutputCSE(): void
|
|
{
|
|
Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_ARRAY);
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$columnArray = [
|
|
[41],
|
|
[57],
|
|
[51],
|
|
[54],
|
|
[49],
|
|
[43],
|
|
[35],
|
|
[35],
|
|
[44],
|
|
[47],
|
|
[48],
|
|
[26],
|
|
[57],
|
|
[34],
|
|
[61],
|
|
[34],
|
|
[28],
|
|
[29],
|
|
[41],
|
|
];
|
|
$sheet->fromArray($columnArray, 'A1');
|
|
$sheet->setCellValue('C1', '=UNIQUE(A1:A19)');
|
|
$sheet->setCellValue('D1', '=SORT(A1:A19)');
|
|
$writer = new XlsxWriter($spreadsheet);
|
|
$this->outputFile = File::temporaryFilename();
|
|
$writer->setUseCSEArrays(true);
|
|
$writer->save($this->outputFile);
|
|
$spreadsheet->disconnectWorksheets();
|
|
|
|
$reader = new XlsxReader();
|
|
$spreadsheet2 = $reader->load($this->outputFile);
|
|
$sheet2 = $spreadsheet2->getActiveSheet();
|
|
$expectedUnique = [
|
|
[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],
|
|
[29],
|
|
[34],
|
|
[34],
|
|
[35],
|
|
[35],
|
|
[41],
|
|
[41],
|
|
[43],
|
|
[44],
|
|
[47],
|
|
[48],
|
|
[49],
|
|
[51],
|
|
[54],
|
|
[57],
|
|
[57],
|
|
[61],
|
|
];
|
|
self::assertCount(19, $expectedSort);
|
|
self::assertCount(19, $columnArray);
|
|
self::assertSame($expectedSort, $sheet2->getCell('D1')->getCalculatedValue());
|
|
$spreadsheet2->disconnectWorksheets();
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#xl/worksheets/sheet1.xml';
|
|
$data = file_get_contents($file);
|
|
if ($data === false) {
|
|
self::fail('Unable to read file');
|
|
} else {
|
|
self::assertStringContainsString('<c r="C1"><f t="array" ref="C1:C15" aca="1" ca="1">_xlfn.UNIQUE(A1:A19)</f><v>41</v></c>', $data, '15 results for UNIQUE');
|
|
self::assertStringContainsString('<c r="D1"><f t="array" ref="D1:D19" aca="1" ca="1">_xlfn._xlws.SORT(A1:A19)</f><v>26</v></c>', $data, '19 results for SORT');
|
|
}
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#xl/metadata.xml';
|
|
$data = @file_get_contents($file);
|
|
self::assertFalse($data, 'metadata.xml should not exist');
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#[Content_Types].xml';
|
|
$data = file_get_contents($file);
|
|
self::assertStringNotContainsString('metadata', $data);
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#xl/_rels/workbook.xml.rels';
|
|
$data = file_get_contents($file);
|
|
self::assertStringNotContainsString('metadata', $data);
|
|
}
|
|
|
|
public function testUnimplementedArrayOutput(): void
|
|
{
|
|
//Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_ARRAY); // not required for this test
|
|
$reader = new XlsxReader();
|
|
$spreadsheet = $reader->load('tests/data/Reader/XLSX/atsign.choosecols.xlsx');
|
|
$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();
|
|
self::assertSame('=CHOOSECOLS(A1:C5,3,1)', $sheet2->getCell('F1')->getValue());
|
|
$expectedFG = [
|
|
['11', '1'],
|
|
['12', '2'],
|
|
['13', '3'],
|
|
['14', '4'],
|
|
['15', '5'],
|
|
];
|
|
$actualFG = $sheet2->rangeToArray('F1:G5');
|
|
self::assertSame($expectedFG, $actualFG);
|
|
$spreadsheet2->disconnectWorksheets();
|
|
|
|
$file = 'zip://';
|
|
$file .= $this->outputFile;
|
|
$file .= '#xl/worksheets/sheet1.xml';
|
|
$data = file_get_contents($file);
|
|
if ($data === false) {
|
|
self::fail('Unable to read file');
|
|
} else {
|
|
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();
|
|
}
|
|
|
|
public function testMetadataWritten(): void
|
|
{
|
|
Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_ARRAY);
|
|
$spreadsheet = new Spreadsheet();
|
|
$writer = new XlsxWriter($spreadsheet);
|
|
$writerMetadata = new XlsxWriter\Metadata($writer);
|
|
self::assertNotEquals('', $writerMetadata->writeMetaData());
|
|
$writer->setUseCSEArrays(true);
|
|
$writerMetadata2 = new XlsxWriter\Metadata($writer);
|
|
self::assertSame('', $writerMetadata2->writeMetaData());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
}
|