mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-08-25 15:08:19 +00:00
oleibman
cd84020693
* Xlsx Reader Better Namespace Handling Phase 1 Try2 This is a replacement for #2088, which has run into merge conflicts. I will close that PR in the near future, however the comments in that PR may prove useful for this one. While that PR has been in draft status all along, I am marking this one as ready. I will gladly add additional tests (and, of course, make code changes) that anyone has to suggest, but, with my most recent test files which I will describe in a separate comment, I have no further ideas on useful additions. As mentioned in the earlier ticket, this is a risky change. But, as has been demonstrated, delaying it comes with its own set of risks. It would be helpful to have a temporary moratorium on changes to Reader/Xlsx until this change is merged. The original commit message follows. There have been a number of issues concerning the handling of legitimate but unexpected namespace prefixes in Xlsx spreadsheets created by software other than Excel and PhpSpreadsheet/PhpExcel.I have studied them, but, till now, have not had a good idea on how to act on them. A recent comment https://github.com/PHPOffice/PhpSpreadsheet/issues/860#issuecomment-824926224 in issue #860 by @IMSoP has triggered an idea about how to proceed. Gnumeric Reader was recently changed to handle namespaces better. Using that as a model, this PR begins the process of doing the same for Xlsx. Xlsx is much larger and more complicated than Gnumeric, hence the need to tackle it in multiple phases. I believe that this PR handles all of: - listWorkSheetNames - listWorkSheetInfo. Note that there was a bug in this function which would cause it to count only used columns rather than all columns. That bug is corrected. - active sheet - selected cell and top left cell - cell content (formulas, numbers, text) - hyperlinks - comments (partial - see below) This PR does not address: - styles - images and charts - VBA and ribbons - many other items, I'm sure The issue for non-standard namespacing till now has been the use of unexpected prefixes. While I was working on this change, @Lambik introduced issue #2067 PR #2068 which introduced a completely different problem - the use of unexpected URLs. That PR and the issue associated with it were quite well documented, including the supplying of a test file and tests for it. I asked if I could take a look to see if it could be integrated with my change, and the result seems to be yes, so those changes are also part of this PR. While adding a comment to my test file, I discovered that Microsoft had added "threaded comments" as a new feature. I believe these are not yet supported by PhpSpreadsheet, and I am not going to add it, at least not now. I believe that, among other things, this will make identifying the author of a comment more difficult. Although there are a number of Phpstan baseline changes as part of this PR, I did not attempt to resolve all Phpstan reports for Reader/Xlsx. Nor did I do anything to increase coverage. This change is already large and complex enough without those efforts.
81 lines
2.2 KiB
PHP
81 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;
|
|
|
|
use PhpOffice\PhpSpreadsheet\Reader\Xlsx;
|
|
use PhpOffice\PhpSpreadsheet\Shared\File;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class WorksheetInfoNamesTest extends TestCase
|
|
{
|
|
public function testListWorksheetInfo(): void
|
|
{
|
|
$filename = 'tests/data/Reader/XLSX/rowColumnAttributeTest.xlsx';
|
|
$reader = new Xlsx();
|
|
$actual = $reader->listWorksheetInfo($filename);
|
|
|
|
$expected = [
|
|
[
|
|
'worksheetName' => 'Sheet1',
|
|
'lastColumnLetter' => 'F',
|
|
'lastColumnIndex' => 5,
|
|
'totalRows' => '6',
|
|
'totalColumns' => 6,
|
|
],
|
|
];
|
|
|
|
self::assertEquals($expected, $actual);
|
|
}
|
|
|
|
public function testListWorksheetInfoNamespace(): void
|
|
{
|
|
$filename = 'tests/data/Reader/XLSX/namespaces.xlsx';
|
|
$file = 'zip://';
|
|
$file .= $filename;
|
|
$file .= '#xl/workbook.xml';
|
|
$data = file_get_contents($file);
|
|
// confirm that file contains expected namespaced xml tag
|
|
if ($data === false) {
|
|
self::fail('Unable to read file');
|
|
} else {
|
|
self::assertStringContainsString('<x:workbook ', $data);
|
|
}
|
|
$reader = new Xlsx();
|
|
$actual = $reader->listWorksheetInfo($filename);
|
|
|
|
$expected = [
|
|
[
|
|
'worksheetName' => 'transactions',
|
|
'lastColumnLetter' => 'K',
|
|
'lastColumnIndex' => 10,
|
|
'totalRows' => 2,
|
|
'totalColumns' => 11,
|
|
],
|
|
];
|
|
|
|
self::assertEquals($expected, $actual);
|
|
}
|
|
|
|
public function testListWorksheetNames(): void
|
|
{
|
|
$filename = 'tests/data/Reader/XLSX/rowColumnAttributeTest.xlsx';
|
|
$reader = new Xlsx();
|
|
$actual = $reader->listWorksheetNames($filename);
|
|
|
|
$expected = ['Sheet1'];
|
|
|
|
self::assertEquals($expected, $actual);
|
|
}
|
|
|
|
public function testListWorksheetNamesNamespace(): void
|
|
{
|
|
$filename = 'tests/data/Reader/XLSX/namespaces.xlsx';
|
|
$reader = new Xlsx();
|
|
$actual = $reader->listWorksheetNames($filename);
|
|
|
|
$expected = ['transactions'];
|
|
|
|
self::assertEquals($expected, $actual);
|
|
}
|
|
}
|