mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-09-03 14:10:27 +00:00
oleibman
ed82b8b30b
Html Reader recognizes a `data-format` attribute for storing the number format associated with a cell. However, Html Writer does not set this attribute. This PR offers a new Writer property `preserveFormatAndValue` and setter; when `true`, for any cell which uses a number format other than the default `General` the writer will generate a `data-format` attribute and, for strings or numbers, it will also generate a `data-value` attribute. This will increase the accuracy of the spreadsheet when reading/writing Html. To make this change less abstract, assume a cell which has a value of `1234` and a number format of `$#,###.00`. The cell displayed in the generated Html will appear, regardless of the setting of the new property, as `$1,234.00`. However, the Reader currently treats it as a string with that value. If the html has been generated with the new property set to `true`, the Reader will treat it as a numeric cell with a value of `1234` and a style of `#,###.00`. This permits a more accurate reproduction of the original spreadsheet. I suspect that setting the new property, aside from causing a slight increase in file size, will not cause any significant breaks. However, I'm not totally convinced, so the property will default to `false` (no change in behavior). The default may change in a future breaking release.
388 lines
15 KiB
PHP
388 lines
15 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpOffice\PhpSpreadsheetTests\Reader\Html;
|
|
|
|
use PhpOffice\PhpSpreadsheet\Cell\DataType;
|
|
use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException;
|
|
use PhpOffice\PhpSpreadsheet\Reader\Html;
|
|
use PhpOffice\PhpSpreadsheet\Style\Alignment;
|
|
use PhpOffice\PhpSpreadsheet\Style\Border;
|
|
use PhpOffice\PhpSpreadsheet\Style\Font;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class HtmlTest extends TestCase
|
|
{
|
|
public function testCsvWithAngleBracket(): void
|
|
{
|
|
$filename = 'tests/data/Reader/HTML/csv_with_angle_bracket.csv';
|
|
$reader = new Html();
|
|
self::assertFalse($reader->canRead($filename));
|
|
}
|
|
|
|
// testBadHtml moved to HtmlPhpunit10Test
|
|
|
|
public function testNonHtml(): void
|
|
{
|
|
$filename = __FILE__;
|
|
$reader = new Html();
|
|
self::assertFalse($reader->canRead($filename));
|
|
|
|
$this->expectException(ReaderException::class);
|
|
$reader->load($filename);
|
|
}
|
|
|
|
public function testInvalidFilename(): void
|
|
{
|
|
$reader = new Html();
|
|
self::assertEquals(0, $reader->getSheetIndex());
|
|
self::assertFalse($reader->canRead(''));
|
|
}
|
|
|
|
public static function providerCanReadVerySmallFile(): array
|
|
{
|
|
$padding = str_repeat('a', 2048);
|
|
|
|
return [
|
|
[true, ' <html> ' . $padding . ' </html> '],
|
|
[true, ' <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html>' . $padding . '</html>'],
|
|
[true, '<html></html>'],
|
|
[false, ''],
|
|
];
|
|
}
|
|
|
|
#[\PHPUnit\Framework\Attributes\DataProvider('providerCanReadVerySmallFile')]
|
|
public function testCanReadVerySmallFile(bool $expected, string $content): void
|
|
{
|
|
$filename = HtmlHelper::createHtml($content);
|
|
$reader = new Html();
|
|
$actual = $reader->canRead($filename);
|
|
|
|
self::assertSame($expected, $actual);
|
|
|
|
unlink($filename);
|
|
}
|
|
|
|
public function testBackgroundColorInRanding(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td style="background-color: #0000FF;color: #FFFFFF">Blue background</td>
|
|
<td style="background-color: unknown1;color: unknown2">Unknown fore/background</td>
|
|
<td style="background-color: antiquewhite2;color: aliceblue">Unknown fore/background</td>
|
|
</tr>
|
|
</table>';
|
|
$spreadsheet = HtmlHelper::loadHtmlStringIntoSpreadsheet($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
$style = $firstSheet->getCell('A1')->getStyle();
|
|
self::assertEquals('FFFFFF', $style->getFont()->getColor()->getRGB());
|
|
self::assertEquals('0000FF', $style->getFill()->getStartColor()->getRGB());
|
|
self::assertEquals('0000FF', $style->getFill()->getEndColor()->getRGB());
|
|
$style = $firstSheet->getCell('B1')->getStyle();
|
|
self::assertEquals('000000', $style->getFont()->getColor()->getRGB());
|
|
self::assertEquals('000000', $style->getFill()->getEndColor()->getRGB());
|
|
self::assertEquals('FFFFFF', $style->getFill()->getstartColor()->getRGB());
|
|
$style = $firstSheet->getCell('C1')->getStyle();
|
|
self::assertEquals('f0f8ff', $style->getFont()->getColor()->getRGB());
|
|
self::assertEquals('eedfcc', $style->getFill()->getEndColor()->getRGB());
|
|
self::assertEquals('eedfcc', $style->getFill()->getstartColor()->getRGB());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testCanApplyInlineFontStyles(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td style="font-size: 16px;">16px</td>
|
|
<td style="font-family: \'Times New Roman\'">Times New Roman</td>
|
|
<td style="font-weight: bold;">Bold</td>
|
|
<td style="font-style: italic;">Italic</td>
|
|
<td style="text-decoration: underline;">Underline</td>
|
|
<td style="text-decoration: line-through;">Line through</td>
|
|
</tr>
|
|
</table>';
|
|
$spreadsheet = HtmlHelper::loadHtmlStringIntoSpreadsheet($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
|
|
$style = $firstSheet->getCell('A1')->getStyle();
|
|
self::assertEquals(16, $style->getFont()->getSize());
|
|
|
|
$style = $firstSheet->getCell('B1')->getStyle();
|
|
self::assertEquals('Times New Roman', $style->getFont()->getName());
|
|
|
|
$style = $firstSheet->getCell('C1')->getStyle();
|
|
self::assertTrue($style->getFont()->getBold());
|
|
|
|
$style = $firstSheet->getCell('D1')->getStyle();
|
|
self::assertTrue($style->getFont()->getItalic());
|
|
|
|
$style = $firstSheet->getCell('E1')->getStyle();
|
|
self::assertEquals(Font::UNDERLINE_SINGLE, $style->getFont()->getUnderline());
|
|
|
|
$style = $firstSheet->getCell('F1')->getStyle();
|
|
self::assertTrue($style->getFont()->getStrikethrough());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testCanApplyInlineWidth(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td width="50">50px</td>
|
|
<td style="width: 100px;">100px</td>
|
|
<td width="50px">50px</td>
|
|
</tr>
|
|
</table>';
|
|
$spreadsheet = HtmlHelper::loadHtmlStringIntoSpreadsheet($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
|
|
$dimension = $firstSheet->getColumnDimension('A');
|
|
self::assertEquals(50, $dimension->getWidth());
|
|
|
|
$dimension = $firstSheet->getColumnDimension('B');
|
|
self::assertEquals(100, $dimension->getWidth('px'));
|
|
|
|
$dimension = $firstSheet->getColumnDimension('C');
|
|
self::assertEquals(50, $dimension->getWidth('px'));
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testCanApplyInlineHeight(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td height="50">1</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="height: 100px;">2</td>
|
|
</tr>
|
|
<tr>
|
|
<td height="50px">1</td>
|
|
</tr>
|
|
</table>';
|
|
$spreadsheet = HtmlHelper::loadHtmlStringIntoSpreadsheet($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
|
|
$dimension = $firstSheet->getRowDimension(1);
|
|
self::assertEquals(50, $dimension->getRowHeight());
|
|
|
|
$dimension = $firstSheet->getRowDimension(2);
|
|
self::assertEquals(100, $dimension->getRowHeight('px'));
|
|
|
|
$dimension = $firstSheet->getRowDimension(3);
|
|
self::assertEquals(50, $dimension->getRowHeight('px'));
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testCanApplyAlignment(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td align="center">Center align</td>
|
|
<td valign="center">Center valign</td>
|
|
<td style="text-align: center;">Center align</td>
|
|
<td style="vertical-align: center;">Center valign</td>
|
|
<td style="text-indent: 9px;">Text indent</td>
|
|
<td style="word-wrap: break-word;">Wraptext</td>
|
|
</tr>
|
|
</table>';
|
|
$spreadsheet = HtmlHelper::loadHtmlStringIntoSpreadsheet($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
|
|
$style = $firstSheet->getCell('A1')->getStyle();
|
|
self::assertEquals(Alignment::HORIZONTAL_CENTER, $style->getAlignment()->getHorizontal());
|
|
|
|
$style = $firstSheet->getCell('B1')->getStyle();
|
|
self::assertEquals(Alignment::VERTICAL_CENTER, $style->getAlignment()->getVertical());
|
|
|
|
$style = $firstSheet->getCell('C1')->getStyle();
|
|
self::assertEquals(Alignment::HORIZONTAL_CENTER, $style->getAlignment()->getHorizontal());
|
|
|
|
$style = $firstSheet->getCell('D1')->getStyle();
|
|
self::assertEquals(Alignment::VERTICAL_CENTER, $style->getAlignment()->getVertical());
|
|
|
|
$style = $firstSheet->getCell('E1')->getStyle();
|
|
self::assertEquals(1, $style->getAlignment()->getIndent());
|
|
|
|
$style = $firstSheet->getCell('F1')->getStyle();
|
|
self::assertTrue($style->getAlignment()->getWrapText());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testCanApplyCellWrapping(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td>Hello World</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Hello<br />World</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Hello<br>World</td>
|
|
</tr>
|
|
</table>';
|
|
$spreadsheet = HtmlHelper::loadHtmlStringIntoSpreadsheet($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
|
|
$cellStyle = $firstSheet->getStyle('A1');
|
|
self::assertFalse($cellStyle->getAlignment()->getWrapText());
|
|
|
|
$cellStyle = $firstSheet->getStyle('A2');
|
|
self::assertTrue($cellStyle->getAlignment()->getWrapText());
|
|
$cellValue = $firstSheet->getCell('A2')->getValue();
|
|
self::assertStringContainsString("\n", $cellValue);
|
|
|
|
$cellStyle = $firstSheet->getStyle('A3');
|
|
self::assertTrue($cellStyle->getAlignment()->getWrapText());
|
|
$cellValue = $firstSheet->getCell('A3')->getValue();
|
|
self::assertStringContainsString("\n", $cellValue);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testRowspanInRendering(): void
|
|
{
|
|
$filename = 'tests/data/Reader/HTML/rowspan.html';
|
|
$reader = new Html();
|
|
$spreadsheet = $reader->load($filename);
|
|
|
|
$actual = $spreadsheet->getActiveSheet()->getMergeCells();
|
|
self::assertSame(['A2:C2' => 'A2:C2'], $actual);
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testTextIndentUseRowspan(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td>1</td>
|
|
<td rowspan="2" style="vertical-align: center;">Center Align</td>
|
|
<td>Row</td>
|
|
</tr>
|
|
<tr>
|
|
<td>2</td>
|
|
<td style="text-indent:9px">Text Indent</td>
|
|
</tr>
|
|
</table>';
|
|
$spreadsheet = HtmlHelper::loadHtmlStringIntoSpreadsheet($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
$style = $firstSheet->getCell('C2')->getStyle();
|
|
self::assertSame(1, $style->getAlignment()->getIndent());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testBorderWithRowspanAndColspan(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td style="border: 1px solid black;">NOT SPANNED</td>
|
|
<td rowspan="2" colspan="2" style="border: 1px solid black;">SPANNED</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="border: 1px solid black;">NOT SPANNED</td>
|
|
</tr>
|
|
</table>';
|
|
|
|
$reader = new Html();
|
|
$spreadsheet = $reader->loadFromString($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
$style = $firstSheet->getStyle('B1:C2');
|
|
|
|
$borders = $style->getBorders();
|
|
|
|
$totalBorders = [
|
|
$borders->getTop(),
|
|
$borders->getLeft(),
|
|
$borders->getBottom(),
|
|
$borders->getRight(),
|
|
];
|
|
|
|
foreach ($totalBorders as $border) {
|
|
self::assertSame(Border::BORDER_THIN, $border->getBorderStyle());
|
|
}
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testBorderWithColspan(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td style="border: 1px solid black;">NOT SPANNED</td>
|
|
<td colspan="2" style="border: 1px solid black;">SPANNED</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="border: 1px solid black;">NOT SPANNED</td>
|
|
</tr>
|
|
</table>';
|
|
|
|
$reader = new Html();
|
|
$spreadsheet = $reader->loadFromString($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
$style = $firstSheet->getStyle('B1:B2');
|
|
|
|
$borders = $style->getBorders();
|
|
|
|
$totalBorders = [
|
|
$borders->getTop(),
|
|
$borders->getLeft(),
|
|
$borders->getBottom(),
|
|
$borders->getRight(),
|
|
];
|
|
|
|
foreach ($totalBorders as $border) {
|
|
self::assertSame(Border::BORDER_THIN, $border->getBorderStyle());
|
|
}
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
|
|
public function testDataType(): void
|
|
{
|
|
$html = '<table>
|
|
<tr>
|
|
<td data-type="b">1</td>
|
|
<td data-type="s">12345678987654</td>
|
|
<!-- in some cases, you may want to treat the string with beginning equal sign as a string rather than a formula -->
|
|
<td data-type="s">=B1</td>
|
|
<td data-type="d">2022-02-21 10:20:30</td>
|
|
<td data-type="null">null</td>
|
|
<td data-type="b">0</td>
|
|
<td data-type="invalid-datatype">text with invalid datatype</td>
|
|
</tr>
|
|
</table>';
|
|
|
|
$reader = new Html();
|
|
$spreadsheet = $reader->loadFromString($html);
|
|
$firstSheet = $spreadsheet->getSheet(0);
|
|
|
|
// check boolean data type and true
|
|
self::assertSame(DataType::TYPE_BOOL, $firstSheet->getCell('A1')->getDataType());
|
|
self::assertIsBool($firstSheet->getCell('A1')->getValue());
|
|
self::assertTrue($firstSheet->getCell('A1')->getValue());
|
|
|
|
// check string data type
|
|
self::assertSame(DataType::TYPE_STRING, $firstSheet->getCell('B1')->getDataType());
|
|
self::assertIsString($firstSheet->getCell('B1')->getValue());
|
|
|
|
// check string with beginning equal sign (=B1) and string datatype,is not formula
|
|
self::assertSame(DataType::TYPE_STRING, $firstSheet->getCell('C1')->getDataType());
|
|
self::assertSame('=B1', $firstSheet->getCell('C1')->getValue());
|
|
self::assertTrue($firstSheet->getCell('C1')->getStyle()->getQuotePrefix());
|
|
|
|
//check iso date
|
|
self::assertEqualsWithDelta($firstSheet->getCell('D1')->getValue(), 44613.43090277778, 1.0e-12);
|
|
|
|
//null
|
|
self::assertNull($firstSheet->getCell('E1')->getValue());
|
|
|
|
// check boolean data type and true
|
|
self::assertSame(DataType::TYPE_BOOL, $firstSheet->getCell('F1')->getDataType());
|
|
self::assertIsBool($firstSheet->getCell('F1')->getValue());
|
|
self::assertFalse($firstSheet->getCell('F1')->getValue());
|
|
|
|
self::assertSame(DataType::TYPE_STRING, $firstSheet->getCell('G1')->getDataType());
|
|
self::assertSame('text with invalid datatype', $firstSheet->getCell('G1')->getValue());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
}
|