Skip to content

Commit

Permalink
Refactoring of ODS Writer to break codebase into smaller components (#…
Browse files Browse the repository at this point in the history 
…1820)

* Refactoring of ODS Writer to break codebase into smaller components
  • Loading branch information
Mark Baker committed Feb 1, 2021
1 parent 5f761b6 commit d28b7de
Show file tree
Hide file tree
Showing 2 changed files with 183 additions and 138 deletions.
178 changes: 178 additions & 0 deletions src/PhpSpreadsheet/Writer/Ods/Cell/Style.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
<?php

namespace PhpOffice\PhpSpreadsheet\Writer\Ods\Cell;

use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
use PhpOffice\PhpSpreadsheet\Style\Alignment;
use PhpOffice\PhpSpreadsheet\Style\Fill;
use PhpOffice\PhpSpreadsheet\Style\Font;
use PhpOffice\PhpSpreadsheet\Style\Style as CellStyle;

class Style
{
public const CELL_STYLE_PREFIX = 'ce';

private $writer;

public function __construct(XMLWriter $writer)
{
$this->writer = $writer;
}

private function mapHorizontalAlignment(string $horizontalAlignment): string
{
switch ($horizontalAlignment) {
case Alignment::HORIZONTAL_CENTER:
case Alignment::HORIZONTAL_CENTER_CONTINUOUS:
case Alignment::HORIZONTAL_DISTRIBUTED:
return 'center';
case Alignment::HORIZONTAL_RIGHT:
return 'end';
case Alignment::HORIZONTAL_FILL:
case Alignment::HORIZONTAL_JUSTIFY:
return 'justify';
}

return 'start';
}

private function mapVerticalAlignment(string $verticalAlignment): string
{
switch ($verticalAlignment) {
case Alignment::VERTICAL_TOP:
return 'top';
case Alignment::VERTICAL_CENTER:
return 'middle';
case Alignment::VERTICAL_DISTRIBUTED:
case Alignment::VERTICAL_JUSTIFY:
return 'automatic';
}

return 'bottom';
}

private function writeFillStyle(Fill $fill): void
{
switch ($fill->getFillType()) {
case Fill::FILL_SOLID:
$this->writer->writeAttribute('fo:background-color', sprintf(
'#%s',
strtolower($fill->getStartColor()->getRGB())
));

break;
case Fill::FILL_GRADIENT_LINEAR:
case Fill::FILL_GRADIENT_PATH:
/// TODO :: To be implemented
break;
case Fill::FILL_NONE:
default:
}
}

private function writeCellProperties(CellStyle $style): void
{
// Align
$hAlign = $style->getAlignment()->getHorizontal();
$vAlign = $style->getAlignment()->getVertical();
$wrap = $style->getAlignment()->getWrapText();

$this->writer->startElement('style:table-cell-properties');
if (!empty($vAlign) || $wrap) {
if (!empty($vAlign)) {
$vAlign = $this->mapVerticalAlignment($vAlign);
$this->writer->writeAttribute('style:vertical-align', $vAlign);
}
if ($wrap) {
$this->writer->writeAttribute('fo:wrap-option', 'wrap');
}
}
$this->writer->writeAttribute('style:rotation-align', 'none');

// Fill
if ($fill = $style->getFill()) {
$this->writeFillStyle($fill);
}

$this->writer->endElement();

if (!empty($hAlign)) {
$hAlign = $this->mapHorizontalAlignment($hAlign);
$this->writer->startElement('style:paragraph-properties');
$this->writer->writeAttribute('fo:text-align', $hAlign);
$this->writer->endElement();
}
}

protected function mapUnderlineStyle(Font $font): string
{
switch ($font->getUnderline()) {
case Font::UNDERLINE_DOUBLE:
case Font::UNDERLINE_DOUBLEACCOUNTING:
return'double';
case Font::UNDERLINE_SINGLE:
case Font::UNDERLINE_SINGLEACCOUNTING:
return'single';
}

return 'none';
}

protected function writeTextProperties(CellStyle $style): void
{
// Font
$this->writer->startElement('style:text-properties');

$font = $style->getFont();

if ($font->getBold()) {
$this->writer->writeAttribute('fo:font-weight', 'bold');
$this->writer->writeAttribute('style:font-weight-complex', 'bold');
$this->writer->writeAttribute('style:font-weight-asian', 'bold');
}

if ($font->getItalic()) {
$this->writer->writeAttribute('fo:font-style', 'italic');
}

if ($color = $font->getColor()) {
$this->writer->writeAttribute('fo:color', sprintf('#%s', $color->getRGB()));
}

if ($family = $font->getName()) {
$this->writer->writeAttribute('fo:font-family', $family);
}

if ($size = $font->getSize()) {
$this->writer->writeAttribute('fo:font-size', sprintf('%.1Fpt', $size));
}

if ($font->getUnderline() && $font->getUnderline() !== Font::UNDERLINE_NONE) {
$this->writer->writeAttribute('style:text-underline-style', 'solid');
$this->writer->writeAttribute('style:text-underline-width', 'auto');
$this->writer->writeAttribute('style:text-underline-color', 'font-color');

$underline = $this->mapUnderlineStyle($font);
$this->writer->writeAttribute('style:text-underline-type', $underline);
}

$this->writer->endElement(); // Close style:text-properties
}

public function write(CellStyle $style): void
{
$this->writer->startElement('style:style');
$this->writer->writeAttribute('style:name', self::CELL_STYLE_PREFIX . $style->getIndex());
$this->writer->writeAttribute('style:family', 'table-cell');
$this->writer->writeAttribute('style:parent-style-name', 'Default');

// Alignment, fill colour, etc
$this->writeCellProperties($style);

// style:text-properties
$this->writeTextProperties($style);

// End
$this->writer->endElement(); // Close style:style
}
}
143 changes: 5 additions & 138 deletions src/PhpSpreadsheet/Writer/Ods/Content.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@
use PhpOffice\PhpSpreadsheet\Cell\DataType;
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\Alignment;
use PhpOffice\PhpSpreadsheet\Style\Fill;
use PhpOffice\PhpSpreadsheet\Style\Font;
use PhpOffice\PhpSpreadsheet\Worksheet\Row;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use PhpOffice\PhpSpreadsheet\Writer\Exception;
use PhpOffice\PhpSpreadsheet\Writer\Ods;
use PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Comment;
use PhpOffice\PhpSpreadsheet\Writer\Ods\Cell\Style;

/**
* @author Alexander Pervakov <frost-nzcr4@jagmort.com>
Expand All @@ -23,7 +21,6 @@ class Content extends WriterPart
{
const NUMBER_COLS_REPEATED_MAX = 1024;
const NUMBER_ROWS_REPEATED_MAX = 1048576;
const CELL_STYLE_PREFIX = 'ce';

private $formulaConvertor;

Expand Down Expand Up @@ -186,7 +183,7 @@ private function writeCells(XMLWriter $objWriter, Row $row): void
// Style XF
$style = $cell->getXfIndex();
if ($style !== null) {
$objWriter->writeAttribute('table:style-name', self::CELL_STYLE_PREFIX . $style);
$objWriter->writeAttribute('table:style-name', Style::CELL_STYLE_PREFIX . $style);
}

switch ($cell->getDataType()) {
Expand Down Expand Up @@ -271,144 +268,14 @@ private function writeCellSpan(XMLWriter $objWriter, $curColumn, $prevColumn): v
}
}

private function mapHorizontalAlignment(string $horizontalAlignment): string
{
switch ($horizontalAlignment) {
case Alignment::HORIZONTAL_CENTER:
case Alignment::HORIZONTAL_CENTER_CONTINUOUS:
case Alignment::HORIZONTAL_DISTRIBUTED:
return 'center';
case Alignment::HORIZONTAL_RIGHT:
return 'end';
case Alignment::HORIZONTAL_FILL:
case Alignment::HORIZONTAL_JUSTIFY:
return 'justify';
}

return 'start';
}

private function mapVerticalAlignment(string $verticalAlignment): string
{
switch ($verticalAlignment) {
case Alignment::VERTICAL_TOP:
return 'top';
case Alignment::VERTICAL_CENTER:
return 'middle';
case Alignment::VERTICAL_DISTRIBUTED:
case Alignment::VERTICAL_JUSTIFY:
return 'automatic';
}

return 'bottom';
}

/**
* Write XF cell styles.
*/
private function writeXfStyles(XMLWriter $writer, Spreadsheet $spreadsheet): void
{
$styleWriter = new Style($writer);
foreach ($spreadsheet->getCellXfCollection() as $style) {
$writer->startElement('style:style');
$writer->writeAttribute('style:name', self::CELL_STYLE_PREFIX . $style->getIndex());
$writer->writeAttribute('style:family', 'table-cell');
$writer->writeAttribute('style:parent-style-name', 'Default');

// Align
$hAlign = $style->getAlignment()->getHorizontal();
$vAlign = $style->getAlignment()->getVertical();
$wrap = $style->getAlignment()->getWrapText();

$writer->startElement('style:table-cell-properties');
if (!empty($vAlign) || $wrap) {
if (!empty($vAlign)) {
$vAlign = $this->mapVerticalAlignment($vAlign);
$writer->writeAttribute('style:vertical-align', $vAlign);
}
if ($wrap) {
$writer->writeAttribute('fo:wrap-option', 'wrap');
}
}
$writer->writeAttribute('style:rotation-align', 'none');

// Fill
if ($fill = $style->getFill()) {
switch ($fill->getFillType()) {
case Fill::FILL_SOLID:
$writer->writeAttribute('fo:background-color', sprintf(
'#%s',
strtolower($fill->getStartColor()->getRGB())
));

break;
case Fill::FILL_GRADIENT_LINEAR:
case Fill::FILL_GRADIENT_PATH:
/// TODO :: To be implemented
break;
case Fill::FILL_NONE:
default:
}
}

$writer->endElement();

if (!empty($hAlign)) {
$hAlign = $this->mapHorizontalAlignment($hAlign);
$writer->startElement('style:paragraph-properties');
$writer->writeAttribute('fo:text-align', $hAlign);
$writer->endElement();
}

// style:text-properties

// Font
$writer->startElement('style:text-properties');

$font = $style->getFont();

if ($font->getBold()) {
$writer->writeAttribute('fo:font-weight', 'bold');
$writer->writeAttribute('style:font-weight-complex', 'bold');
$writer->writeAttribute('style:font-weight-asian', 'bold');
}

if ($font->getItalic()) {
$writer->writeAttribute('fo:font-style', 'italic');
}

if ($color = $font->getColor()) {
$writer->writeAttribute('fo:color', sprintf('#%s', $color->getRGB()));
}

if ($family = $font->getName()) {
$writer->writeAttribute('fo:font-family', $family);
}

if ($size = $font->getSize()) {
$writer->writeAttribute('fo:font-size', sprintf('%.1Fpt', $size));
}

if ($font->getUnderline() && $font->getUnderline() != Font::UNDERLINE_NONE) {
$writer->writeAttribute('style:text-underline-style', 'solid');
$writer->writeAttribute('style:text-underline-width', 'auto');
$writer->writeAttribute('style:text-underline-color', 'font-color');

switch ($font->getUnderline()) {
case Font::UNDERLINE_DOUBLE:
$writer->writeAttribute('style:text-underline-type', 'double');

break;
case Font::UNDERLINE_SINGLE:
$writer->writeAttribute('style:text-underline-type', 'single');

break;
}
}

$writer->endElement(); // Close style:text-properties

// End
$writer->endElement(); // Close style:style
$styleWriter->write($style);
}
}

Expand All @@ -426,7 +293,7 @@ private function writeCellMerge(XMLWriter $objWriter, Cell $cell): void
$start = Coordinate::coordinateFromString($startCell);
$end = Coordinate::coordinateFromString($endCell);
$columnSpan = Coordinate::columnIndexFromString($end[0]) - Coordinate::columnIndexFromString($start[0]) + 1;
$rowSpan = $end[1] - $start[1] + 1;
$rowSpan = ((int) $end[1]) - ((int) $start[1]) + 1;

$objWriter->writeAttribute('table:number-columns-spanned', $columnSpan);
$objWriter->writeAttribute('table:number-rows-spanned', $rowSpan);
Expand Down

0 comments on commit d28b7de

Please sign in to comment.