Failed Conditions
Push — develop ( 064076...83c759 )
by Adrien
63:09
created

Drawing::writeChart()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 62
Code Lines 53

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 50
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 53
nc 1
nop 3
dl 0
loc 62
rs 9.4743
c 0
b 0
f 0
ccs 50
cts 50
cp 1
crap 1

How to fix   Long Method   

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\Coordinate;
6
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
7
use PhpOffice\PhpSpreadsheet\Spreadsheet;
8
use PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing;
9
use PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing;
10
use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;
11
12
class Drawing extends WriterPart
13
{
14
    /**
15
     * Write drawings to XML format.
16
     *
17
     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet
18
     * @param bool $includeCharts Flag indicating if we should include drawing details for charts
19
     *
20
     * @throws WriterException
21
     *
22
     * @return string XML Output
23
     */
24 22
    public function writeDrawings(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet, $includeCharts = false)
25
    {
26
        // Create XML writer
27 22
        $objWriter = null;
28 22
        if ($this->getParentWriter()->getUseDiskCaching()) {
29
            $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
30
        } else {
31 22
            $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
32
        }
33
34
        // XML header
35 22
        $objWriter->startDocument('1.0', 'UTF-8', 'yes');
36
37
        // xdr:wsDr
38 22
        $objWriter->startElement('xdr:wsDr');
39 22
        $objWriter->writeAttribute('xmlns:xdr', 'http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing');
40 22
        $objWriter->writeAttribute('xmlns:a', 'http://schemas.openxmlformats.org/drawingml/2006/main');
41
42
        // Loop through images and write drawings
43 22
        $i = 1;
44 22
        $iterator = $pWorksheet->getDrawingCollection()->getIterator();
45 22
        while ($iterator->valid()) {
46 10
            $this->writeDrawing($objWriter, $iterator->current(), $i);
47
48 10
            $iterator->next();
49 10
            ++$i;
50
        }
51
52 22
        if ($includeCharts) {
53 13
            $chartCount = $pWorksheet->getChartCount();
54
            // Loop through charts and write the chart position
55 13
            if ($chartCount > 0) {
56 13
                for ($c = 0; $c < $chartCount; ++$c) {
57 13
                    $this->writeChart($objWriter, $pWorksheet->getChartByIndex($c), $c + $i);
1 ignored issue
show
Bug introduced by
It seems like $pWorksheet->getChartByIndex($c) can also be of type false; however, parameter $pChart of PhpOffice\PhpSpreadsheet...x\Drawing::writeChart() does only seem to accept PhpOffice\PhpSpreadsheet\Chart\Chart, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

57
                    $this->writeChart($objWriter, /** @scrutinizer ignore-type */ $pWorksheet->getChartByIndex($c), $c + $i);
Loading history...
58
                }
59
            }
60
        }
61
62 22
        // unparsed AlternateContent
63
        if (isset($pWorksheet->getParent()->getUnparsedLoadedData()['sheets'][$pWorksheet->getCodeName()]['drawingAlternateContents'])) {
64
            foreach ($pWorksheet->getParent()->getUnparsedLoadedData()['sheets'][$pWorksheet->getCodeName()]['drawingAlternateContents'] as $drawingAlternateContent) {
65 22
                $objWriter->writeRaw($drawingAlternateContent);
66
            }
67
        }
68
69
        $objWriter->endElement();
70
71
        // Return
72
        return $objWriter->getData();
73
    }
74
75 13
    /**
76
     * Write drawings to XML format.
77 13
     *
78 13
     * @param XMLWriter $objWriter XML Writer
79 13
     * @param \PhpOffice\PhpSpreadsheet\Chart\Chart $pChart
80 13
     * @param int $pRelationId
81
     */
82 13
    public function writeChart(XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Chart $pChart, $pRelationId = -1)
83
    {
84 13
        $tl = $pChart->getTopLeftPosition();
85 13
        $tl['colRow'] = Coordinate::coordinateFromString($tl['cell']);
86 13
        $br = $pChart->getBottomRightPosition();
87 13
        $br['colRow'] = Coordinate::coordinateFromString($br['cell']);
88 13
89 13
        $objWriter->startElement('xdr:twoCellAnchor');
90 13
91 13
        $objWriter->startElement('xdr:from');
92 13
        $objWriter->writeElement('xdr:col', Coordinate::columnIndexFromString($tl['colRow'][0]) - 1);
93 13
        $objWriter->writeElement('xdr:colOff', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($tl['xOffset']));
94 13
        $objWriter->writeElement('xdr:row', $tl['colRow'][1] - 1);
95 13
        $objWriter->writeElement('xdr:rowOff', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($tl['yOffset']));
96
        $objWriter->endElement();
97 13
        $objWriter->startElement('xdr:to');
98 13
        $objWriter->writeElement('xdr:col', Coordinate::columnIndexFromString($br['colRow'][0]) - 1);
99 13
        $objWriter->writeElement('xdr:colOff', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($br['xOffset']));
100 13
        $objWriter->writeElement('xdr:row', $br['colRow'][1] - 1);
101 13
        $objWriter->writeElement('xdr:rowOff', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($br['yOffset']));
102 13
        $objWriter->endElement();
103 13
104 13
        $objWriter->startElement('xdr:graphicFrame');
105 13
        $objWriter->writeAttribute('macro', '');
106 13
        $objWriter->startElement('xdr:nvGraphicFramePr');
107 13
        $objWriter->startElement('xdr:cNvPr');
108 13
        $objWriter->writeAttribute('name', 'Chart ' . $pRelationId);
109
        $objWriter->writeAttribute('id', 1025 * $pRelationId);
110 13
        $objWriter->endElement();
111 13
        $objWriter->startElement('xdr:cNvGraphicFramePr');
112 13
        $objWriter->startElement('a:graphicFrameLocks');
113 13
        $objWriter->endElement();
114 13
        $objWriter->endElement();
115 13
        $objWriter->endElement();
116 13
117 13
        $objWriter->startElement('xdr:xfrm');
118 13
        $objWriter->startElement('a:off');
119 13
        $objWriter->writeAttribute('x', '0');
120
        $objWriter->writeAttribute('y', '0');
121 13
        $objWriter->endElement();
122 13
        $objWriter->startElement('a:ext');
123 13
        $objWriter->writeAttribute('cx', '0');
124 13
        $objWriter->writeAttribute('cy', '0');
125 13
        $objWriter->endElement();
126 13
        $objWriter->endElement();
127 13
128 13
        $objWriter->startElement('a:graphic');
129 13
        $objWriter->startElement('a:graphicData');
130 13
        $objWriter->writeAttribute('uri', 'http://schemas.openxmlformats.org/drawingml/2006/chart');
131 13
        $objWriter->startElement('c:chart');
132
        $objWriter->writeAttribute('xmlns:c', 'http://schemas.openxmlformats.org/drawingml/2006/chart');
133 13
        $objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships');
134 13
        $objWriter->writeAttribute('r:id', 'rId' . $pRelationId);
135
        $objWriter->endElement();
136 13
        $objWriter->endElement();
137 13
        $objWriter->endElement();
138
        $objWriter->endElement();
139
140
        $objWriter->startElement('xdr:clientData');
141
        $objWriter->endElement();
142
143
        $objWriter->endElement();
144
    }
145
146
    /**
147
     * Write drawings to XML format.
148 10
     *
149
     * @param XMLWriter $objWriter XML Writer
150 10
     * @param BaseDrawing $pDrawing
151
     * @param int $pRelationId
152 10
     *
153
     * @throws WriterException
154 10
     */
155 10
    public function writeDrawing(XMLWriter $objWriter, BaseDrawing $pDrawing, $pRelationId = -1)
156
    {
157
        if ($pRelationId >= 0) {
158 10
            // xdr:oneCellAnchor
159 10
            $objWriter->startElement('xdr:oneCellAnchor');
160 10
            // Image location
161 10
            $aCoordinates = Coordinate::coordinateFromString($pDrawing->getCoordinates());
162 10
            $aCoordinates[0] = Coordinate::columnIndexFromString($aCoordinates[0]);
163 10
164
            // xdr:from
165
            $objWriter->startElement('xdr:from');
166 10
            $objWriter->writeElement('xdr:col', $aCoordinates[0] - 1);
167 10
            $objWriter->writeElement('xdr:colOff', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($pDrawing->getOffsetX()));
168 10
            $objWriter->writeElement('xdr:row', $aCoordinates[1] - 1);
169 10
            $objWriter->writeElement('xdr:rowOff', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($pDrawing->getOffsetY()));
170
            $objWriter->endElement();
171
172 10
            // xdr:ext
173
            $objWriter->startElement('xdr:ext');
174
            $objWriter->writeAttribute('cx', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($pDrawing->getWidth()));
175 10
            $objWriter->writeAttribute('cy', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($pDrawing->getHeight()));
176
            $objWriter->endElement();
177
178 10
            // xdr:pic
179 10
            $objWriter->startElement('xdr:pic');
180 10
181 10
            // xdr:nvPicPr
182 10
            $objWriter->startElement('xdr:nvPicPr');
183
184
            // xdr:cNvPr
185 10
            $objWriter->startElement('xdr:cNvPr');
186
            $objWriter->writeAttribute('id', $pRelationId);
187
            $objWriter->writeAttribute('name', $pDrawing->getName());
188 10
            $objWriter->writeAttribute('descr', $pDrawing->getDescription());
189 10
            $objWriter->endElement();
190 10
191
            // xdr:cNvPicPr
192 10
            $objWriter->startElement('xdr:cNvPicPr');
193
194 10
            // a:picLocks
195
            $objWriter->startElement('a:picLocks');
196
            $objWriter->writeAttribute('noChangeAspect', '1');
197 10
            $objWriter->endElement();
198
199
            $objWriter->endElement();
200 10
201 10
            $objWriter->endElement();
202 10
203 10
            // xdr:blipFill
204
            $objWriter->startElement('xdr:blipFill');
205
206 10
            // a:blip
207 10
            $objWriter->startElement('a:blip');
208 10
            $objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships');
209
            $objWriter->writeAttribute('r:embed', 'rId' . $pRelationId);
210 10
            $objWriter->endElement();
211
212
            // a:stretch
213 10
            $objWriter->startElement('a:stretch');
214
            $objWriter->writeElement('a:fillRect', null);
215
            $objWriter->endElement();
216 10
217 10
            $objWriter->endElement();
218 10
219
            // xdr:spPr
220
            $objWriter->startElement('xdr:spPr');
221 10
222 10
            // a:xfrm
223
            $objWriter->startElement('a:xfrm');
224
            $objWriter->writeAttribute('rot', \PhpOffice\PhpSpreadsheet\Shared\Drawing::degreesToAngle($pDrawing->getRotation()));
225 10
            $objWriter->endElement();
226
227 10
            // a:prstGeom
228
            $objWriter->startElement('a:prstGeom');
229 10
            $objWriter->writeAttribute('prst', 'rect');
230
231 5
            // a:avLst
232
            $objWriter->writeElement('a:avLst', null);
233
234 5
            $objWriter->endElement();
235 5
236 5
            if ($pDrawing->getShadow()->getVisible()) {
237 5
                // a:effectLst
238 5
                $objWriter->startElement('a:effectLst');
239 5
240
                // a:outerShdw
241
                $objWriter->startElement('a:outerShdw');
242 5
                $objWriter->writeAttribute('blurRad', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($pDrawing->getShadow()->getBlurRadius()));
243 5
                $objWriter->writeAttribute('dist', \PhpOffice\PhpSpreadsheet\Shared\Drawing::pixelsToEMU($pDrawing->getShadow()->getDistance()));
244
                $objWriter->writeAttribute('dir', \PhpOffice\PhpSpreadsheet\Shared\Drawing::degreesToAngle($pDrawing->getShadow()->getDirection()));
245
                $objWriter->writeAttribute('algn', $pDrawing->getShadow()->getAlignment());
246 5
                $objWriter->writeAttribute('rotWithShape', '0');
247 5
248 5
                // a:srgbClr
249
                $objWriter->startElement('a:srgbClr');
250 5
                $objWriter->writeAttribute('val', $pDrawing->getShadow()->getColor()->getRGB());
251
252 5
                // a:alpha
253
                $objWriter->startElement('a:alpha');
254 5
                $objWriter->writeAttribute('val', $pDrawing->getShadow()->getAlpha() * 1000);
255
                $objWriter->endElement();
256 10
257
                $objWriter->endElement();
258 10
259
                $objWriter->endElement();
260
261 10
                $objWriter->endElement();
262
            }
263 10
            $objWriter->endElement();
264
265
            $objWriter->endElement();
266
267 10
            // xdr:clientData
268
            $objWriter->writeElement('xdr:clientData', null);
269
270
            $objWriter->endElement();
271
        } else {
272
            throw new WriterException('Invalid parameters passed.');
273
        }
274
    }
275
276
    /**
277
     * Write VML header/footer images to XML format.
278 1
     *
279
     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet
280
     *
281 1
     * @throws WriterException
282 1
     *
283
     * @return string XML Output
284
     */
285 1
    public function writeVMLHeaderFooterImages(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet)
286
    {
287
        // Create XML writer
288
        $objWriter = null;
289 1
        if ($this->getParentWriter()->getUseDiskCaching()) {
290
            $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
291
        } else {
292 1
            $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
293
        }
294
295 1
        // XML header
296 1
        $objWriter->startDocument('1.0', 'UTF-8', 'yes');
297 1
298 1
        // Header/footer images
299
        $images = $pWorksheet->getHeaderFooter()->getImages();
300
301 1
        // xml
302 1
        $objWriter->startElement('xml');
303
        $objWriter->writeAttribute('xmlns:v', 'urn:schemas-microsoft-com:vml');
304
        $objWriter->writeAttribute('xmlns:o', 'urn:schemas-microsoft-com:office:office');
305 1
        $objWriter->writeAttribute('xmlns:x', 'urn:schemas-microsoft-com:office:excel');
306 1
307 1
        // o:shapelayout
308 1
        $objWriter->startElement('o:shapelayout');
309
        $objWriter->writeAttribute('v:ext', 'edit');
310 1
311
        // o:idmap
312
        $objWriter->startElement('o:idmap');
313 1
        $objWriter->writeAttribute('v:ext', 'edit');
314 1
        $objWriter->writeAttribute('data', '1');
315 1
        $objWriter->endElement();
316 1
317 1
        $objWriter->endElement();
318 1
319 1
        // v:shapetype
320 1
        $objWriter->startElement('v:shapetype');
321
        $objWriter->writeAttribute('id', '_x0000_t75');
322
        $objWriter->writeAttribute('coordsize', '21600,21600');
323 1
        $objWriter->writeAttribute('o:spt', '75');
324 1
        $objWriter->writeAttribute('o:preferrelative', 't');
325 1
        $objWriter->writeAttribute('path', 'm@4@5l@4@11@9@11@9@5xe');
326
        $objWriter->writeAttribute('filled', 'f');
327
        $objWriter->writeAttribute('stroked', 'f');
328 1
329
        // v:stroke
330
        $objWriter->startElement('v:stroke');
331 1
        $objWriter->writeAttribute('joinstyle', 'miter');
332 1
        $objWriter->endElement();
333 1
334
        // v:formulas
335
        $objWriter->startElement('v:formulas');
336 1
337 1
        // v:f
338 1
        $objWriter->startElement('v:f');
339
        $objWriter->writeAttribute('eqn', 'if lineDrawn pixelLineWidth 0');
340
        $objWriter->endElement();
341 1
342 1
        // v:f
343 1
        $objWriter->startElement('v:f');
344
        $objWriter->writeAttribute('eqn', 'sum @0 1 0');
345
        $objWriter->endElement();
346 1
347 1
        // v:f
348 1
        $objWriter->startElement('v:f');
349
        $objWriter->writeAttribute('eqn', 'sum 0 0 @1');
350
        $objWriter->endElement();
351 1
352 1
        // v:f
353 1
        $objWriter->startElement('v:f');
354
        $objWriter->writeAttribute('eqn', 'prod @2 1 2');
355
        $objWriter->endElement();
356 1
357 1
        // v:f
358 1
        $objWriter->startElement('v:f');
359
        $objWriter->writeAttribute('eqn', 'prod @3 21600 pixelWidth');
360
        $objWriter->endElement();
361 1
362 1
        // v:f
363 1
        $objWriter->startElement('v:f');
364
        $objWriter->writeAttribute('eqn', 'prod @3 21600 pixelHeight');
365
        $objWriter->endElement();
366 1
367 1
        // v:f
368 1
        $objWriter->startElement('v:f');
369
        $objWriter->writeAttribute('eqn', 'sum @0 0 1');
370
        $objWriter->endElement();
371 1
372 1
        // v:f
373 1
        $objWriter->startElement('v:f');
374
        $objWriter->writeAttribute('eqn', 'prod @6 1 2');
375
        $objWriter->endElement();
376 1
377 1
        // v:f
378 1
        $objWriter->startElement('v:f');
379
        $objWriter->writeAttribute('eqn', 'prod @7 21600 pixelWidth');
380
        $objWriter->endElement();
381 1
382 1
        // v:f
383 1
        $objWriter->startElement('v:f');
384
        $objWriter->writeAttribute('eqn', 'sum @8 21600 0');
385
        $objWriter->endElement();
386 1
387 1
        // v:f
388 1
        $objWriter->startElement('v:f');
389
        $objWriter->writeAttribute('eqn', 'prod @7 21600 pixelHeight');
390 1
        $objWriter->endElement();
391
392
        // v:f
393 1
        $objWriter->startElement('v:f');
394 1
        $objWriter->writeAttribute('eqn', 'sum @10 21600 0');
395 1
        $objWriter->endElement();
396 1
397 1
        $objWriter->endElement();
398
399
        // v:path
400 1
        $objWriter->startElement('v:path');
401 1
        $objWriter->writeAttribute('o:extrusionok', 'f');
402 1
        $objWriter->writeAttribute('gradientshapeok', 't');
403 1
        $objWriter->writeAttribute('o:connecttype', 'rect');
404
        $objWriter->endElement();
405 1
406
        // o:lock
407
        $objWriter->startElement('o:lock');
408 1
        $objWriter->writeAttribute('v:ext', 'edit');
409 1
        $objWriter->writeAttribute('aspectratio', 't');
410
        $objWriter->endElement();
411
412 1
        $objWriter->endElement();
413
414
        // Loop through images
415 1
        foreach ($images as $key => $value) {
416
            $this->writeVMLHeaderFooterImage($objWriter, $key, $value);
417
        }
418
419
        $objWriter->endElement();
420
421
        // Return
422
        return $objWriter->getData();
423
    }
424
425 1
    /**
426
     * Write VML comment to XML format.
427
     *
428 1
     * @param XMLWriter $objWriter XML Writer
429 1
     * @param string $pReference Reference
430
     * @param HeaderFooterDrawing $pImage Image
431
     */
432 1
    private function writeVMLHeaderFooterImage(XMLWriter $objWriter, $pReference, HeaderFooterDrawing $pImage)
433 1
    {
434 1
        // Calculate object id
435 1
        preg_match('{(\d+)}', md5($pReference), $m);
436
        $id = 1500 + (substr($m[1], 0, 2) * 1);
437
438 1
        // Calculate offset
439 1
        $width = $pImage->getWidth();
440 1
        $height = $pImage->getHeight();
441 1
        $marginLeft = $pImage->getOffsetX();
442 1
        $marginTop = $pImage->getOffsetY();
443
444
        // v:shape
445 1
        $objWriter->startElement('v:shape');
446 1
        $objWriter->writeAttribute('id', $pReference);
447 1
        $objWriter->writeAttribute('o:spid', '_x0000_s' . $id);
448 1
        $objWriter->writeAttribute('type', '#_x0000_t75');
449
        $objWriter->writeAttribute('style', "position:absolute;margin-left:{$marginLeft}px;margin-top:{$marginTop}px;width:{$width}px;height:{$height}px;z-index:1");
450
451 1
        // v:imagedata
452 1
        $objWriter->startElement('v:imagedata');
453 1
        $objWriter->writeAttribute('o:relid', 'rId' . $pReference);
454 1
        $objWriter->writeAttribute('o:title', $pImage->getName());
455
        $objWriter->endElement();
456 1
457 1
        // o:lock
458
        $objWriter->startElement('o:lock');
459
        $objWriter->writeAttribute('v:ext', 'edit');
460
        $objWriter->writeAttribute('textRotation', 't');
461
        $objWriter->endElement();
462
463
        $objWriter->endElement();
464
    }
465
466 73
    /**
467
     * Get an array of all drawings.
468
     *
469 73
     * @param Spreadsheet $spreadsheet
470
     *
471
     * @return \PhpOffice\PhpSpreadsheet\Worksheet\Drawing[] All drawings in PhpSpreadsheet
472 73
     */
473 73
    public function allDrawings(Spreadsheet $spreadsheet)
474
    {
475 73
        // Get an array of all drawings
476 73
        $aDrawings = [];
477 10
478
        // Loop through PhpSpreadsheet
479 10
        $sheetCount = $spreadsheet->getSheetCount();
480
        for ($i = 0; $i < $sheetCount; ++$i) {
481
            // Loop through images and add to array
482
            $iterator = $spreadsheet->getSheet($i)->getDrawingCollection()->getIterator();
483 73
            while ($iterator->valid()) {
484
                $aDrawings[] = $iterator->current();
485
486
                $iterator->next();
487
            }
488
        }
489
490
        return $aDrawings;
491
    }
492
}
493