RTL Text Alignment in Xlsx Comment

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>
```
This commit is contained in:
oleibman
2024-04-30 22:22:03 -07:00
parent 35030fa66d
commit 455f1129bf
5 changed files with 67 additions and 2 deletions
+10
View File
@@ -1132,6 +1132,7 @@ class Xlsx extends BaseReader
$fillColor = strtoupper(substr((string) $shape['fillcolor'], 1));
$column = null;
$row = null;
$textHAlign = null;
$fillImageRelId = null;
$fillImageTitle = '';
@@ -1149,8 +1150,17 @@ class Xlsx extends BaseReader
if (is_array($temp)) {
$column = $temp[0];
}
$temp = $clientData->xpath('.//x:TextHAlign');
if (!empty($temp)) {
$textHAlign = $temp[0];
}
}
}
$rowx = (string) $row;
$colx = (string) $column;
if (is_numeric($rowx) && is_numeric($colx) && $textHAlign !== null) {
$docSheet->getComment([1 + (int) $colx, 1 + (int) $rowx], false)->setAlignment((string) $textHAlign);
}
$fillImageRelNode = $shape->xpath('.//v:fill/@o:relid');
if (is_array($fillImageRelNode) && !empty($fillImageRelNode)) {
+4 -2
View File
@@ -2626,7 +2626,7 @@ class Worksheet implements IComparable
* @param array{0: int, 1: int}|CellAddress|string $cellCoordinate Coordinate of the cell as a string, eg: 'C5';
* or as an array of [$columnIndex, $row] (e.g. [3, 5]), or a CellAddress object.
*/
public function getComment(CellAddress|string|array $cellCoordinate): Comment
public function getComment(CellAddress|string|array $cellCoordinate, bool $attachNew = true): Comment
{
$cellAddress = Functions::trimSheetFromCellReference(Validations::validateCellAddress($cellCoordinate));
@@ -2645,7 +2645,9 @@ class Worksheet implements IComparable
// If not, create a new comment.
$newComment = new Comment();
$this->comments[$cellAddress] = $newComment;
if ($attachNew) {
$this->comments[$cellAddress] = $newComment;
}
return $newComment;
}
@@ -6,9 +6,18 @@ use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Comment;
use PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces;
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
use PhpOffice\PhpSpreadsheet\Style\Alignment;
class Comments extends WriterPart
{
private const VALID_HORIZONTAL_ALIGNMENT = [
Alignment::HORIZONTAL_CENTER,
Alignment::HORIZONTAL_DISTRIBUTED,
Alignment::HORIZONTAL_JUSTIFY,
Alignment::HORIZONTAL_LEFT,
Alignment::HORIZONTAL_RIGHT,
];
/**
* Write comments to XML format.
*
@@ -223,6 +232,12 @@ class Comments extends WriterPart
// x:AutoFill
$objWriter->writeElement('x:AutoFill', 'False');
// x:TextHAlign horizontal alignment of text
$alignment = strtolower($comment->getAlignment());
if (in_array($alignment, self::VALID_HORIZONTAL_ALIGNMENT, true)) {
$objWriter->writeElement('x:TextHAlign', ucfirst($alignment));
}
// x:Row
$objWriter->writeElement('x:Row', (string) ($row - 1));
@@ -96,5 +96,6 @@ class CommentTest extends TestCase
self::assertArrayHasKey('A2', $comments1);
$sheet->removeComment('A2');
self::assertEmpty($sheet->getComments());
$spreadsheet->disconnectWorksheets();
}
}
@@ -0,0 +1,37 @@
<?php
declare(strict_types=1);
namespace PhpOffice\PhpSpreadsheetTests\Writer\Xlsx;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Style\Alignment;
use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional;
class CommentAlignmentTest extends AbstractFunctional
{
public function testIssue4004(): void
{
$type = 'Xlsx';
$spreadsheet = new Spreadsheet();
$sheet = $spreadsheet->getActiveSheet();
$sheet->getComment('A3')->getText()->createText('Comment');
$sheet->getComment('A4')->getText()->createText('שלום');
$sheet->getComment('A4')->setAlignment(Alignment::HORIZONTAL_RIGHT);
$reloadedSpreadsheet = $this->writeAndReload($spreadsheet, $type);
$spreadsheet->disconnectWorksheets();
self::assertCount(1, $reloadedSpreadsheet->getAllSheets());
$rsheet = $reloadedSpreadsheet->getActiveSheet();
$comment1 = $rsheet->getComment('A3');
self::assertSame('Comment', $comment1->getText()->getPlainText());
self::assertSame('general', $comment1->getAlignment());
$comment2 = $rsheet->getComment('A4');
self::assertSame('שלום', $comment2->getText()->getPlainText());
self::assertSame('Right', $comment2->getAlignment());
$reloadedSpreadsheet->disconnectWorksheets();
}
}