mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-08-24 20:38:20 +00:00
c1968e57b2
* Correct Re-computation of Relative Addresses in Defined Names Fix #3661. Insertion or deletion of rows or columns can cause changes to the ranges for Defined Names. In fact, only the absolute parts of such ranges should be adjusted, while the relative parts should be left alone. Otherwise, as the original issue documents, the adjustment to the relative portion winds up being double-counted when the Defined Name is referenced in a formula. The major part of this change is to ReferenceHelper and CellReferenceHelper to not adjust relative addresses for Defined Names. An additional small change is needed in the Calculation engine to `recursiveCalculationCell` when a Defined Formula is being calculated. In a sense, this is a breaking change, but for an obscure use case which (a) was wrong, and (b) is unlikely to be of importance. Some of the tests in ReferenceHelperTest were wrong and are now corrected, with the results being cross-checked against Excel. When a Defined Name using relative addressing is defined in Excel, the result is treated as relative to the active cell on the sheet in which the name is defined. PhpSpreadsheet treats it as relative to cell A1. I think that is a reasonable treatment, and will not change its behavior to match Excel's - that would definitely be a breaking change of some consequence. An interesting use of relative address in a defined name is demonstrated at https://excelguru.ca/always-refer-to-the-cell-above/. Note that the steps there involve setting the selected cell to A2 before defining the name. When that spreadsheet is stored, the actual definition of the range is `A1048576`. Likewise, adding a defined name for the cell to the left would be stored as `XFD1`. This seems a little fragile, but Ods, which I believe does not have the same row and column limits as Excel, certainly treats these values the same as Excel. This particular construction is formally unit-tested. Note, however, that although using these Defined Names as a formula on their own works just fine, a construction like `=SUM(A1:CellAbove)`, as suggested in the article, seems to put PhpSpreadsheet calculation engine in a loop. In the likely event that I can't solve that before I merge this change, I will open a new issue to that effect when I do merge it. Note that this can be handled without defined names as `=SUM(A$1:INDIRECT(ADDRESS(ROW()-1,COLUMN())))`. PhpSpreadsheet will handle this as a cell formula, but not yet as a Named Formula. The tests show a breakdown evaluating `=ProductTotal` (product of 2 formulas using defined names with relative addresses) on the sheet on which it is defined, but it works from a different sheet. The usual debugging techniques show me why this is happening, but I can't see how to overcome it. As above, if I can't solve it before I merge, I will open a new issue. For those situations where I intend to open a new issue, tests are added but are marked Incomplete. Because of those, I will leave this PR in draft status for 2 weeks before moving forward with it. * Fix productTotal Problem Need to restore current cell after evaluating defined name.
756 lines
29 KiB
PHP
756 lines
29 KiB
PHP
<?php
|
|
|
|
namespace PhpOffice\PhpSpreadsheetTests;
|
|
|
|
use PhpOffice\PhpSpreadsheet\Cell\DataType;
|
|
use PhpOffice\PhpSpreadsheet\Cell\Hyperlink;
|
|
use PhpOffice\PhpSpreadsheet\Comment;
|
|
use PhpOffice\PhpSpreadsheet\NamedFormula;
|
|
use PhpOffice\PhpSpreadsheet\NamedRange;
|
|
use PhpOffice\PhpSpreadsheet\ReferenceHelper;
|
|
use PhpOffice\PhpSpreadsheet\Spreadsheet;
|
|
use PhpOffice\PhpSpreadsheet\Style\ConditionalFormatting\Wizard;
|
|
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class ReferenceHelperTest extends TestCase
|
|
{
|
|
public function testColumnSort(): void
|
|
{
|
|
$columnBase = $columnExpectedResult = [
|
|
'A', 'B', 'Z',
|
|
'AA', 'AB', 'AZ',
|
|
'BA', 'BB', 'BZ',
|
|
'ZA', 'ZB', 'ZZ',
|
|
'AAA', 'AAB', 'AAZ',
|
|
'ABA', 'ABB', 'ABZ',
|
|
'AZA', 'AZB', 'AZZ',
|
|
'BAA', 'BAB', 'BAZ',
|
|
'BBA', 'BBB', 'BBZ',
|
|
'BZA', 'BZB', 'BZZ',
|
|
];
|
|
shuffle($columnBase);
|
|
usort($columnBase, [ReferenceHelper::class, 'columnSort']);
|
|
foreach ($columnBase as $key => $value) {
|
|
self::assertEquals($columnExpectedResult[$key], $value);
|
|
}
|
|
}
|
|
|
|
public function testColumnReverseSort(): void
|
|
{
|
|
$columnBase = $columnExpectedResult = [
|
|
'A', 'B', 'Z',
|
|
'AA', 'AB', 'AZ',
|
|
'BA', 'BB', 'BZ',
|
|
'ZA', 'ZB', 'ZZ',
|
|
'AAA', 'AAB', 'AAZ',
|
|
'ABA', 'ABB', 'ABZ',
|
|
'AZA', 'AZB', 'AZZ',
|
|
'BAA', 'BAB', 'BAZ',
|
|
'BBA', 'BBB', 'BBZ',
|
|
'BZA', 'BZB', 'BZZ',
|
|
];
|
|
shuffle($columnBase);
|
|
$columnExpectedResult = array_reverse($columnExpectedResult);
|
|
usort($columnBase, [ReferenceHelper::class, 'columnReverseSort']);
|
|
foreach ($columnBase as $key => $value) {
|
|
self::assertEquals($columnExpectedResult[$key], $value);
|
|
}
|
|
}
|
|
|
|
public function testCellSort(): void
|
|
{
|
|
$cellBase = $columnExpectedResult = [
|
|
'A1', 'B1', 'AZB1',
|
|
'BBB1', 'BB2', 'BAB2',
|
|
'BZA2', 'Z3', 'AZA3',
|
|
'BZB3', 'AB5', 'AZ6',
|
|
'ABZ7', 'BA9', 'BZ9',
|
|
'AAA9', 'AAZ9', 'BA10',
|
|
'BZZ10', 'ZA11', 'AAB11',
|
|
'BBZ29', 'BAA32', 'ZZ43',
|
|
'AZZ43', 'BAZ67', 'ZB78',
|
|
'ABA121', 'ABB289', 'BBA544',
|
|
];
|
|
shuffle($cellBase);
|
|
usort($cellBase, [ReferenceHelper::class, 'cellSort']);
|
|
foreach ($cellBase as $key => $value) {
|
|
self::assertEquals($columnExpectedResult[$key], $value);
|
|
}
|
|
}
|
|
|
|
public function testCellReverseSort(): void
|
|
{
|
|
$cellBase = $columnExpectedResult = [
|
|
'BBA544', 'ABB289', 'ABA121',
|
|
'ZB78', 'BAZ67', 'AZZ43',
|
|
'ZZ43', 'BAA32', 'BBZ29',
|
|
'AAB11', 'ZA11', 'BZZ10',
|
|
'BA10', 'AAZ9', 'AAA9',
|
|
'BZ9', 'BA9', 'ABZ7',
|
|
'AZ6', 'AB5', 'BZB3',
|
|
'AZA3', 'Z3', 'BZA2',
|
|
'BAB2', 'BB2', 'BBB1',
|
|
'AZB1', 'B1', 'A1',
|
|
];
|
|
shuffle($cellBase);
|
|
usort($cellBase, [ReferenceHelper::class, 'cellReverseSort']);
|
|
foreach ($cellBase as $key => $value) {
|
|
self::assertEquals($columnExpectedResult[$key], $value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerFormulaUpdates
|
|
*/
|
|
public function testUpdateFormula(string $formula, int $insertRows, int $insertColumns, string $worksheet, string $expectedResult): void
|
|
{
|
|
$referenceHelper = ReferenceHelper::getInstance();
|
|
|
|
$result = $referenceHelper->updateFormulaReferences($formula, 'A1', $insertRows, $insertColumns, $worksheet);
|
|
|
|
self::assertSame($expectedResult, $result);
|
|
}
|
|
|
|
public static function providerFormulaUpdates(): array
|
|
{
|
|
return require 'tests/data/ReferenceHelperFormulaUpdates.php';
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerMultipleWorksheetFormulaUpdates
|
|
*/
|
|
public function testUpdateFormulaForMultipleWorksheets(string $formula, int $insertRows, int $insertColumns, string $expectedResult): void
|
|
{
|
|
$referenceHelper = ReferenceHelper::getInstance();
|
|
|
|
$result = $referenceHelper->updateFormulaReferencesAnyWorksheet($formula, $insertRows, $insertColumns);
|
|
|
|
self::assertSame($expectedResult, $result);
|
|
}
|
|
|
|
public static function providerMultipleWorksheetFormulaUpdates(): array
|
|
{
|
|
return require 'tests/data/ReferenceHelperFormulaUpdatesMultipleSheet.php';
|
|
}
|
|
|
|
public function testInsertNewBeforeRetainDataType(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$cell = $sheet->getCell('A1');
|
|
$cell->setValueExplicit('+1', DataType::TYPE_STRING);
|
|
$oldDataType = $cell->getDataType();
|
|
$oldValue = $cell->getValue();
|
|
|
|
$sheet->insertNewRowBefore(1);
|
|
$newCell = $sheet->getCell('A2');
|
|
$newDataType = $newCell->getDataType();
|
|
$newValue = $newCell->getValue();
|
|
|
|
self::assertSame($oldValue, $newValue);
|
|
self::assertSame($oldDataType, $newDataType);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testRemoveColumnShiftsCorrectColumnValueIntoRemovedColumnCoordinates(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([
|
|
['a1', 'b1', 'c1'],
|
|
['a2', 'b2', null],
|
|
]);
|
|
|
|
$cells = $sheet->toArray();
|
|
self::assertSame('a1', $cells[0][0]);
|
|
self::assertSame('b1', $cells[0][1]);
|
|
self::assertSame('c1', $cells[0][2]);
|
|
self::assertSame('a2', $cells[1][0]);
|
|
self::assertSame('b2', $cells[1][1]);
|
|
self::assertNull($cells[1][2]);
|
|
|
|
$sheet->removeColumn('B');
|
|
|
|
$cells = $sheet->toArray();
|
|
self::assertSame('a1', $cells[0][0]);
|
|
self::assertSame('c1', $cells[0][1]);
|
|
self::assertArrayNotHasKey(2, $cells[0]);
|
|
self::assertSame('a2', $cells[1][0]);
|
|
self::assertNull($cells[1][1]);
|
|
self::assertArrayNotHasKey(2, $cells[1]);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertRowsWithPageBreaks(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2], [3, 4], [5, 6], [7, 8], [9, 10]], null, 'A1', true);
|
|
$sheet->setBreak('A2', Worksheet::BREAK_ROW);
|
|
$sheet->setBreak('A5', Worksheet::BREAK_ROW);
|
|
|
|
$sheet->insertNewRowBefore(2, 2);
|
|
|
|
$breaks = $sheet->getBreaks();
|
|
ksort($breaks);
|
|
self::assertSame(['A4' => Worksheet::BREAK_ROW, 'A7' => Worksheet::BREAK_ROW], $breaks);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteRowsWithPageBreaks(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2], [3, 4], [5, 6], [7, 8], [9, 10]], null, 'A1', true);
|
|
$sheet->setBreak('A2', Worksheet::BREAK_ROW);
|
|
$sheet->setBreak('A5', Worksheet::BREAK_ROW);
|
|
|
|
$sheet->removeRow(2, 2);
|
|
|
|
$breaks = $sheet->getBreaks();
|
|
self::assertSame(['A3' => Worksheet::BREAK_ROW], $breaks);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertRowsWithComments(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2], [3, 4], [5, 6], [7, 8], [9, 10]], null, 'A1', true);
|
|
$sheet->getComment('A2')->getText()->createText('First Comment');
|
|
$sheet->getComment('A5')->getText()->createText('Second Comment');
|
|
|
|
$sheet->insertNewRowBefore(2, 2);
|
|
|
|
$comments = array_map(
|
|
function (Comment $value) {
|
|
return $value->getText()->getPlainText();
|
|
},
|
|
$sheet->getComments()
|
|
);
|
|
|
|
self::assertSame(['A4' => 'First Comment', 'A7' => 'Second Comment'], $comments);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteRowsWithComments(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2], [3, 4], [5, 6], [7, 8], [9, 10]], null, 'A1', true);
|
|
$sheet->getComment('A2')->getText()->createText('First Comment');
|
|
$sheet->getComment('A5')->getText()->createText('Second Comment');
|
|
|
|
$sheet->removeRow(2, 2);
|
|
|
|
$comments = array_map(
|
|
function (Comment $value) {
|
|
return $value->getText()->getPlainText();
|
|
},
|
|
$sheet->getComments()
|
|
);
|
|
|
|
self::assertSame(['A3' => 'Second Comment'], $comments);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertRowsWithHyperlinks(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2], [3, 4], [5, 6], [7, 8], [9, 10]], null, 'A1', true);
|
|
$sheet->getCell('A2')->getHyperlink()->setUrl('https://github.com/PHPOffice/PhpSpreadsheet');
|
|
$sheet->getCell('A5')->getHyperlink()->setUrl('https://phpspreadsheet.readthedocs.io/en/latest/');
|
|
|
|
$sheet->insertNewRowBefore(2, 2);
|
|
|
|
$hyperlinks = array_map(
|
|
function (Hyperlink $value) {
|
|
return $value->getUrl();
|
|
},
|
|
$sheet->getHyperlinkCollection()
|
|
);
|
|
ksort($hyperlinks);
|
|
|
|
self::assertSame(
|
|
[
|
|
'A4' => 'https://github.com/PHPOffice/PhpSpreadsheet',
|
|
'A7' => 'https://phpspreadsheet.readthedocs.io/en/latest/',
|
|
],
|
|
$hyperlinks
|
|
);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteRowsWithHyperlinks(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2], [3, 4], [5, 6], [7, 8], [9, 10]], null, 'A1', true);
|
|
$sheet->getCell('A2')->getHyperlink()->setUrl('https://github.com/PHPOffice/PhpSpreadsheet');
|
|
$sheet->getCell('A5')->getHyperlink()->setUrl('https://phpspreadsheet.readthedocs.io/en/latest/');
|
|
|
|
$sheet->removeRow(2, 2);
|
|
|
|
$hyperlinks = array_map(
|
|
function (Hyperlink $value) {
|
|
return $value->getUrl();
|
|
},
|
|
$sheet->getHyperlinkCollection()
|
|
);
|
|
|
|
self::assertSame(['A3' => 'https://phpspreadsheet.readthedocs.io/en/latest/'], $hyperlinks);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertRowsWithDataValidation(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
|
|
$sheet->fromArray([['First'], ['Second'], ['Third'], ['Fourth']], null, 'A5', true);
|
|
$cellAddress = 'E5';
|
|
$this->setDataValidation($sheet, $cellAddress);
|
|
|
|
$sheet->insertNewRowBefore(2, 2);
|
|
|
|
self::assertFalse($sheet->getCell($cellAddress)->hasDataValidation());
|
|
self::assertTrue($sheet->getCell('E7')->hasDataValidation());
|
|
self::assertSame('E7', $sheet->getDataValidation('E7')->getSqref());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteRowsWithDataValidation(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
|
|
$sheet->fromArray([['First'], ['Second'], ['Third'], ['Fourth']], null, 'A5', true);
|
|
$cellAddress = 'E5';
|
|
$this->setDataValidation($sheet, $cellAddress);
|
|
|
|
$sheet->removeRow(2, 2);
|
|
|
|
self::assertFalse($sheet->getCell($cellAddress)->hasDataValidation());
|
|
self::assertTrue($sheet->getCell('E3')->hasDataValidation());
|
|
self::assertSame('E3', $sheet->getDataValidation('E3')->getSqref());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteColumnsWithDataValidation(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
|
|
$sheet->fromArray([['First'], ['Second'], ['Third'], ['Fourth']], null, 'A5', true);
|
|
$cellAddress = 'E5';
|
|
$this->setDataValidation($sheet, $cellAddress);
|
|
|
|
$sheet->removeColumn('B', 2);
|
|
|
|
self::assertFalse($sheet->getCell($cellAddress)->hasDataValidation());
|
|
self::assertTrue($sheet->getCell('C5')->hasDataValidation());
|
|
self::assertSame('C5', $sheet->getDataValidation('C5')->getSqref());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertColumnsWithDataValidation(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
|
|
$sheet->fromArray([['First'], ['Second'], ['Third'], ['Fourth']], null, 'A5', true);
|
|
$cellAddress = 'E5';
|
|
$this->setDataValidation($sheet, $cellAddress);
|
|
|
|
$sheet->insertNewColumnBefore('C', 2);
|
|
|
|
self::assertFalse($sheet->getCell($cellAddress)->hasDataValidation());
|
|
self::assertTrue($sheet->getCell('G5')->hasDataValidation());
|
|
self::assertSame('G5', $sheet->getDataValidation('G5')->getSqref());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
private function setDataValidation(Worksheet $sheet, string $cellAddress): void
|
|
{
|
|
$validation = $sheet->getCell($cellAddress)
|
|
->getDataValidation();
|
|
$validation->setType(\PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_LIST);
|
|
$validation->setErrorStyle(\PhpOffice\PhpSpreadsheet\Cell\DataValidation::STYLE_INFORMATION);
|
|
$validation->setAllowBlank(false);
|
|
$validation->setShowInputMessage(true);
|
|
$validation->setShowErrorMessage(true);
|
|
$validation->setShowDropDown(true);
|
|
$validation->setErrorTitle('Input error');
|
|
$validation->setError('Value is not in list.');
|
|
$validation->setPromptTitle('Pick from list');
|
|
$validation->setPrompt('Please pick a value from the drop-down list.');
|
|
$validation->setFormula1('$A5:$A8');
|
|
}
|
|
|
|
public function testInsertRowsWithConditionalFormatting(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2, 3, 4], [3, 4, 5, 6], [5, 6, 7, 8], [7, 8, 9, 10], [9, 10, 11, 12]], null, 'C3', true);
|
|
$sheet->getCell('H5')->setValue(5);
|
|
|
|
$cellRange = 'C3:F7';
|
|
$this->setConditionalFormatting($sheet, $cellRange);
|
|
|
|
$sheet->insertNewRowBefore(4, 2);
|
|
|
|
$styles = $sheet->getConditionalStylesCollection();
|
|
// verify that the conditional range has been updated
|
|
self::assertSame('C3:F9', array_keys($styles)[0]);
|
|
// verify that the conditions have been updated
|
|
foreach ($styles as $style) {
|
|
foreach ($style as $conditions) {
|
|
self::assertSame('$H$7', $conditions->getConditions()[0]);
|
|
}
|
|
}
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertColumnssWithConditionalFormatting(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2, 3, 4], [3, 4, 5, 6], [5, 6, 7, 8], [7, 8, 9, 10], [9, 10, 11, 12]], null, 'C3', true);
|
|
$sheet->getCell('H5')->setValue(5);
|
|
|
|
$cellRange = 'C3:F7';
|
|
$this->setConditionalFormatting($sheet, $cellRange);
|
|
|
|
$sheet->insertNewColumnBefore('C', 2);
|
|
|
|
$styles = $sheet->getConditionalStylesCollection();
|
|
// verify that the conditional range has been updated
|
|
self::assertSame('E3:H7', array_keys($styles)[0]);
|
|
// verify that the conditions have been updated
|
|
foreach ($styles as $style) {
|
|
foreach ($style as $conditions) {
|
|
self::assertSame('$J$5', $conditions->getConditions()[0]);
|
|
}
|
|
}
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteRowsWithConditionalFormatting(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2, 3, 4], [3, 4, 5, 6], [5, 6, 7, 8], [7, 8, 9, 10], [9, 10, 11, 12]], null, 'C3', true);
|
|
$sheet->getCell('H5')->setValue(5);
|
|
|
|
$cellRange = 'C3:F7';
|
|
$this->setConditionalFormatting($sheet, $cellRange);
|
|
|
|
$sheet->removeRow(4, 2);
|
|
|
|
$styles = $sheet->getConditionalStylesCollection();
|
|
// verify that the conditional range has been updated
|
|
self::assertSame('C3:F5', array_keys($styles)[0]);
|
|
// verify that the conditions have been updated
|
|
foreach ($styles as $style) {
|
|
foreach ($style as $conditions) {
|
|
self::assertSame('$H$5', $conditions->getConditions()[0]);
|
|
}
|
|
}
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteColumnsWithConditionalFormatting(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->fromArray([[1, 2, 3, 4], [3, 4, 5, 6], [5, 6, 7, 8], [7, 8, 9, 10], [9, 10, 11, 12]], null, 'C3', true);
|
|
$sheet->getCell('H5')->setValue(5);
|
|
|
|
$cellRange = 'C3:F7';
|
|
$this->setConditionalFormatting($sheet, $cellRange);
|
|
|
|
$sheet->removeColumn('D', 2);
|
|
|
|
$styles = $sheet->getConditionalStylesCollection();
|
|
// verify that the conditional range has been updated
|
|
self::assertSame('C3:D7', array_keys($styles)[0]);
|
|
// verify that the conditions have been updated
|
|
foreach ($styles as $style) {
|
|
foreach ($style as $conditions) {
|
|
self::assertSame('$F$5', $conditions->getConditions()[0]);
|
|
}
|
|
}
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
private function setConditionalFormatting(Worksheet $sheet, string $cellRange): void
|
|
{
|
|
$conditionalStyles = [];
|
|
$wizardFactory = new Wizard($cellRange);
|
|
/** @var Wizard\CellValue $cellWizard */
|
|
$cellWizard = $wizardFactory->newRule(Wizard::CELL_VALUE);
|
|
|
|
$cellWizard->equals('$H$5', Wizard::VALUE_TYPE_CELL);
|
|
$conditionalStyles[] = $cellWizard->getConditional();
|
|
|
|
$cellWizard->greaterThan('$H$5', Wizard::VALUE_TYPE_CELL);
|
|
$conditionalStyles[] = $cellWizard->getConditional();
|
|
|
|
$cellWizard->lessThan('$H$5', Wizard::VALUE_TYPE_CELL);
|
|
$conditionalStyles[] = $cellWizard->getConditional();
|
|
|
|
$sheet->getStyle($cellWizard->getCellRange())
|
|
->setConditionalStyles($conditionalStyles);
|
|
}
|
|
|
|
public function testInsertRowsWithPrintArea(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->getPageSetup()->setPrintArea('A1:J10');
|
|
|
|
$sheet->insertNewRowBefore(2, 2);
|
|
|
|
$printArea = $sheet->getPageSetup()->getPrintArea();
|
|
self::assertSame('A1:J12', $printArea);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertColumnsWithPrintArea(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->getPageSetup()->setPrintArea('A1:J10');
|
|
|
|
$sheet->insertNewColumnBefore('B', 2);
|
|
|
|
$printArea = $sheet->getPageSetup()->getPrintArea();
|
|
self::assertSame('A1:L10', $printArea);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteRowsWithPrintArea(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->getPageSetup()->setPrintArea('A1:J10');
|
|
|
|
$sheet->removeRow(2, 2);
|
|
|
|
$printArea = $sheet->getPageSetup()->getPrintArea();
|
|
self::assertSame('A1:J8', $printArea);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDeleteColumnsWithPrintArea(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->getPageSetup()->setPrintArea('A1:J10');
|
|
|
|
$sheet->removeColumn('B', 2);
|
|
|
|
$printArea = $sheet->getPageSetup()->getPrintArea();
|
|
self::assertSame('A1:H10', $printArea);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertDeleteRowsWithDefinedNames(): void
|
|
{
|
|
$spreadsheet = $this->buildDefinedNamesTestWorkbook();
|
|
/** @var Worksheet $dataSheet */
|
|
$dataSheet = $spreadsheet->getSheetByName('Data');
|
|
/** @var Worksheet $totalsSheet */
|
|
$totalsSheet = $spreadsheet->getSheetByName('Totals');
|
|
|
|
/** @var NamedRange $firstColumn */
|
|
$firstColumn = $spreadsheet->getNamedRange('FirstColumn');
|
|
/** @var NamedRange $secondColumn */
|
|
$secondColumn = $spreadsheet->getNamedRange('SecondColumn');
|
|
|
|
$dataSheet->setCellValue('D2', '=FirstTotal');
|
|
$dataSheet->setCellValue('D3', '=FirstTotal');
|
|
$dataSheet->setCellValue('B2', '=SecondTotal');
|
|
$dataSheet->setCellValue('B3', '=SecondTotal');
|
|
$dataSheet->setCellValue('B4', '=ProductTotal');
|
|
|
|
$dataSheet->insertNewRowBefore(2, 5); // 5 rows before row 2
|
|
self::assertSame('=Data!$A$7:$A6', $firstColumn->getRange());
|
|
self::assertSame('=Data!B$7:B6', $secondColumn->getRange());
|
|
$dataSheet->removeRow(2, 1); // remove one of inserted rows
|
|
self::assertSame('=Data!$A$6:$A6', $firstColumn->getRange());
|
|
self::assertSame('=Data!B$6:B6', $secondColumn->getRange());
|
|
|
|
self::assertSame('=Data!$A$6:$A6', $firstColumn->getRange());
|
|
self::assertSame('=Data!B$6:B6', $secondColumn->getRange());
|
|
|
|
self::assertSame(42, $dataSheet->getCell('D6')->getCalculatedValue());
|
|
self::assertSame(56, $dataSheet->getCell('D7')->getCalculatedValue());
|
|
self::assertSame(36, $dataSheet->getCell('B6')->getCalculatedValue());
|
|
self::assertSame(49, $dataSheet->getCell('B7')->getCalculatedValue());
|
|
|
|
$totalsSheet->setCellValue('D6', '=FirstTotal');
|
|
$totalsSheet->setCellValue('D7', '=FirstTotal');
|
|
$totalsSheet->setCellValue('B6', '=SecondTotal');
|
|
$totalsSheet->setCellValue('B7', '=SecondTotal');
|
|
$totalsSheet->setCellValue('B8', '=ProductTotal');
|
|
self::assertSame($dataSheet->getCell('D6')->getCalculatedValue(), $totalsSheet->getCell('D6')->getCalculatedValue());
|
|
self::assertSame($dataSheet->getCell('D7')->getCalculatedValue(), $totalsSheet->getCell('D7')->getCalculatedValue());
|
|
self::assertSame($dataSheet->getCell('B6')->getCalculatedValue(), $totalsSheet->getCell('B6')->getCalculatedValue());
|
|
self::assertSame($dataSheet->getCell('B7')->getCalculatedValue(), $totalsSheet->getCell('B7')->getCalculatedValue());
|
|
self::assertSame(4608, $dataSheet->getCell('B8')->getCalculatedValue());
|
|
self::assertSame($dataSheet->getCell('B8')->getCalculatedValue(), $totalsSheet->getCell('B8')->getCalculatedValue());
|
|
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testInsertDeleteColumnsWithDefinedNames(): void
|
|
{
|
|
$spreadsheet = $this->buildDefinedNamesTestWorkbook();
|
|
/** @var Worksheet $dataSheet */
|
|
$dataSheet = $spreadsheet->getSheetByName('Data');
|
|
/** @var Worksheet $totalsSheet */
|
|
$totalsSheet = $spreadsheet->getSheetByName('Totals');
|
|
|
|
/** @var NamedRange $firstColumn */
|
|
$firstColumn = $spreadsheet->getNamedRange('FirstColumn');
|
|
/** @var NamedRange $secondColumn */
|
|
$secondColumn = $spreadsheet->getNamedRange('SecondColumn');
|
|
|
|
$dataSheet->setCellValue('D2', '=FirstTotal');
|
|
$dataSheet->setCellValue('D3', '=FirstTotal');
|
|
$dataSheet->setCellValue('B2', '=SecondTotal');
|
|
$dataSheet->setCellValue('B3', '=SecondTotal');
|
|
$dataSheet->setCellValue('B4', '=ProductTotal');
|
|
|
|
$dataSheet->insertNewColumnBefore('A', 3);
|
|
self::assertSame('=Data!$D$2:$D6', $firstColumn->getRange());
|
|
self::assertSame('=Data!B$2:B6', $secondColumn->getRange());
|
|
$dataSheet->removeColumn('A');
|
|
self::assertSame('=Data!$C$2:$C6', $firstColumn->getRange());
|
|
self::assertSame('=Data!B$2:B6', $secondColumn->getRange());
|
|
|
|
self::assertSame(42, $dataSheet->getCell('F2')->getCalculatedValue());
|
|
self::assertSame(56, $dataSheet->getCell('F3')->getCalculatedValue());
|
|
self::assertSame(36, $dataSheet->getCell('D2')->getCalculatedValue());
|
|
self::assertSame(49, $dataSheet->getCell('D3')->getCalculatedValue());
|
|
|
|
$totalsSheet->setCellValue('B2', '=SecondTotal');
|
|
$totalsSheet->setCellValue('B3', '=SecondTotal');
|
|
self::assertSame(42, $totalsSheet->getCell('B2')->getCalculatedValue());
|
|
self::assertSame(56, $totalsSheet->getCell('B3')->getCalculatedValue());
|
|
|
|
self::assertSame(4608, $dataSheet->getCell('D4')->getCalculatedValue());
|
|
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
private function buildDefinedNamesTestWorkbook(): Spreadsheet
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$dataSheet = $spreadsheet->getActiveSheet();
|
|
$dataSheet->setTitle('Data');
|
|
|
|
$totalsSheet = $spreadsheet->addSheet(new Worksheet());
|
|
$totalsSheet->setTitle('Totals');
|
|
|
|
$spreadsheet->setActiveSheetIndexByName('Data');
|
|
|
|
$dataSheet->fromArray([['Column 1', 'Column 2'], [2, 1], [4, 3], [6, 5], [8, 7], [10, 9], [12, 11], [14, 13], [16, 15]], null, 'A1', true);
|
|
$dataSheet->insertNewColumnBefore('B', 1);
|
|
|
|
$spreadsheet->addNamedRange(
|
|
new NamedRange('FirstColumn', $spreadsheet->getActiveSheet(), '=Data!$A$2:$A6')
|
|
);
|
|
$spreadsheet->addNamedFormula(
|
|
new NamedFormula('FirstTotal', $spreadsheet->getActiveSheet(), '=SUM(FirstColumn)')
|
|
);
|
|
|
|
$spreadsheet->addNamedRange(
|
|
new NamedRange('SecondColumn', $spreadsheet->getActiveSheet(), '=Data!B$2:B6')
|
|
);
|
|
$spreadsheet->addNamedFormula(
|
|
new NamedFormula('SecondTotal', $spreadsheet->getActiveSheet(), '=SUM(SecondColumn)')
|
|
);
|
|
|
|
$spreadsheet->addNamedFormula(
|
|
new NamedFormula('ProductTotal', $spreadsheet->getActiveSheet(), '=FirstTotal*SecondTotal')
|
|
);
|
|
|
|
return $spreadsheet;
|
|
}
|
|
|
|
private function buildDefinedNamesAbsoluteWorkbook(): Spreadsheet
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$dataSheet = $spreadsheet->getActiveSheet();
|
|
$dataSheet->setTitle('Data');
|
|
|
|
$totalsSheet = $spreadsheet->addSheet(new Worksheet());
|
|
$totalsSheet->setTitle('Totals');
|
|
|
|
$spreadsheet->setActiveSheetIndexByName('Data');
|
|
|
|
$dataSheet->fromArray([['Column 1', 'Column 2'], [2, 1], [4, 3], [6, 5], [8, 7], [10, 9], [12, 11], [14, 13], [16, 15]], null, 'A1', true);
|
|
|
|
$spreadsheet->addNamedRange(
|
|
new NamedRange('FirstColumn', $spreadsheet->getActiveSheet(), '=Data!$A$2:$A$6')
|
|
);
|
|
$spreadsheet->addNamedFormula(
|
|
new NamedFormula('FirstTotal', $spreadsheet->getActiveSheet(), '=SUM(FirstColumn)')
|
|
);
|
|
$totalsSheet->setCellValue('A20', '=FirstTotal');
|
|
|
|
$spreadsheet->addNamedRange(
|
|
new NamedRange('SecondColumn', $spreadsheet->getActiveSheet(), '=Data!$B$2:$B$6')
|
|
);
|
|
$spreadsheet->addNamedFormula(
|
|
new NamedFormula('SecondTotal', $spreadsheet->getActiveSheet(), '=SUM(SecondColumn)')
|
|
);
|
|
$totalsSheet->setCellValue('B20', '=SecondTotal');
|
|
|
|
$spreadsheet->addNamedFormula(
|
|
new NamedFormula('ProductTotal', $spreadsheet->getActiveSheet(), '=FirstTotal*SecondTotal')
|
|
);
|
|
$totalsSheet->setCellValue('D20', '=ProductTotal');
|
|
|
|
return $spreadsheet;
|
|
}
|
|
|
|
public function testInsertBothWithDefinedNamesAbsolute(): void
|
|
{
|
|
$spreadsheet = $this->buildDefinedNamesAbsoluteWorkbook();
|
|
/** @var Worksheet $dataSheet */
|
|
$dataSheet = $spreadsheet->getSheetByName('Data');
|
|
/** @var Worksheet $totalsSheet */
|
|
$totalsSheet = $spreadsheet->getSheetByName('Totals');
|
|
|
|
$dataSheet->setCellValue('C2', '=FirstTotal');
|
|
$dataSheet->setCellValue('C3', '=FirstTotal');
|
|
$dataSheet->setCellValue('C4', '=SecondTotal');
|
|
|
|
$dataSheet->insertNewColumnBefore('A', 2);
|
|
$dataSheet->insertNewRowBefore(2, 4); // 4 rows before row 2
|
|
|
|
/** @var NamedRange $firstColumn */
|
|
$firstColumn = $spreadsheet->getNamedRange('FirstColumn');
|
|
/** @var NamedRange $secondColumn */
|
|
$secondColumn = $spreadsheet->getNamedRange('SecondColumn');
|
|
|
|
self::assertSame('=Data!$C$6:$C$10', $firstColumn->getRange());
|
|
self::assertSame('=Data!$D$6:$D$10', $secondColumn->getRange());
|
|
|
|
self::assertSame(30, $totalsSheet->getCell('A20')->getCalculatedValue());
|
|
self::assertSame(25, $totalsSheet->getCell('B20')->getCalculatedValue());
|
|
self::assertSame(750, $totalsSheet->getCell('D20')->getCalculatedValue());
|
|
|
|
self::assertSame(30, $dataSheet->getCell('E6')->getCalculatedValue());
|
|
self::assertSame(30, $dataSheet->getCell('E7')->getCalculatedValue());
|
|
self::assertSame(25, $dataSheet->getCell('E8')->getCalculatedValue());
|
|
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
}
|