Added Column Formula

Option to add column formula that applied automatically
for any new rows added to the table range
This commit is contained in:
aswinkumar863 2022-04-03 18:27:38 +05:30
parent bc6ec1932a
commit feffb76944
No known key found for this signature in database
GPG Key ID: 8A69BFA6AEF8FA3E
4 changed files with 110 additions and 0 deletions

View File

@ -0,0 +1,72 @@
<?php
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Worksheet\Table;
require __DIR__ . '/../Header.php';
// Create new Spreadsheet object
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
// Set document properties
$helper->log('Set document properties');
$spreadsheet->getProperties()->setCreator('aswinkumar863')
->setLastModifiedBy('aswinkumar863')
->setTitle('PhpSpreadsheet Table Test Document')
->setSubject('PhpSpreadsheet Table Test Document')
->setDescription('Test document for PhpSpreadsheet, generated using PHP classes.')
->setKeywords('office PhpSpreadsheet php')
->setCategory('Table');
// Create the worksheet
$helper->log('Add data');
$spreadsheet->setActiveSheetIndex(0);
$columnFormula = '=SUM(Sales_Data[[#This Row],[Q1]:[Q4]])';
$dataArray = [
['Year', 'Country', 'Q1', 'Q2', 'Q3', 'Q4', 'Sales'],
[2010, 'Belgium', 380, 390, 420, 460, $columnFormula],
[2010, 'France', 510, 490, 460, 590, $columnFormula],
[2010, 'Germany', 720, 680, 640, 660, $columnFormula],
[2010, 'Italy', 440, 410, 420, 450, $columnFormula],
[2010, 'Spain', 510, 490, 470, 420, $columnFormula],
[2010, 'UK', 690, 610, 620, 600, $columnFormula],
[2010, 'United States', 790, 730, 860, 850, $columnFormula],
[2011, 'Belgium', 400, 350, 450, 500, $columnFormula],
[2011, 'France', 620, 650, 415, 570, $columnFormula],
[2011, 'Germany', 680, 620, 710, 690, $columnFormula],
[2011, 'Italy', 430, 370, 350, 335, $columnFormula],
[2011, 'Spain', 460, 390, 430, 415, $columnFormula],
[2011, 'UK', 720, 650, 580, 510, $columnFormula],
[2011, 'United States', 800, 700, 900, 950, $columnFormula],
];
$spreadsheet->getActiveSheet()->fromArray($dataArray, null, 'A1');
// Create Table
$helper->log('Create Table');
$table = new Table();
$table->setName('Sales_Data');
$table->setRange('A1:G15');
// Set Column Formula
$table->getColumn('G')->setColumnFormula($columnFormula);
// Add Table to Worksheet
$helper->log('Add Table to Worksheet');
$spreadsheet->getActiveSheet()->addTable($table);
// Save
$path = $helper->getFilename(__FILE__);
$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
// Disable precalculation to add table's total row
$writer->setPreCalculateFormulas(false);
$callStartTime = microtime(true);
$writer->save($path);
$helper->logWrite($writer, $path, $callStartTime);
$helper->logEndingNotes();

View File

@ -41,6 +41,13 @@ class Column
*/ */
private $totalsRowFormula; private $totalsRowFormula;
/**
* Column Formula.
*
* @var string
*/
private $columnFormula;
/** /**
* Table. * Table.
* *
@ -178,6 +185,28 @@ class Column
return $this; return $this;
} }
/**
* Get column Formula.
*
* @return string
*/
public function getColumnFormula()
{
return $this->columnFormula;
}
/**
* Set column Formula.
*
* @return $this
*/
public function setColumnFormula(string $columnFormula)
{
$this->columnFormula = $columnFormula;
return $this;
}
/** /**
* Get this Column's Table. * Get this Column's Table.
* *

View File

@ -86,6 +86,10 @@ class Table extends WriterPart
$objWriter->writeAttribute('totalsRowFunction', $column->getTotalsRowFunction()); $objWriter->writeAttribute('totalsRowFunction', $column->getTotalsRowFunction());
} }
} }
if ($column->getColumnFormula()) {
$objWriter->writeElement('calculatedColumnFormula', $column->getColumnFormula());
}
$objWriter->endElement(); $objWriter->endElement();
} }
$objWriter->endElement(); $objWriter->endElement();

View File

@ -74,6 +74,11 @@ class ColumnTest extends SetupTeardown
$result = $column->setTotalsRowFunction($function); $result = $column->setTotalsRowFunction($function);
self::assertInstanceOf(Column::class, $result); self::assertInstanceOf(Column::class, $result);
self::assertEquals($function, $column->getTotalsRowFunction()); self::assertEquals($function, $column->getTotalsRowFunction());
$formula = '=SUM(Sales_Data[[#This Row],[Q1]:[Q4]])';
$result = $column->setColumnFormula($formula);
self::assertInstanceOf(Column::class, $result);
self::assertEquals($formula, $column->getColumnFormula());
} }
public function testTable(): void public function testTable(): void