|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace PhpOffice\PhpSpreadsheetTests\Worksheet; |
|
4
|
|
|
|
|
5
|
|
|
use PhpOffice\PhpSpreadsheet\Spreadsheet; |
|
6
|
|
|
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; |
|
7
|
|
|
use PHPUnit\Framework\TestCase; |
|
8
|
|
|
|
|
9
|
|
|
class WorksheetTest extends TestCase |
|
10
|
|
|
{ |
|
11
|
|
|
public function testSetTitle() |
|
12
|
|
|
{ |
|
13
|
|
|
$testTitle = str_repeat('a', 31); |
|
14
|
|
|
|
|
15
|
|
|
$worksheet = new Worksheet(); |
|
16
|
|
|
$worksheet->setTitle($testTitle); |
|
17
|
|
|
self::assertSame($testTitle, $worksheet->getTitle()); |
|
18
|
|
|
} |
|
19
|
|
|
|
|
20
|
|
|
public function setTitleInvalidProvider() |
|
21
|
|
|
{ |
|
22
|
|
|
return [ |
|
23
|
|
|
[str_repeat('a', 32), 'Maximum 31 characters allowed in sheet title.'], |
|
24
|
|
|
['invalid*title', 'Invalid character found in sheet title'], |
|
25
|
|
|
]; |
|
26
|
|
|
} |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* @param string $title |
|
30
|
|
|
* @param string $expectMessage |
|
31
|
|
|
* @dataProvider setTitleInvalidProvider |
|
32
|
|
|
*/ |
|
33
|
|
|
public function testSetTitleInvalid($title, $expectMessage) |
|
34
|
|
|
{ |
|
35
|
|
|
// First, test setting title with validation disabled -- should be successful |
|
36
|
|
|
$worksheet = new Worksheet(); |
|
37
|
|
|
$worksheet->setTitle($title, true, false); |
|
38
|
|
|
|
|
39
|
|
|
// Next, test again with validation enabled -- this time we should fail |
|
40
|
|
|
$worksheet = new Worksheet(); |
|
41
|
|
|
$this->expectException(\Exception::class); |
|
42
|
|
|
$this->expectExceptionMessage($expectMessage); |
|
43
|
|
|
$worksheet->setTitle($title); |
|
44
|
|
|
} |
|
45
|
|
|
|
|
46
|
|
|
public function testSetTitleDuplicate() |
|
47
|
|
|
{ |
|
48
|
|
|
// Create a Spreadsheet with three Worksheets (the first is created automatically) |
|
49
|
|
|
$spreadsheet = new Spreadsheet(); |
|
50
|
|
|
$spreadsheet->createSheet(); |
|
51
|
|
|
$spreadsheet->createSheet(); |
|
52
|
|
|
|
|
53
|
|
|
// Set unique title -- should be unchanged |
|
54
|
|
|
$sheet = $spreadsheet->getSheet(0); |
|
55
|
|
|
$sheet->setTitle('Test Title'); |
|
56
|
|
|
self::assertSame('Test Title', $sheet->getTitle()); |
|
57
|
|
|
|
|
58
|
|
|
// Set duplicate title -- should have numeric suffix appended |
|
59
|
|
|
$sheet = $spreadsheet->getSheet(1); |
|
60
|
|
|
$sheet->setTitle('Test Title'); |
|
61
|
|
|
self::assertSame('Test Title 1', $sheet->getTitle()); |
|
62
|
|
|
|
|
63
|
|
|
// Set duplicate title with validation disabled -- should be unchanged |
|
64
|
|
|
$sheet = $spreadsheet->getSheet(2); |
|
65
|
|
|
$sheet->setTitle('Test Title', true, false); |
|
66
|
|
|
self::assertSame('Test Title', $sheet->getTitle()); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
public function testSetCodeName() |
|
70
|
|
|
{ |
|
71
|
|
|
$testCodeName = str_repeat('a', 31); |
|
72
|
|
|
|
|
73
|
|
|
$worksheet = new Worksheet(); |
|
74
|
|
|
$worksheet->setCodeName($testCodeName); |
|
75
|
|
|
self::assertSame($testCodeName, $worksheet->getCodeName()); |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
public function setCodeNameInvalidProvider() |
|
79
|
|
|
{ |
|
80
|
|
|
return [ |
|
81
|
|
|
[str_repeat('a', 32), 'Maximum 31 characters allowed in sheet code name.'], |
|
82
|
|
|
['invalid*code*name', 'Invalid character found in sheet code name'], |
|
83
|
|
|
]; |
|
84
|
|
|
} |
|
85
|
|
|
|
|
86
|
|
|
/** |
|
87
|
|
|
* @param string $codeName |
|
88
|
|
|
* @param string $expectMessage |
|
89
|
|
|
* @dataProvider setCodeNameInvalidProvider |
|
90
|
|
|
*/ |
|
91
|
|
|
public function testSetCodeNameInvalid($codeName, $expectMessage) |
|
92
|
|
|
{ |
|
93
|
|
|
// First, test setting code name with validation disabled -- should be successful |
|
94
|
|
|
$worksheet = new Worksheet(); |
|
95
|
|
|
$worksheet->setCodeName($codeName, false); |
|
96
|
|
|
|
|
97
|
|
|
// Next, test again with validation enabled -- this time we should fail |
|
98
|
|
|
$worksheet = new Worksheet(); |
|
99
|
|
|
$this->expectException(\Exception::class); |
|
100
|
|
|
$this->expectExceptionMessage($expectMessage); |
|
101
|
|
|
$worksheet->setCodeName($codeName); |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
public function testSetCodeNameDuplicate() |
|
105
|
|
|
{ |
|
106
|
|
|
// Create a Spreadsheet with three Worksheets (the first is created automatically) |
|
107
|
|
|
$spreadsheet = new Spreadsheet(); |
|
108
|
|
|
$spreadsheet->createSheet(); |
|
109
|
|
|
$spreadsheet->createSheet(); |
|
110
|
|
|
|
|
111
|
|
|
// Set unique code name -- should be massaged to Snake_Case |
|
112
|
|
|
$sheet = $spreadsheet->getSheet(0); |
|
113
|
|
|
$sheet->setCodeName('Test Code Name'); |
|
114
|
|
|
self::assertSame('Test_Code_Name', $sheet->getCodeName()); |
|
115
|
|
|
|
|
116
|
|
|
// Set duplicate code name -- should be massaged and have numeric suffix appended |
|
117
|
|
|
$sheet = $spreadsheet->getSheet(1); |
|
118
|
|
|
$sheet->setCodeName('Test Code Name'); |
|
119
|
|
|
self::assertSame('Test_Code_Name_1', $sheet->getCodeName()); |
|
120
|
|
|
|
|
121
|
|
|
// Set duplicate code name with validation disabled -- should be unchanged, and unmassaged |
|
122
|
|
|
$sheet = $spreadsheet->getSheet(2); |
|
123
|
|
|
$sheet->setCodeName('Test Code Name', false); |
|
124
|
|
|
self::assertSame('Test Code Name', $sheet->getCodeName()); |
|
125
|
|
|
} |
|
126
|
|
|
|
|
127
|
|
|
public function testFreezePaneSelectedCell() |
|
128
|
|
|
{ |
|
129
|
|
|
$worksheet = new Worksheet(); |
|
130
|
|
|
$worksheet->freezePane('B2'); |
|
131
|
|
|
self::assertSame('B2', $worksheet->getTopLeftCell()); |
|
132
|
|
|
} |
|
133
|
|
|
} |
|
134
|
|
|
|
PHPOffice /
PhpSpreadsheet
