Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conditional Color Scale Improvements #4050

Merged
merged 4 commits into from
May 31, 2024
Merged

Conditional Color Scale Improvements #4050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2760e5a
Conditional Color Scale Improvements
oleibman May 30, 2024
fcc5cf1
Minor Test Improvement
oleibman May 30, 2024
24e6f4d
Update CHANGELOG.md
oleibman May 31, 2024
15fb1b5
Merge branch 'master' into issue4049
oleibman May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
- Incorrect Reader CSV with BOM. [Issue #4028](https://github.com/PHPOffice/PhpSpreadsheet/issues/4028) [PR #4029](https://github.com/PHPOffice/PhpSpreadsheet/pull/4029)
- POWER Null/Bool Args. [PR #4031](https://github.com/PHPOffice/PhpSpreadsheet/pull/4031)
- Do Not Output Alignment and Protection for Conditional Format. [Issue #4025](https://github.com/PHPOffice/PhpSpreadsheet/issues/4025) [PR #4027](https://github.com/PHPOffice/PhpSpreadsheet/pull/4027)
- Conditional Color Scale Improvements. [Issue #4049](https://github.com/PHPOffice/PhpSpreadsheet/issues/4049) [PR #4050](https://github.com/PHPOffice/PhpSpreadsheet/pull/4050)
- Mpdf and Tcpdf Borders on Merged Cells. [Issue #3557](https://github.com/PHPOffice/PhpSpreadsheet/issues/3557) [PR #4047](https://github.com/PHPOffice/PhpSpreadsheet/pull/4047)
- Xls Conditional Format Improvements. [PR #4030](https://github.com/PHPOffice/PhpSpreadsheet/pull/4030) [PR #4033](https://github.com/PHPOffice/PhpSpreadsheet/pull/4033)
- Csv Reader allow use of html mimetype. [Issue #4036](https://github.com/PHPOffice/PhpSpreadsheet/issues/4036) [PR #4049](https://github.com/PHPOffice/PhpSpreadsheet/pull/4040)
Expand Down
29 changes: 17 additions & 12 deletions src/PhpSpreadsheet/Reader/Xlsx/ConditionalStyles.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,29 +285,34 @@ private function readDataBarOfConditionalRule(SimpleXMLElement $cfRule, array $c
private function readColorScale(SimpleXMLElement|stdClass $cfRule): ConditionalColorScale
{
$colorScale = new ConditionalColorScale();
$types = [];
$count = count($cfRule->colorScale->cfvo);
$idx = 0;
foreach ($cfRule->colorScale->cfvo as $cfvoXml) {
$attr = $cfvoXml->attributes() ?? [];
$type = (string) ($attr['type'] ?? '');
$types[] = $type;
$val = $attr['val'] ?? null;
if ($type === 'min') {
$colorScale->setMinimumConditionalFormatValueObject(new ConditionalFormatValueObject($type, $val));
} elseif ($type === 'percentile') {
$colorScale->setMidpointConditionalFormatValueObject(new ConditionalFormatValueObject($type, $val));
} elseif ($type === 'max') {
$colorScale->setMaximumConditionalFormatValueObject(new ConditionalFormatValueObject($type, $val));
if ($idx === 0) {
$method = 'setMinimumConditionalFormatValueObject';
} elseif ($idx === 1 && $count === 3) {
$method = 'setMidpointConditionalFormatValueObject';
} else {
$method = 'setMaximumConditionalFormatValueObject';
}
if ($type !== 'formula') {
$colorScale->$method(new ConditionalFormatValueObject($type, $val));
} else {
$colorScale->$method(new ConditionalFormatValueObject($type, null, $val));
}
++$idx;
}
$idx = 0;
foreach ($cfRule->colorScale->color as $color) {
$type = $types[$idx];
$rgb = $this->styleReader->readColor($color);
if ($type === 'min') {
if ($idx === 0) {
$colorScale->setMinimumColor(new Color($rgb));
} elseif ($type === 'percentile') {
} elseif ($idx === 1 && $count === 3) {
$colorScale->setMidpointColor(new Color($rgb));
} elseif ($type === 'max') {
} else {
$colorScale->setMaximumColor(new Color($rgb));
}
++$idx;
Expand Down
57 changes: 51 additions & 6 deletions src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -763,26 +763,71 @@ private static function writeColorScaleElements(XMLWriter $objWriter, ?Condition
$useMin = $minCfvo !== null || $minArgb !== null;
if ($useMin) {
$objWriter->startElement('cfvo');
$objWriter->writeAttribute('type', $minCfvo?->getType() ?? 'min');
self::writeAttributeIf($objWriter, $minCfvo?->getValue() !== null, 'val', (string) $minCfvo?->getValue());
$type = 'min';
$value = null;
if ($minCfvo !== null) {
$typex = $minCfvo->getType();
if ($typex === 'formula') {
$value = $minCfvo->getCellFormula();
if ($value !== null) {
$type = $typex;
}
} else {
$type = $typex;
$defaults = ['number' => '0', 'percent' => '0', 'percentile' => '10'];
$value = $minCfvo->getValue() ?? $defaults[$type] ?? null;
}
}
$objWriter->writeAttribute('type', $type);
self::writeAttributeIf($objWriter, $value !== null, 'val', (string) $value);
$objWriter->endElement();
}
$midCfvo = $colorScale->getMidpointConditionalFormatValueObject();
$midArgb = $colorScale->getMidpointColor()?->getARGB();
$useMid = $midCfvo !== null || $midArgb !== null;
if ($useMid) {
$objWriter->startElement('cfvo');
$objWriter->writeAttribute('type', $midCfvo?->getType() ?? 'percentile');
$objWriter->writeAttribute('val', (string) (($midCfvo?->getValue()) ?? '50'));
$type = 'percentile';
$value = '50';
if ($midCfvo !== null) {
$type = $midCfvo->getType();
if ($type === 'formula') {
$value = $midCfvo->getCellFormula();
if ($value === null) {
$type = 'percentile';
$value = '50';
}
} else {
$defaults = ['number' => '0', 'percent' => '50', 'percentile' => '50'];
$value = $midCfvo->getValue() ?? $defaults[$type] ?? null;
}
}
$objWriter->writeAttribute('type', $type);
self::writeAttributeIf($objWriter, $value !== null, 'val', (string) $value);
$objWriter->endElement();
}
$maxCfvo = $colorScale->getMaximumConditionalFormatValueObject();
$maxArgb = $colorScale->getMaximumColor()?->getARGB();
$useMax = $maxCfvo !== null || $maxArgb !== null;
if ($useMax) {
$objWriter->startElement('cfvo');
$objWriter->writeAttribute('type', $maxCfvo?->getType() ?? 'max');
self::writeAttributeIf($objWriter, $maxCfvo?->getValue() !== null, 'val', (string) $maxCfvo?->getValue());
$type = 'max';
$value = null;
if ($maxCfvo !== null) {
$typex = $maxCfvo->getType();
if ($typex === 'formula') {
$value = $maxCfvo->getCellFormula();
if ($value !== null) {
$type = $typex;
}
} else {
$type = $typex;
$defaults = ['number' => '0', 'percent' => '100', 'percentile' => '90'];
$value = $maxCfvo->getValue() ?? $defaults[$type] ?? null;
}
}
$objWriter->writeAttribute('type', $type);
self::writeAttributeIf($objWriter, $value !== null, 'val', (string) $value);
$objWriter->endElement();
}
if ($useMin) {
Expand Down
40 changes: 40 additions & 0 deletions tests/PhpSpreadsheetTests/Reader/Xlsx/Issue4049Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

declare(strict_types=1);

namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;

use PhpOffice\PhpSpreadsheet\Reader\Xlsx;
use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional;

class Issue4049Test extends AbstractFunctional
{
public function testColorScale(): void
{
$xlsxFile = 'tests/data/Reader/XLSX/issue.4049.xlsx';
$reader = new Xlsx();
$oldSpreadsheet = $reader->load($xlsxFile);
$spreadsheet = $this->writeAndReload($oldSpreadsheet, 'Xlsx');
$oldSpreadsheet->disconnectWorksheets();
$sheet = $spreadsheet->getActiveSheet();
$conditionals = $sheet->getConditionalStylesCollection();
self::assertCount(1, $conditionals);
self::assertSame('E9:E14', array_keys($conditionals)[0]);
$cond1 = $conditionals['E9:E14'];
self::assertCount(1, $cond1);
self::assertSame('colorScale', $cond1[0]->getConditionType());
$colorScale = $cond1[0]->getColorScale();
self::assertNotNull($colorScale);
$min = $colorScale->getMinimumConditionalFormatValueObject();
self::assertSame('formula', $min->getType());
self::assertSame('25', $min->getCellFormula());

self::assertNull($colorScale->getMidpointConditionalFormatValueObject());

$max = $colorScale->getMaximumConditionalFormatValueObject();
self::assertSame('max', $max->getType());
self::assertNull($max->getValue());

$spreadsheet->disconnectWorksheets();
}
}
Binary file added tests/data/Reader/XLSX/issue.4049.xlsx
View file
Open in desktop
Binary file not shown.
Loading