Clientbase
/
PhpSpreadsheet
mirror of https://github.com/basemaster/PhpSpreadsheet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Initial work on reading conditional styles for the Xls Reader 

Successfully reading the CF ranges and CF rules; not yet reading the styles
This commit is contained in:
MarkBaker 2022-03-17 13:47:58 +01:00
parent 9b3c3f4adf
commit 45c08d6cd4
5 changed files with 284 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
src/PhpSpreadsheet/Reader/Xls.php
View File

@ -22,6 +22,7 @@ use PhpOffice\PhpSpreadsheet\Shared\Xls as SharedXls;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\Alignment;
use PhpOffice\PhpSpreadsheet\Style\Borders;
use PhpOffice\PhpSpreadsheet\Style\Conditional;
use PhpOffice\PhpSpreadsheet\Style\Font;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use PhpOffice\PhpSpreadsheet\Style\Protection;
@ -1036,11 +1037,11 @@ class Xls extends BaseReader
break;
case self::XLS_TYPE_CFHEADER:
$this->readCFHeader();
$cellRangeAddresses = $this->readCFHeader();
break;
case self::XLS_TYPE_CFRULE:
$this->readCFRule();
$this->readCFRule($cellRangeAddresses ?? []);
break;
case self::XLS_TYPE_SHEETLAYOUT:
@ -7933,9 +7934,9 @@ class Xls extends BaseReader
return $this->mapCellStyleXfIndex;
}
private function readCFHeader(): void
private function readCFHeader(): array
{
var_dump('FOUND CF HEADER');
// var_dump('FOUND CF HEADER');
$length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -7943,7 +7944,7 @@ class Xls extends BaseReader
$this->pos += 4 + $length;
if ($this->readDataOnly) {
return;
return [];
}
// offset: 0; size: 2; Rule Count
@ -7955,12 +7956,14 @@ class Xls extends BaseReader
: $this->readBIFF5CellRangeAddressList(substr($recordData, 12));
$cellRangeAddresses = $cellRangeAddressList['cellRangeAddresses'];
var_dump($ruleCount, $cellRangeAddresses);
// var_dump($ruleCount, $cellRangeAddresses);
//
return $cellRangeAddresses;
}
private function readCFRule(): void
private function readCFRule(array $cellRangeAddresses): void
{
var_dump('FOUND CF RULE');
// var_dump('FOUND CF RULE');
$length = self::getUInt2d($this->data, $this->pos + 2);
$recordData = $this->readRecordData($this->data, $this->pos + 4, $length);
@ -8023,14 +8026,15 @@ class Xls extends BaseReader
$offset += 2;
}
var_dump($type, $operator);
// var_dump($type, $operator);
//
$formula1 = $formula2 = null;
if ($size1 > 0) {
$formula1 = $this->readCFFormula($recordData, $offset, $size1);
if ($formula1 === null) {
return;
}
var_dump($formula1);
// var_dump($formula1);
$offset += $size1;
}
@ -8040,20 +8044,57 @@ class Xls extends BaseReader
if ($formula2 === null) {
return;
}
var_dump($formula2);
// var_dump($formula2);
$offset += $size2;
}
$this->setCFRules($cellRangeAddresses, $type, $operator, $formula1, $formula2);
}
private function readCFFormula(string $recordData, int $offset, int $size): ?string
/**
* @return null|float|int|string
*/
private function readCFFormula(string $recordData, int $offset, int $size)
{
try {
$formula = substr($recordData, $offset, $size);
$formula = pack('v', $size) . $formula; // prepend the length
return $this->getFormulaFromStructure($formula);
$formula = $this->getFormulaFromStructure($formula);
if (is_numeric($formula)) {
return (strpos($formula, '.') !== false) ? (float) $formula : (int) $formula;
}
return $formula;
} catch (PhpSpreadsheetException $e) {
}
return null;
}
/**
* @param null|float|int|string $formula1
* @param null|float|int|string $formula2
*/
private function setCFRules(array $cellRanges, string $type, string $operator, $formula1, $formula2): void
{
foreach ($cellRanges as $cellRange) {
$conditional = new Conditional();
$conditional->setConditionType($type);
$conditional->setOperatorType($operator);
if ($formula1 !== null) {
$conditional->addCondition($formula1);
}
if ($formula2 !== null) {
$conditional->addCondition($formula2);
}
$conditionalStyles = $this->phpSheet->getStyle($cellRange)->getConditionalStyles();
$conditionalStyles[] = $conditional;
$this->phpSheet->getStyle($cellRange)->setConditionalStyles($conditionalStyles);
$this->phpSheet->getStyle($cellRange)->setConditionalStyles($conditionalStyles);
}
}
}

158
tests/PhpSpreadsheetTests/Reader/Xls/ConditionalFormattingBasicTest.php Normal file
View File

@ -0,0 +1,158 @@
<?php
namespace PhpOffice\PhpSpreadsheetTests\Reader\Xls;
use PhpOffice\PhpSpreadsheet\Reader\Xls;
use PhpOffice\PhpSpreadsheet\Style\Conditional;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use PHPUnit\Framework\TestCase;
class ConditionalFormattingBasicTest extends TestCase
{
/**
* @var Worksheet
*/
protected $sheet;
protected function setUp(): void
{
$filename = 'tests/data/Reader/XLS/CF_Basic_Comparisons.xls';
$reader = new Xls();
$spreadsheet = $reader->load($filename);
$this->sheet = $spreadsheet->getActiveSheet();
}
/**
* @dataProvider conditionalFormattingProvider
*/
public function testReadConditionalFormatting(string $expectedRange, array $expectedRules): void
{
$hasConditionalStyles = $this->sheet->conditionalStylesExists($expectedRange);
self::assertTrue($hasConditionalStyles);
$conditionalStyles = $this->sheet->getConditionalStyles($expectedRange);
foreach ($conditionalStyles as $index => $conditionalStyle) {
self::assertSame($expectedRules[$index]['type'], $conditionalStyle->getConditionType());
self::assertSame($expectedRules[$index]['operator'], $conditionalStyle->getOperatorType());
self::assertSame($expectedRules[$index]['conditions'], $conditionalStyle->getConditions());
}
}
public function conditionalFormattingProvider(): array
{
return [
[
'A2:E5',
[
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_EQUAL,
'conditions' => [
0,
],
],
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_GREATERTHAN,
'conditions' => [
0,
],
],
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_LESSTHAN,
'conditions' => [
0,
],
],
],
],
[
'A10:E13',
[
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_EQUAL,
'conditions' => [
'$H$9',
],
],
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_GREATERTHAN,
'conditions' => [
'$H$9',
],
],
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_LESSTHAN,
'conditions' => [
'$H$9',
],
],
],
],
[
'A18:A20',
[
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_BETWEEN,
'conditions' => [
'$B1',
'$C1',
],
],
],
],
[
'A24:E27',
[
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_BETWEEN,
'conditions' => [
'AVERAGE($A$24:$E$27)-STDEV($A$24:$E$27)',
'AVERAGE($A$24:$E$27)+STDEV($A$24:$E$27)',
],
],
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_GREATERTHAN,
'conditions' => [
'AVERAGE($A$24:$E$27)+STDEV($A$24:$E$27)',
],
],
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_LESSTHAN,
'conditions' => [
'AVERAGE($A$24:$E$27)-STDEV($A$24:$E$27)',
],
],
],
],
[
'A31:A33',
[
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_EQUAL,
'conditions' => [
'"LOVE"',
],
],
[
'type' => Conditional::CONDITION_CELLIS,
'operator' => Conditional::OPERATOR_EQUAL,
'conditions' => [
'"PHP"',
],
],
],
],
];
}
}

71
tests/PhpSpreadsheetTests/Reader/Xls/ConditionalFormattingExpressionTest.php Normal file
View File

@ -0,0 +1,71 @@
<?php
namespace PhpOffice\PhpSpreadsheetTests\Reader\Xls;
use PhpOffice\PhpSpreadsheet\Reader\Xls;
use PhpOffice\PhpSpreadsheet\Style\Conditional;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use PHPUnit\Framework\TestCase;
class ConditionalFormattingExpressionTest extends TestCase
{
/**
* @var Worksheet
*/
protected $sheet;
protected function setUp(): void
{
$filename = 'tests/data/Reader/XLS/CF_Expression_Comparisons.xls';
$reader = new Xls();
$spreadsheet = $reader->load($filename);
$this->sheet = $spreadsheet->getActiveSheet();
}
/**
* @dataProvider conditionalFormattingProvider
*/
public function testReadConditionalFormatting(string $expectedRange, array $expectedRule): void
{
$hasConditionalStyles = $this->sheet->conditionalStylesExists($expectedRange);
self::assertTrue($hasConditionalStyles);
$conditionalStyles = $this->sheet->getConditionalStyles($expectedRange);
foreach ($conditionalStyles as $index => $conditionalStyle) {
self::assertSame($expectedRule[$index]['type'], $conditionalStyle->getConditionType());
self::assertSame($expectedRule[$index]['operator'], $conditionalStyle->getOperatorType());
self::assertSame($expectedRule[$index]['conditions'], $conditionalStyle->getConditions());
}
}
public function conditionalFormattingProvider(): array
{
return [
[
'A3:D8',
[
[
'type' => Conditional::CONDITION_EXPRESSION,
'operator' => Conditional::OPERATOR_NONE,
'conditions' => [
'$C1="USA"',
],
],
],
],
[
'A13:D18',
[
[
'type' => Conditional::CONDITION_EXPRESSION,
'operator' => Conditional::OPERATOR_NONE,
'conditions' => [
'AND($C1="USA",$D1="Q4")',
],
],
],
],
];
}
}

30
tests/PhpSpreadsheetTests/Reader/Xls/ConditionalFormattingTest.php
View File

@ -1,30 +0,0 @@
<?php
namespace PhpOffice\PhpSpreadsheetTests\Reader\Xls;
use PhpOffice\PhpSpreadsheet\Reader\Xls;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use PHPUnit\Framework\TestCase;
class ConditionalFormattingTest extends TestCase
{
/**
* @var Worksheet
*/
protected $sheet;
public function setUp(): void
{
$filename = 'tests/data/Reader/XLS/CF_Basic_Comparisons.xls';
$reader = new Xls();
$spreadsheet = $reader->load($filename);
$this->sheet = $spreadsheet->getActiveSheet();
}
public function testReadConditionalFormatting(): void
{
$hasConditionalStyles = $this->sheet->conditionalStylesExists('A2:E5');
self::assertTrue($hasConditionalStyles);
$onditionalStyles = $this->sheet->getConditionalStyles('A2:E5');
}
}

BIN
tests/data/Reader/XLS/CF_Expression_Comparisons.xls Normal file
View File

Binary file not shown.