• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

PHPOffice / PhpSpreadsheet / 17663639262

12 Sep 2025 03:26AM UTC coverage: 95.297% (-0.001%) from 95.298%
17663639262

Pull #4641

github

web-flow
Merge dc11b8ccc into 9b28b9e9c
Pull Request #4641: Proper Output for BASE Function

40307 of 42296 relevant lines covered (95.3%)

348.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.84
/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php
1
<?php
2

3
namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;
4

5
use PhpOffice\PhpSpreadsheet\Cell\Cell;
6
use PhpOffice\PhpSpreadsheet\Cell\DataType;
7
use PhpOffice\PhpSpreadsheet\Chart\ChartColor;
8
use PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces;
9
use PhpOffice\PhpSpreadsheet\RichText\RichText;
10
use PhpOffice\PhpSpreadsheet\RichText\Run;
11
use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
12
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
13
use PhpOffice\PhpSpreadsheet\Style\Font;
14
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet as ActualWorksheet;
15

16
class StringTable extends WriterPart
17
{
18
    /**
19
     * Create worksheet stringtable.
20
     *
21
     * @param string[] $existingTable Existing table to eventually merge with
22
     *
23
     * @return string[] String table for worksheet
24
     */
25
    public function createStringTable(ActualWorksheet $worksheet, ?array $existingTable = null): array
26
    {
27
        // Create string lookup table
28
        /** @var string[] */
29
        $aStringTable = $existingTable ?? [];
399✔
30

31
        // Fill index array
32
        $aFlippedStringTable = $this->flipStringTable($aStringTable);
399✔
33

34
        // Loop through cells
35
        foreach ($worksheet->getCellCollection()->getCoordinates() as $coordinate) {
399✔
36
            /** @var Cell $cell */
37
            $cell = $worksheet->getCellCollection()->get($coordinate);
377✔
38
            /** @var null|int|RichText|string */
39
            $cellValue = $cell->getValue();
377✔
40
            if (
41
                !is_object($cellValue)
377✔
42
                && ($cellValue !== null)
377✔
43
                && $cellValue !== ''
377✔
44
                && ($cell->getDataType() == DataType::TYPE_STRING || $cell->getDataType() == DataType::TYPE_STRING2 || $cell->getDataType() == DataType::TYPE_NULL)
377✔
45
                && !isset($aFlippedStringTable[$cellValue])
377✔
46
            ) {
47
                $aStringTable[] = $cellValue;
246✔
48
                $aFlippedStringTable[$cellValue] = true;
246✔
49
            } elseif (
50
                $cellValue instanceof RichText
332✔
51
                && !isset($aFlippedStringTable[$cellValue->getHashCode()])
332✔
52
            ) {
53
                $aStringTable[] = $cellValue;
22✔
54
                $aFlippedStringTable[$cellValue->getHashCode()] = true;
22✔
55
            }
56
        }
57
        /** @var string[] $aStringTable */
58

59
        return $aStringTable;
399✔
60
    }
61

62
    /**
63
     * Write string table to XML format.
64
     *
65
     * @param (RichText|string)[] $stringTable
66
     *
67
     * @return string XML Output
68
     */
69
    public function writeStringTable(array $stringTable): string
70
    {
71
        // Create XML writer
72
        $objWriter = null;
399✔
73
        if ($this->getParentWriter()->getUseDiskCaching()) {
399✔
74
            $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
×
75
        } else {
76
            $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
399✔
77
        }
78

79
        // XML header
80
        $objWriter->startDocument('1.0', 'UTF-8', 'yes');
399✔
81

82
        // String table
83
        $objWriter->startElement('sst');
399✔
84
        $objWriter->writeAttribute('xmlns', Namespaces::MAIN);
399✔
85
        $objWriter->writeAttribute('uniqueCount', (string) count($stringTable));
399✔
86

87
        // Loop through string table
88
        foreach ($stringTable as $textElement) {
399✔
89
            $objWriter->startElement('si');
251✔
90

91
            if (!($textElement instanceof RichText)) {
251✔
92
                $textToWrite = StringHelper::controlCharacterPHP2OOXML($textElement);
246✔
93
                $objWriter->startElement('t');
246✔
94
                if ($textToWrite !== trim($textToWrite)) {
246✔
95
                    $objWriter->writeAttribute('xml:space', 'preserve');
10✔
96
                }
97
                $objWriter->writeRawData($textToWrite);
246✔
98
                $objWriter->endElement();
246✔
99
            } else {
100
                $this->writeRichText($objWriter, $textElement);
22✔
101
            }
102

103
            $objWriter->endElement();
251✔
104
        }
105

106
        $objWriter->endElement();
399✔
107

108
        return $objWriter->getData();
399✔
109
    }
110

111
    /**
112
     * Write Rich Text.
113
     *
114
     * @param ?string $prefix Optional Namespace prefix
115
     */
116
    public function writeRichText(XMLWriter $objWriter, RichText $richText, ?string $prefix = null, ?Font $defaultFont = null): void
117
    {
118
        if ($prefix !== null) {
39✔
119
            $prefix .= ':';
×
120
        }
121

122
        // Loop through rich text elements
123
        $elements = $richText->getRichTextElements();
39✔
124
        foreach ($elements as $element) {
39✔
125
            // r
126
            $objWriter->startElement($prefix . 'r');
36✔
127
            $font = ($element instanceof Run) ? $element->getFont() : $defaultFont;
36✔
128

129
            // rPr
130
            if ($font !== null) {
36✔
131
                // rPr
132
                $objWriter->startElement($prefix . 'rPr');
25✔
133

134
                // rFont
135
                if ($font->getName() !== null) {
25✔
136
                    $objWriter->startElement($prefix . 'rFont');
25✔
137
                    $objWriter->writeAttribute('val', $font->getName());
25✔
138
                    $objWriter->endElement();
25✔
139
                }
140

141
                // Bold
142
                $objWriter->startElement($prefix . 'b');
25✔
143
                $objWriter->writeAttribute('val', ($font->getBold() ? 'true' : 'false'));
25✔
144
                $objWriter->endElement();
25✔
145

146
                // Italic
147
                $objWriter->startElement($prefix . 'i');
25✔
148
                $objWriter->writeAttribute('val', ($font->getItalic() ? 'true' : 'false'));
25✔
149
                $objWriter->endElement();
25✔
150

151
                // Superscript / subscript
152
                if ($font->getSuperscript() || $font->getSubscript()) {
25✔
153
                    $objWriter->startElement($prefix . 'vertAlign');
1✔
154
                    if ($font->getSuperscript()) {
1✔
155
                        $objWriter->writeAttribute('val', 'superscript');
1✔
156
                    } elseif ($font->getSubscript()) {
1✔
157
                        $objWriter->writeAttribute('val', 'subscript');
1✔
158
                    }
159
                    $objWriter->endElement();
1✔
160
                }
161

162
                // Strikethrough
163
                $objWriter->startElement($prefix . 'strike');
25✔
164
                $objWriter->writeAttribute('val', ($font->getStrikethrough() ? 'true' : 'false'));
25✔
165
                $objWriter->endElement();
25✔
166

167
                // Color
168
                if ($font->getColor()->getARGB() !== null) {
25✔
169
                    $objWriter->startElement($prefix . 'color');
25✔
170
                    $objWriter->writeAttribute('rgb', $font->getColor()->getARGB());
25✔
171
                    $objWriter->endElement();
25✔
172
                }
173

174
                // Size
175
                if ($font->getSize() !== null) {
25✔
176
                    $objWriter->startElement($prefix . 'sz');
25✔
177
                    $objWriter->writeAttribute('val', (string) $font->getSize());
25✔
178
                    $objWriter->endElement();
25✔
179
                }
180

181
                // Underline
182
                if ($font->getUnderline() !== null) {
25✔
183
                    $objWriter->startElement($prefix . 'u');
25✔
184
                    $objWriter->writeAttribute('val', $font->getUnderline());
25✔
185
                    $objWriter->endElement();
25✔
186
                }
187

188
                $objWriter->endElement();
25✔
189
            }
190

191
            // t
192
            $objWriter->startElement($prefix . 't');
36✔
193
            $objWriter->writeAttribute('xml:space', 'preserve');
36✔
194
            $objWriter->writeRawData(StringHelper::controlCharacterPHP2OOXML($element->getText()));
36✔
195
            $objWriter->endElement();
36✔
196

197
            $objWriter->endElement();
36✔
198
        }
199
    }
200

201
    /**
202
     * Write Rich Text.
203
     *
204
     * @param RichText|string $richText text string or Rich text
205
     * @param string $prefix Optional Namespace prefix
206
     */
207
    public function writeRichTextForCharts(XMLWriter $objWriter, $richText = null, string $prefix = ''): void
208
    {
209
        if (!($richText instanceof RichText)) {
83✔
210
            $textRun = $richText;
50✔
211
            $richText = new RichText();
50✔
212
            $run = $richText->createTextRun($textRun ?? '');
50✔
213
            $run->setFont(null);
50✔
214
        }
215

216
        if ($prefix !== '') {
83✔
217
            $prefix .= ':';
83✔
218
        }
219

220
        // Loop through rich text elements
221
        $elements = $richText->getRichTextElements();
83✔
222
        foreach ($elements as $element) {
83✔
223
            // r
224
            $objWriter->startElement($prefix . 'r');
83✔
225
            if ($element->getFont() !== null) {
83✔
226
                // rPr
227
                $objWriter->startElement($prefix . 'rPr');
28✔
228
                $fontSize = $element->getFont()->getSize();
28✔
229
                if (is_numeric($fontSize)) {
28✔
230
                    $fontSize *= (($fontSize < 100) ? 100 : 1);
22✔
231
                    $objWriter->writeAttribute('sz', (string) $fontSize);
22✔
232
                }
233

234
                // Bold
235
                $objWriter->writeAttribute('b', ($element->getFont()->getBold() ? '1' : '0'));
28✔
236
                // Italic
237
                $objWriter->writeAttribute('i', ($element->getFont()->getItalic() ? '1' : '0'));
28✔
238
                // Underline
239
                $underlineType = $element->getFont()->getUnderline();
28✔
240
                switch ($underlineType) {
241
                    case 'single':
28✔
242
                        $underlineType = 'sng';
6✔
243

244
                        break;
6✔
245
                    case 'double':
28✔
246
                        $underlineType = 'dbl';
5✔
247

248
                        break;
5✔
249
                }
250
                if ($underlineType !== null) {
28✔
251
                    $objWriter->writeAttribute('u', $underlineType);
28✔
252
                }
253
                // Strikethrough
254
                $objWriter->writeAttribute('strike', ($element->getFont()->getStriketype() ?: 'noStrike'));
28✔
255
                // Superscript/subscript
256
                if ($element->getFont()->getBaseLine()) {
28✔
257
                    $objWriter->writeAttribute('baseline', (string) $element->getFont()->getBaseLine());
5✔
258
                }
259

260
                // Color
261
                $this->writeChartTextColor($objWriter, $element->getFont()->getChartColor(), $prefix);
28✔
262

263
                // Underscore Color
264
                $this->writeChartTextColor($objWriter, $element->getFont()->getUnderlineColor(), $prefix, 'uFill');
28✔
265

266
                // fontName
267
                if ($element->getFont()->getLatin()) {
28✔
268
                    $objWriter->startElement($prefix . 'latin');
23✔
269
                    $objWriter->writeAttribute('typeface', $element->getFont()->getLatin());
23✔
270
                    $objWriter->endElement();
23✔
271
                }
272
                if ($element->getFont()->getEastAsian()) {
28✔
273
                    $objWriter->startElement($prefix . 'ea');
21✔
274
                    $objWriter->writeAttribute('typeface', $element->getFont()->getEastAsian());
21✔
275
                    $objWriter->endElement();
21✔
276
                }
277
                if ($element->getFont()->getComplexScript()) {
28✔
278
                    $objWriter->startElement($prefix . 'cs');
21✔
279
                    $objWriter->writeAttribute('typeface', $element->getFont()->getComplexScript());
21✔
280
                    $objWriter->endElement();
21✔
281
                }
282

283
                $objWriter->endElement();
28✔
284
            }
285

286
            // t
287
            $objWriter->startElement($prefix . 't');
83✔
288
            $objWriter->writeRawData(StringHelper::controlCharacterPHP2OOXML($element->getText()));
83✔
289
            $objWriter->endElement();
83✔
290

291
            $objWriter->endElement();
83✔
292
        }
293
    }
294

295
    private function writeChartTextColor(XMLWriter $objWriter, ?ChartColor $underlineColor, string $prefix, ?string $openTag = ''): void
296
    {
297
        if ($underlineColor !== null) {
28✔
298
            $type = $underlineColor->getType();
22✔
299
            $value = $underlineColor->getValue();
22✔
300
            if (!empty($type) && !empty($value)) {
22✔
301
                if ($openTag !== '') {
17✔
302
                    $objWriter->startElement($prefix . $openTag);
5✔
303
                }
304
                $objWriter->startElement($prefix . 'solidFill');
17✔
305
                $objWriter->startElement($prefix . $type);
17✔
306
                $objWriter->writeAttribute('val', $value);
17✔
307
                $alpha = $underlineColor->getAlpha();
17✔
308
                if (is_numeric($alpha)) {
17✔
309
                    $objWriter->startElement('a:alpha');
×
310
                    $objWriter->writeAttribute('val', ChartColor::alphaToXml((int) $alpha));
×
311
                    $objWriter->endElement();
×
312
                }
313
                $objWriter->endElement(); // srgbClr/schemeClr/prstClr
17✔
314
                $objWriter->endElement(); // solidFill
17✔
315
                if ($openTag !== '') {
17✔
316
                    $objWriter->endElement(); // uFill
5✔
317
                }
318
            }
319
        }
320
    }
321

322
    /**
323
     * Flip string table (for index searching).
324
     *
325
     * @param array<RichText|string> $stringTable Stringtable
326
     *
327
     * @return array<RichText|string>
328
     */
329
    public function flipStringTable(array $stringTable): array
330
    {
331
        // Return value
332
        $returnValue = [];
466✔
333

334
        // Loop through stringtable and add flipped items to $returnValue
335
        foreach ($stringTable as $key => $value) {
466✔
336
            if (!$value instanceof RichText) {
250✔
337
                $returnValue[$value] = $key;
245✔
338
            } elseif ($value instanceof RichText) {
22✔
339
                $returnValue[$value->getHashCode()] = $key;
22✔
340
            }
341
        }
342

343
        return $returnValue;
466✔
344
    }
345
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc