Passed
Pull Request — master (#4369)
by Owen
12:10
created

StringTable::writeRichText()   C

Complexity

Conditions 16
Paths 132

Size

Total Lines 81
Code Lines 45

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 40
CRAP Score 16.0036

Importance

Changes 0
Metric Value
eloc 45
dl 0
loc 81
rs 5.3
c 0
b 0
f 0
ccs 40
cts 41
cp 0.9756
cc 16
nc 132
nop 3
crap 16.0036

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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\Worksheet\Worksheet as ActualWorksheet;
14
15
class StringTable extends WriterPart
16
{
17
    /**
18
     * Create worksheet stringtable.
19
     *
20
     * @param string[] $existingTable Existing table to eventually merge with
21
     *
22
     * @return string[] String table for worksheet
23
     */
24 371
    public function createStringTable(ActualWorksheet $worksheet, ?array $existingTable = null): array
25
    {
26
        // Create string lookup table
27 371
        $aStringTable = $existingTable ?? [];
28
29
        // Fill index array
30 371
        $aFlippedStringTable = $this->flipStringTable($aStringTable);
31 371
32
        // Loop through cells
33
        foreach ($worksheet->getCellCollection()->getCoordinates() as $coordinate) {
34
            /** @var Cell $cell */
35 371
            $cell = $worksheet->getCellCollection()->get($coordinate);
36
            $cellValue = $cell->getValue();
37
            if (
38 371
                !is_object($cellValue)
39
                && ($cellValue !== null)
40 351
                && $cellValue !== ''
41 351
                && ($cell->getDataType() == DataType::TYPE_STRING || $cell->getDataType() == DataType::TYPE_STRING2 || $cell->getDataType() == DataType::TYPE_NULL)
42
                && !isset($aFlippedStringTable[$cellValue])
43 351
            ) {
44 351
                $aStringTable[] = $cellValue;
45 351
                $aFlippedStringTable[$cellValue] = true;
46 351
            } elseif (
47 351
                $cellValue instanceof RichText
48
                && !isset($aFlippedStringTable[$cellValue->getHashCode()])
49 231
            ) {
50 231
                $aStringTable[] = $cellValue;
51
                $aFlippedStringTable[$cellValue->getHashCode()] = true;
52 311
            }
53 311
        }
54 311
55
        return $aStringTable;
56 19
    }
57 19
58
    /**
59
     * Write string table to XML format.
60
     *
61 371
     * @param (RichText|string)[] $stringTable
62
     *
63
     * @return string XML Output
64
     */
65
    public function writeStringTable(array $stringTable): string
66
    {
67
        // Create XML writer
68
        $objWriter = null;
69
        if ($this->getParentWriter()->getUseDiskCaching()) {
70
            $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
71 371
        } else {
72
            $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
73
        }
74 371
75 371
        // XML header
76
        $objWriter->startDocument('1.0', 'UTF-8', 'yes');
77
78 371
        // String table
79
        $objWriter->startElement('sst');
80
        $objWriter->writeAttribute('xmlns', Namespaces::MAIN);
81
        $objWriter->writeAttribute('uniqueCount', (string) count($stringTable));
82 371
83
        // Loop through string table
84
        foreach ($stringTable as $textElement) {
85 371
            $objWriter->startElement('si');
86 371
87 371
            if (!($textElement instanceof RichText)) {
88
                $textToWrite = StringHelper::controlCharacterPHP2OOXML($textElement);
89
                $objWriter->startElement('t');
90 371
                if ($textToWrite !== trim($textToWrite)) {
91 234
                    $objWriter->writeAttribute('xml:space', 'preserve');
92
                }
93 234
                $objWriter->writeRawData($textToWrite);
94 231
                $objWriter->endElement();
95 231
            } else {
96 231
                $this->writeRichText($objWriter, $textElement);
97 8
            }
98
99 231
            $objWriter->endElement();
100 231
        }
101
102 19
        $objWriter->endElement();
103
104
        return $objWriter->getData();
105 234
    }
106
107
    /**
108 371
     * Write Rich Text.
109
     *
110 371
     * @param ?string $prefix Optional Namespace prefix
111
     */
112
    public function writeRichText(XMLWriter $objWriter, RichText $richText, ?string $prefix = null): void
113
    {
114
        if ($prefix !== null) {
115
            $prefix .= ':';
116
        }
117
118 36
        // Loop through rich text elements
119
        $elements = $richText->getRichTextElements();
120 36
        foreach ($elements as $element) {
121
            // r
122
            $objWriter->startElement($prefix . 'r');
123
124
            // rPr
125 36
            if ($element instanceof Run && $element->getFont() !== null) {
126 36
                // rPr
127
                $objWriter->startElement($prefix . 'rPr');
128 33
129
                // rFont
130
                if ($element->getFont()->getName() !== null) {
131 33
                    $objWriter->startElement($prefix . 'rFont');
132
                    $objWriter->writeAttribute('val', $element->getFont()->getName());
133 21
                    $objWriter->endElement();
134
                }
135
136 21
                // Bold
137 21
                $objWriter->startElement($prefix . 'b');
138 21
                $objWriter->writeAttribute('val', ($element->getFont()->getBold() ? 'true' : 'false'));
139 21
                $objWriter->endElement();
140
141
                // Italic
142
                $objWriter->startElement($prefix . 'i');
143 21
                $objWriter->writeAttribute('val', ($element->getFont()->getItalic() ? 'true' : 'false'));
144 21
                $objWriter->endElement();
145 21
146
                // Superscript / subscript
147
                if ($element->getFont()->getSuperscript() || $element->getFont()->getSubscript()) {
148 21
                    $objWriter->startElement($prefix . 'vertAlign');
149 21
                    if ($element->getFont()->getSuperscript()) {
150 21
                        $objWriter->writeAttribute('val', 'superscript');
151
                    } elseif ($element->getFont()->getSubscript()) {
152
                        $objWriter->writeAttribute('val', 'subscript');
153 21
                    }
154 1
                    $objWriter->endElement();
155 1
                }
156 1
157 1
                // Strikethrough
158 1
                $objWriter->startElement($prefix . 'strike');
159
                $objWriter->writeAttribute('val', ($element->getFont()->getStrikethrough() ? 'true' : 'false'));
160 1
                $objWriter->endElement();
161
162
                // Color
163
                if ($element->getFont()->getColor()->getARGB() !== null) {
164 21
                    $objWriter->startElement($prefix . 'color');
165 21
                    $objWriter->writeAttribute('rgb', $element->getFont()->getColor()->getARGB());
166 21
                    $objWriter->endElement();
167
                }
168
169 21
                // Size
170 21
                if ($element->getFont()->getSize() !== null) {
171 21
                    $objWriter->startElement($prefix . 'sz');
172 21
                    $objWriter->writeAttribute('val', (string) $element->getFont()->getSize());
173
                    $objWriter->endElement();
174
                }
175
176 21
                // Underline
177 21
                if ($element->getFont()->getUnderline() !== null) {
178 21
                    $objWriter->startElement($prefix . 'u');
179 21
                    $objWriter->writeAttribute('val', $element->getFont()->getUnderline());
180
                    $objWriter->endElement();
181
                }
182
183 21
                $objWriter->endElement();
184 21
            }
185 21
186 21
            // t
187
            $objWriter->startElement($prefix . 't');
188
            $objWriter->writeAttribute('xml:space', 'preserve');
189 21
            $objWriter->writeRawData(StringHelper::controlCharacterPHP2OOXML($element->getText()));
190
            $objWriter->endElement();
191
192
            $objWriter->endElement();
193 33
        }
194 33
    }
195 33
196 33
    /**
197
     * Write Rich Text.
198 33
     *
199
     * @param RichText|string $richText text string or Rich text
200
     * @param string $prefix Optional Namespace prefix
201
     */
202
    public function writeRichTextForCharts(XMLWriter $objWriter, $richText = null, string $prefix = ''): void
203
    {
204
        if (!($richText instanceof RichText)) {
205
            $textRun = $richText;
206
            $richText = new RichText();
207
            $run = $richText->createTextRun($textRun ?? '');
208 82
            $run->setFont(null);
209
        }
210 82
211 49
        if ($prefix !== '') {
212 49
            $prefix .= ':';
213 49
        }
214 49
215
        // Loop through rich text elements
216
        $elements = $richText->getRichTextElements();
217 82
        foreach ($elements as $element) {
218 82
            // r
219
            $objWriter->startElement($prefix . 'r');
220
            if ($element->getFont() !== null) {
221
                // rPr
222 82
                $objWriter->startElement($prefix . 'rPr');
223 82
                $fontSize = $element->getFont()->getSize();
224
                if (is_numeric($fontSize)) {
225 82
                    $fontSize *= (($fontSize < 100) ? 100 : 1);
226 82
                    $objWriter->writeAttribute('sz', (string) $fontSize);
227
                }
228 28
229 28
                // Bold
230 28
                $objWriter->writeAttribute('b', ($element->getFont()->getBold() ? '1' : '0'));
231 22
                // Italic
232 22
                $objWriter->writeAttribute('i', ($element->getFont()->getItalic() ? '1' : '0'));
233
                // Underline
234
                $underlineType = $element->getFont()->getUnderline();
235
                switch ($underlineType) {
236 28
                    case 'single':
237
                        $underlineType = 'sng';
238 28
239
                        break;
240 28
                    case 'double':
241
                        $underlineType = 'dbl';
242 28
243 6
                        break;
244
                }
245 6
                if ($underlineType !== null) {
246 28
                    $objWriter->writeAttribute('u', $underlineType);
247 5
                }
248
                // Strikethrough
249 5
                $objWriter->writeAttribute('strike', ($element->getFont()->getStriketype() ?: 'noStrike'));
250
                // Superscript/subscript
251 28
                if ($element->getFont()->getBaseLine()) {
252 28
                    $objWriter->writeAttribute('baseline', (string) $element->getFont()->getBaseLine());
253
                }
254
255 28
                // Color
256
                $this->writeChartTextColor($objWriter, $element->getFont()->getChartColor(), $prefix);
257 28
258 5
                // Underscore Color
259
                $this->writeChartTextColor($objWriter, $element->getFont()->getUnderlineColor(), $prefix, 'uFill');
260
261
                // fontName
262 28
                if ($element->getFont()->getLatin()) {
263
                    $objWriter->startElement($prefix . 'latin');
264
                    $objWriter->writeAttribute('typeface', $element->getFont()->getLatin());
265 28
                    $objWriter->endElement();
266
                }
267
                if ($element->getFont()->getEastAsian()) {
268 28
                    $objWriter->startElement($prefix . 'ea');
269 23
                    $objWriter->writeAttribute('typeface', $element->getFont()->getEastAsian());
270 23
                    $objWriter->endElement();
271 23
                }
272
                if ($element->getFont()->getComplexScript()) {
273 28
                    $objWriter->startElement($prefix . 'cs');
274 21
                    $objWriter->writeAttribute('typeface', $element->getFont()->getComplexScript());
275 21
                    $objWriter->endElement();
276 21
                }
277
278 28
                $objWriter->endElement();
279 21
            }
280 21
281 21
            // t
282
            $objWriter->startElement($prefix . 't');
283
            $objWriter->writeRawData(StringHelper::controlCharacterPHP2OOXML($element->getText()));
284 28
            $objWriter->endElement();
285
286
            $objWriter->endElement();
287
        }
288 82
    }
289 82
290 82
    private function writeChartTextColor(XMLWriter $objWriter, ?ChartColor $underlineColor, string $prefix, ?string $openTag = ''): void
291
    {
292 82
        if ($underlineColor !== null) {
293
            $type = $underlineColor->getType();
294
            $value = $underlineColor->getValue();
295
            if (!empty($type) && !empty($value)) {
296 28
                if ($openTag !== '') {
297
                    $objWriter->startElement($prefix . $openTag);
298 28
                }
299 22
                $objWriter->startElement($prefix . 'solidFill');
300 22
                $objWriter->startElement($prefix . $type);
301 22
                $objWriter->writeAttribute('val', $value);
302 17
                $alpha = $underlineColor->getAlpha();
303 5
                if (is_numeric($alpha)) {
304
                    $objWriter->startElement('a:alpha');
305 17
                    $objWriter->writeAttribute('val', ChartColor::alphaToXml((int) $alpha));
306 17
                    $objWriter->endElement();
307 17
                }
308 17
                $objWriter->endElement(); // srgbClr/schemeClr/prstClr
309 17
                $objWriter->endElement(); // solidFill
310
                if ($openTag !== '') {
311
                    $objWriter->endElement(); // uFill
312
                }
313
            }
314 17
        }
315 17
    }
316 17
317 5
    /**
318
     * Flip string table (for index searching).
319
     *
320
     * @param array $stringTable Stringtable
321
     */
322
    public function flipStringTable(array $stringTable): array
323
    {
324
        // Return value
325
        $returnValue = [];
326
327
        // Loop through stringtable and add flipped items to $returnValue
328 410
        foreach ($stringTable as $key => $value) {
329
            if (!$value instanceof RichText) {
330
                $returnValue[$value] = $key;
331 410
            } elseif ($value instanceof RichText) {
332
                $returnValue[$value->getHashCode()] = $key;
333
            }
334 410
        }
335 234
336 231
        return $returnValue;
337 19
    }
338
}
339