mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-08-20 06:50:43 +00:00
oleibman
455f1129bf
Fix #4004. RTL text can be included in a comment, and will display correctly, but the comment as a whole will be left-aligned. There already exists an `alignment` property for Comment, but it is unused. This PR will allow that property to be set, and to be read from and written to an Xlsx spreadsheet when possible. The Xml tags that govern this property are found, unusually, in a drawing Vml file. The important property is `x:TextHAlign`, which can be set to Left, Right, Center, Justified, or Distributed. There are other tags which seemed like they were relevant to this problem, but I don't think they actually matter: ```xml <v:textbox style='mso-direction-alt:auto'> <div style='text-align:right;direction:rtl'></div> </v:textbox> ```
102 lines
3.3 KiB
PHP
102 lines
3.3 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpOffice\PhpSpreadsheetTests;
|
|
|
|
use PhpOffice\PhpSpreadsheet\Comment;
|
|
use PhpOffice\PhpSpreadsheet\RichText\RichText;
|
|
use PhpOffice\PhpSpreadsheet\RichText\TextElement;
|
|
use PhpOffice\PhpSpreadsheet\Spreadsheet;
|
|
use PhpOffice\PhpSpreadsheet\Style\Alignment;
|
|
use PhpOffice\PhpSpreadsheet\Style\Color;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class CommentTest extends TestCase
|
|
{
|
|
public function testCreateComment(): void
|
|
{
|
|
$comment = new Comment();
|
|
self::assertEquals('Author', $comment->getAuthor());
|
|
self::assertEquals('96pt', $comment->getWidth());
|
|
self::assertEquals('59.25pt', $comment->getMarginLeft());
|
|
self::assertEquals('1.5pt', $comment->getMarginTop());
|
|
self::assertEquals('55.5pt', $comment->getHeight());
|
|
self::assertInstanceOf(Color::class, $comment->getFillColor());
|
|
self::assertEquals('FFFFFFE1', $comment->getFillColor()->getARGB());
|
|
self::assertInstanceOf(RichText::class, $comment->getText());
|
|
self::assertEquals(Alignment::HORIZONTAL_GENERAL, $comment->getAlignment());
|
|
self::assertFalse($comment->getVisible());
|
|
}
|
|
|
|
public function testSetAuthor(): void
|
|
{
|
|
$comment = new Comment();
|
|
$comment->setAuthor('Mark Baker');
|
|
self::assertEquals('Mark Baker', $comment->getAuthor());
|
|
}
|
|
|
|
public function testSetMarginLeft(): void
|
|
{
|
|
$comment = new Comment();
|
|
$comment->setMarginLeft('20pt');
|
|
self::assertEquals('20pt', $comment->getMarginLeft());
|
|
}
|
|
|
|
public function testSetMarginTop(): void
|
|
{
|
|
$comment = new Comment();
|
|
$comment->setMarginTop('2.5pt');
|
|
self::assertEquals('2.5pt', $comment->getMarginTop());
|
|
}
|
|
|
|
public function testSetWidth(): void
|
|
{
|
|
$comment = new Comment();
|
|
$comment->setWidth('120pt');
|
|
self::assertEquals('120pt', $comment->getWidth());
|
|
}
|
|
|
|
public function testSetHeight(): void
|
|
{
|
|
$comment = new Comment();
|
|
$comment->setHeight('60px');
|
|
self::assertEquals('60px', $comment->getHeight());
|
|
}
|
|
|
|
public function testSetFillColor(): void
|
|
{
|
|
$comment = new Comment();
|
|
$comment->setFillColor(new Color('RED'));
|
|
self::assertEquals(Color::COLOR_RED, $comment->getFillColor()->getARGB());
|
|
}
|
|
|
|
public function testSetAlignment(): void
|
|
{
|
|
$comment = new Comment();
|
|
$comment->setAlignment(Alignment::HORIZONTAL_CENTER);
|
|
self::assertEquals(Alignment::HORIZONTAL_CENTER, $comment->getAlignment());
|
|
}
|
|
|
|
public function testSetText(): void
|
|
{
|
|
$comment = new Comment();
|
|
$test = new RichText();
|
|
$test->addText(new TextElement('This is a test comment'));
|
|
$comment->setText($test);
|
|
self::assertEquals('This is a test comment', (string) $comment);
|
|
}
|
|
|
|
public function testRemoveComment(): void
|
|
{
|
|
$spreadsheet = new Spreadsheet();
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$sheet->getComment('A2')->getText()->createText('Comment to delete');
|
|
$comments1 = $sheet->getComments();
|
|
self::assertArrayHasKey('A2', $comments1);
|
|
$sheet->removeComment('A2');
|
|
self::assertEmpty($sheet->getComments());
|
|
$spreadsheet->disconnectWorksheets();
|
|
}
|
|
}
|