AbstractDecoratorWriter::writePatternFill() - Code Metrics - Inspection of "[WIP] PowerPoint2007 : Interval Unit in Axis-X" - PHPOffice/PHPPresentation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#546)

by Franck

created 2019-06-10 13:07 UTC

AbstractDecoratorWriter::writePatternFill() A

↳ Parent: AbstractDecoratorWriter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	10
cts	10
cp	1
rs	9.584
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1

<?php

namespace PhpOffice\PhpPresentation\Writer\PowerPoint2007;

use PhpOffice\Common\Drawing as CommonDrawing;
use PhpOffice\Common\XMLWriter;
use PhpOffice\PhpPresentation\Style\Border;
use PhpOffice\PhpPresentation\Style\Color;
use PhpOffice\PhpPresentation\Style\Fill;
use PhpOffice\PhpPresentation\Style\Outline;

abstract class AbstractDecoratorWriter extends \PhpOffice\PhpPresentation\Writer\AbstractDecoratorWriter
{
    /**
     * Write relationship
     *
     * @param  \PhpOffice\Common\XMLWriter $objWriter   XML Writer
     * @param  int                            $pId         Relationship ID. rId will be prepended!
     * @param  string                         $pType       Relationship type
     * @param  string                         $pTarget     Relationship target
     * @param  string                         $pTargetMode Relationship target mode
     * @throws \Exception
     */
    protected function writeRelationship(XMLWriter $objWriter, $pId = 1, $pType = '', $pTarget = '', $pTargetMode = '')
    {
        if ($pType == '' || $pTarget == '') {
            throw new \Exception("Invalid parameters passed.");
        }
        if (strpos($pId, 'rId') === false) {
            $pId = 'rId' . $pId;
        }

        // Write relationship
        $objWriter->startElement('Relationship');
        $objWriter->writeAttribute('Id', $pId);
        $objWriter->writeAttribute('Type', $pType);
        $objWriter->writeAttribute('Target', $pTarget);

        if ($pTargetMode != '') {
            $objWriter->writeAttribute('TargetMode', $pTargetMode);
        }

        $objWriter->endElement();
    }

    /**
     * Write Border
     *
     * @param  \PhpOffice\Common\XMLWriter $objWriter    XML Writer
     * @param  \PhpOffice\PhpPresentation\Style\Border     $pBorder      Border
     * @param  string                         $pElementName Element name
     * @throws \Exception
     */
    protected function writeBorder(XMLWriter $objWriter, $pBorder, $pElementName = 'L')
    {
        if (!($pBorder instanceof Border)) {
            return;
        }

        if ($pBorder->getLineStyle() == Border::LINE_NONE && $pElementName == '') {
            return;
        }

        // Line style
        $lineStyle = $pBorder->getLineStyle();
        if ($lineStyle == Border::LINE_NONE) {
            $lineStyle = Border::LINE_SINGLE;
        }

        // Line width
        $lineWidth = 12700 * $pBorder->getLineWidth();

        // a:ln $pElementName
        $objWriter->startElement('a:ln' . $pElementName);
        $objWriter->writeAttribute('w', $lineWidth);
        $objWriter->writeAttribute('cap', 'flat');
        $objWriter->writeAttribute('cmpd', $lineStyle);
        $objWriter->writeAttribute('algn', 'ctr');

        // Fill?
        if ($pBorder->getLineStyle() == Border::LINE_NONE) {
            // a:noFill
            $objWriter->writeElement('a:noFill', null);
        } else {
            // a:solidFill
            $objWriter->startElement('a:solidFill');
            $this->writeColor($objWriter, $pBorder->getColor());
            $objWriter->endElement();
        }

        // Dash
        $objWriter->startElement('a:prstDash');
        $objWriter->writeAttribute('val', $pBorder->getDashStyle());
        $objWriter->endElement();

        // a:round
        $objWriter->writeElement('a:round', null);

        // a:headEnd
        $objWriter->startElement('a:headEnd');
        $objWriter->writeAttribute('type', 'none');
        $objWriter->writeAttribute('w', 'med');
        $objWriter->writeAttribute('len', 'med');
        $objWriter->endElement();

        // a:tailEnd
        $objWriter->startElement('a:tailEnd');
        $objWriter->writeAttribute('type', 'none');
        $objWriter->writeAttribute('w', 'med');
        $objWriter->writeAttribute('len', 'med');
        $objWriter->endElement();

        $objWriter->endElement();
    }

    /**
     * @param XMLWriter $objWriter
     * @param Color $color
     * @param int|null $alpha
     */
    protected function writeColor(XMLWriter $objWriter, Color $color, $alpha = null)
    {
        if (is_null($alpha)) {
            $alpha = $color->getAlpha();
        }

        // a:srgbClr
        $objWriter->startElement('a:srgbClr');
        $objWriter->writeAttribute('val', $color->getRGB());

        // a:alpha
        $objWriter->startElement('a:alpha');
        $objWriter->writeAttribute('val', $alpha * 1000);
        $objWriter->endElement();

        $objWriter->endElement();
    }

    /**
     * Write Fill
     *
     * @param  \PhpOffice\Common\XMLWriter $objWriter XML Writer
     * @param  \PhpOffice\PhpPresentation\Style\Fill       $pFill     Fill style
     * @throws \Exception
     */
    protected function writeFill(XMLWriter $objWriter, $pFill)
    {
        if (! $pFill instanceof Fill) {
            return;
        }

        // Is it a fill?
        if ($pFill->getFillType() == Fill::FILL_NONE) {
            $objWriter->writeElement('a:noFill');
            return;
        }

        // Is it a solid fill?
        if ($pFill->getFillType() == Fill::FILL_SOLID) {
            $this->writeSolidFill($objWriter, $pFill);
            return;
        }

        // Check if this is a pattern type or gradient type
        if ($pFill->getFillType() == Fill::FILL_GRADIENT_LINEAR || $pFill->getFillType() == Fill::FILL_GRADIENT_PATH) {
            // Gradient fill
            $this->writeGradientFill($objWriter, $pFill);
        } else {
            // Pattern fill
            $this->writePatternFill($objWriter, $pFill);
        }
    }

    /**
     * Write Solid Fill
     *
     * @param  \PhpOffice\Common\XMLWriter $objWriter XML Writer
     * @param  \PhpOffice\PhpPresentation\Style\Fill       $pFill     Fill style
     * @throws \Exception
     */
    protected function writeSolidFill(XMLWriter $objWriter, Fill $pFill)
    {
        // a:gradFill
        $objWriter->startElement('a:solidFill');
        $this->writeColor($objWriter, $pFill->getStartColor());
        $objWriter->endElement();
    }

    /**
     * Write Gradient Fill
     *
     * @param  \PhpOffice\Common\XMLWriter $objWriter XML Writer
     * @param  \PhpOffice\PhpPresentation\Style\Fill       $pFill     Fill style
     * @throws \Exception
     */
    protected function writeGradientFill(XMLWriter $objWriter, Fill $pFill)
    {
        // a:gradFill
        $objWriter->startElement('a:gradFill');

        // a:gsLst
        $objWriter->startElement('a:gsLst');
        // a:gs
        $objWriter->startElement('a:gs');
        $objWriter->writeAttribute('pos', '0');
        $this->writeColor($objWriter, $pFill->getStartColor());
        $objWriter->endElement();

        // a:gs
        $objWriter->startElement('a:gs');
        $objWriter->writeAttribute('pos', '100000');
        $this->writeColor($objWriter, $pFill->getEndColor());
        $objWriter->endElement();

        $objWriter->endElement();

        // a:lin
        $objWriter->startElement('a:lin');
        $objWriter->writeAttribute('ang', CommonDrawing::degreesToAngle($pFill->getRotation()));
        $objWriter->writeAttribute('scaled', '0');
        $objWriter->endElement();

        $objWriter->endElement();
    }

    /**
     * Write Pattern Fill
     *
     * @param  \PhpOffice\Common\XMLWriter $objWriter XML Writer
     * @param  \PhpOffice\PhpPresentation\Style\Fill       $pFill     Fill style
     * @throws \Exception
     */
    protected function writePatternFill(XMLWriter $objWriter, Fill $pFill)
    {
        // a:pattFill
        $objWriter->startElement('a:pattFill');

        // fgClr
        $objWriter->startElement('a:fgClr');

        $this->writeColor($objWriter, $pFill->getStartColor());

        $objWriter->endElement();

        // bgClr
        $objWriter->startElement('a:bgClr');

        $this->writeColor($objWriter, $pFill->getEndColor());

        $objWriter->endElement();

        $objWriter->endElement();
    }

    /**
     * Write Outline
     * @param XMLWriter $objWriter
     * @param Outline $oOutline
     * @throws \Exception
     */
    protected function writeOutline(XMLWriter $objWriter, $oOutline)
    {
        if (!$oOutline instanceof Outline) {
            return;
        }
        // Width : pts
        $width = $oOutline->getWidth();
        // Width : pts => px
        $width = CommonDrawing::pointsToPixels($width);
        // Width : px => emu
        $width = CommonDrawing::pixelsToEmu($width);

        // a:ln
        $objWriter->startElement('a:ln');
        $objWriter->writeAttribute('w', $width);

        // Fill
        $this->writeFill($objWriter, $oOutline->getFill());

        // > a:ln
        $objWriter->endElement();
    }

    /**
     * Determine absolute zip path
     *
     * @param  string $path
     * @return string
     */
    protected function absoluteZipPath($path)
    {
        $path      = str_replace(array(
            '/',
            '\\'
        ), DIRECTORY_SEPARATOR, $path);
        $parts     = array_filter(explode(DIRECTORY_SEPARATOR, $path), 'strlen');
        $absolutes = array();
        foreach ($parts as $part) {
            if ('.' == $part) {
                continue;
            }
            if ('..' == $part) {
                array_pop($absolutes);
            } else {
                $absolutes[] = $part;
            }
        }

        return implode('/', $absolutes);
    }
}


1		<?php
2
3		namespace PhpOffice\PhpPresentation\Writer\PowerPoint2007;
4
5		use PhpOffice\Common\Drawing as CommonDrawing;
6		use PhpOffice\Common\XMLWriter;
7		use PhpOffice\PhpPresentation\Style\Border;
8		use PhpOffice\PhpPresentation\Style\Color;
9		use PhpOffice\PhpPresentation\Style\Fill;
10		use PhpOffice\PhpPresentation\Style\Outline;
11
12		abstract class AbstractDecoratorWriter extends \PhpOffice\PhpPresentation\Writer\AbstractDecoratorWriter
13		{
14		/**
15		* Write relationship
16		*
17		* @param \PhpOffice\Common\XMLWriter $objWriter XML Writer
18		* @param int $pId Relationship ID. rId will be prepended!
19		* @param string $pType Relationship type
20		* @param string $pTarget Relationship target
21		* @param string $pTargetMode Relationship target mode
22		* @throws \Exception
23		*/
24	113	protected function writeRelationship(XMLWriter $objWriter, $pId = 1, $pType = '', $pTarget = '', $pTargetMode = '')
25		{
26	113	if ($pType == '' \|\| $pTarget == '') {
27		throw new \Exception("Invalid parameters passed.");
28		}
29	113	if (strpos($pId, 'rId') === false) {
30	113	$pId = 'rId' . $pId;
31	113	}
32
33		// Write relationship
34	113	$objWriter->startElement('Relationship');
35	113	$objWriter->writeAttribute('Id', $pId);
36	113	$objWriter->writeAttribute('Type', $pType);
37	113	$objWriter->writeAttribute('Target', $pTarget);
38
39	113	if ($pTargetMode != '') {
40	4	$objWriter->writeAttribute('TargetMode', $pTargetMode);
41	4	}
42
43	113	$objWriter->endElement();
44	113	}
45
46		/**
47		* Write Border
48		*
49		* @param \PhpOffice\Common\XMLWriter $objWriter XML Writer
50		* @param \PhpOffice\PhpPresentation\Style\Border $pBorder Border
51		* @param string $pElementName Element name
52		* @throws \Exception
53		*/
54	78	protected function writeBorder(XMLWriter $objWriter, $pBorder, $pElementName = 'L')
55		{
56	78	if (!($pBorder instanceof Border)) {
57		return;
58		}
59
60	78	if ($pBorder->getLineStyle() == Border::LINE_NONE && $pElementName == '') {
61	32	return;
62		}
63
64		// Line style
65	46	$lineStyle = $pBorder->getLineStyle();
66	46	if ($lineStyle == Border::LINE_NONE) {
67	10	$lineStyle = Border::LINE_SINGLE;
68	10	}
69
70		// Line width
71	46	$lineWidth = 12700 * $pBorder->getLineWidth();
72
73		// a:ln $pElementName
74	46	$objWriter->startElement('a:ln' . $pElementName);
75	46	$objWriter->writeAttribute('w', $lineWidth);
76	46	$objWriter->writeAttribute('cap', 'flat');
77	46	$objWriter->writeAttribute('cmpd', $lineStyle);
78	46	$objWriter->writeAttribute('algn', 'ctr');
79
80		// Fill?
81	46	if ($pBorder->getLineStyle() == Border::LINE_NONE) {
82		// a:noFill
83	10	$objWriter->writeElement('a:noFill', null);
84	10	} else {
85		// a:solidFill
86	46	$objWriter->startElement('a:solidFill');
87	46	$this->writeColor($objWriter, $pBorder->getColor());
88	46	$objWriter->endElement();
89		}
90
91		// Dash
92	46	$objWriter->startElement('a:prstDash');
93	46	$objWriter->writeAttribute('val', $pBorder->getDashStyle());
94	46	$objWriter->endElement();
95
96		// a:round
97	46	$objWriter->writeElement('a:round', null);
98
99		// a:headEnd
100	46	$objWriter->startElement('a:headEnd');
101	46	$objWriter->writeAttribute('type', 'none');
102	46	$objWriter->writeAttribute('w', 'med');
103	46	$objWriter->writeAttribute('len', 'med');
104	46	$objWriter->endElement();
105
106		// a:tailEnd
107	46	$objWriter->startElement('a:tailEnd');
108	46	$objWriter->writeAttribute('type', 'none');
109	46	$objWriter->writeAttribute('w', 'med');
110	46	$objWriter->writeAttribute('len', 'med');
111	46	$objWriter->endElement();
112
113	46	$objWriter->endElement();
114	46	}
115
116		/**
117		* @param XMLWriter $objWriter
118		* @param Color $color
119		* @param int\|null $alpha
120		*/
121	71	protected function writeColor(XMLWriter $objWriter, Color $color, $alpha = null)
122		{
123	71	if (is_null($alpha)) {
124	70	$alpha = $color->getAlpha();
125	70	}
126
127		// a:srgbClr
128	71	$objWriter->startElement('a:srgbClr');
129	71	$objWriter->writeAttribute('val', $color->getRGB());
130
131		// a:alpha
132	71	$objWriter->startElement('a:alpha');
133	71	$objWriter->writeAttribute('val', $alpha * 1000);
134	71	$objWriter->endElement();
135
136	71	$objWriter->endElement();
137	71	}
138
139		/**
140		* Write Fill
141		*
142		* @param \PhpOffice\Common\XMLWriter $objWriter XML Writer
143		* @param \PhpOffice\PhpPresentation\Style\Fill $pFill Fill style
144		* @throws \Exception
145		*/
146	77	protected function writeFill(XMLWriter $objWriter, $pFill)
147		{
148	77	if (! $pFill instanceof Fill) {
149		return;
150		}
151
152		// Is it a fill?
153	77	if ($pFill->getFillType() == Fill::FILL_NONE) {
154	69	$objWriter->writeElement('a:noFill');
155	69	return;
156		}
157
158		// Is it a solid fill?
159	17	if ($pFill->getFillType() == Fill::FILL_SOLID) {
160	12	$this->writeSolidFill($objWriter, $pFill);
161	12	return;
162		}
163
164		// Check if this is a pattern type or gradient type
165	5	if ($pFill->getFillType() == Fill::FILL_GRADIENT_LINEAR \|\| $pFill->getFillType() == Fill::FILL_GRADIENT_PATH) {
166		// Gradient fill
167	4	$this->writeGradientFill($objWriter, $pFill);
168	4	} else {
169		// Pattern fill
170	1	$this->writePatternFill($objWriter, $pFill);
171		}
172	5	}
173
174		/**
175		* Write Solid Fill
176		*
177		* @param \PhpOffice\Common\XMLWriter $objWriter XML Writer
178		* @param \PhpOffice\PhpPresentation\Style\Fill $pFill Fill style
179		* @throws \Exception
180		*/
181	12	protected function writeSolidFill(XMLWriter $objWriter, Fill $pFill)
182		{
183		// a:gradFill
184	12	$objWriter->startElement('a:solidFill');
185	12	$this->writeColor($objWriter, $pFill->getStartColor());
186	12	$objWriter->endElement();
187	12	}
188
189		/**
190		* Write Gradient Fill
191		*
192		* @param \PhpOffice\Common\XMLWriter $objWriter XML Writer
193		* @param \PhpOffice\PhpPresentation\Style\Fill $pFill Fill style
194		* @throws \Exception
195		*/
196	4	protected function writeGradientFill(XMLWriter $objWriter, Fill $pFill)
197		{
198		// a:gradFill
199	4	$objWriter->startElement('a:gradFill');
200
201		// a:gsLst
202	4	$objWriter->startElement('a:gsLst');
203		// a:gs
204	4	$objWriter->startElement('a:gs');
205	4	$objWriter->writeAttribute('pos', '0');
206	4	$this->writeColor($objWriter, $pFill->getStartColor());
207	4	$objWriter->endElement();
208
209		// a:gs
210	4	$objWriter->startElement('a:gs');
211	4	$objWriter->writeAttribute('pos', '100000');
212	4	$this->writeColor($objWriter, $pFill->getEndColor());
213	4	$objWriter->endElement();
214
215	4	$objWriter->endElement();
216
217		// a:lin
218	4	$objWriter->startElement('a:lin');
219	4	$objWriter->writeAttribute('ang', CommonDrawing::degreesToAngle($pFill->getRotation()));
220	4	$objWriter->writeAttribute('scaled', '0');
221	4	$objWriter->endElement();
222
223	4	$objWriter->endElement();
224	4	}
225
226		/**
227		* Write Pattern Fill
228		*
229		* @param \PhpOffice\Common\XMLWriter $objWriter XML Writer
230		* @param \PhpOffice\PhpPresentation\Style\Fill $pFill Fill style
231		* @throws \Exception
232		*/
233	1	protected function writePatternFill(XMLWriter $objWriter, Fill $pFill)
234		{
235		// a:pattFill
236	1	$objWriter->startElement('a:pattFill');
237
238		// fgClr
239	1	$objWriter->startElement('a:fgClr');
240
241	1	$this->writeColor($objWriter, $pFill->getStartColor());
242
243	1	$objWriter->endElement();
244
245		// bgClr
246	1	$objWriter->startElement('a:bgClr');
247
248	1	$this->writeColor($objWriter, $pFill->getEndColor());
249
250	1	$objWriter->endElement();
251
252	1	$objWriter->endElement();
253	1	}
254
255		/**
256		* Write Outline
257		* @param XMLWriter $objWriter
258		* @param Outline $oOutline
259		* @throws \Exception
260		*/
261	28	protected function writeOutline(XMLWriter $objWriter, $oOutline)
262		{
263	28	if (!$oOutline instanceof Outline) {
264	16	return;
265		}
266		// Width : pts
267	28	$width = $oOutline->getWidth();
268		// Width : pts => px
269	28	$width = CommonDrawing::pointsToPixels($width);
270		// Width : px => emu
271	28	$width = CommonDrawing::pixelsToEmu($width);
272
273		// a:ln
274	28	$objWriter->startElement('a:ln');
275	28	$objWriter->writeAttribute('w', $width);
276
277		// Fill
278	28	$this->writeFill($objWriter, $oOutline->getFill());
279
280		// > a:ln
281	28	$objWriter->endElement();
282	28	}
283
284		/**
285		* Determine absolute zip path
286		*
287		* @param string $path
288		* @return string
289		*/
290		protected function absoluteZipPath($path)
291		{
292		$path = str_replace(array(
293		'/',
294		'\\'
295		), DIRECTORY_SEPARATOR, $path);
296		$parts = array_filter(explode(DIRECTORY_SEPARATOR, $path), 'strlen');
297		$absolutes = array();
298		foreach ($parts as $part) {
299		if ('.' == $part) {
300		continue;
301		}
302		if ('..' == $part) {
303		array_pop($absolutes);
304		} else {
305		$absolutes[] = $part;
306		}
307		}
308
309		return implode('/', $absolutes);
310		}
311		}
312

PHPOffice / PHPPresentation

Pull Request — develop (#546)

AbstractDecoratorWriter::writePatternFill() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like