Style::serialize() - Code Metrics - Inspection of "Refactor ODS escaper" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#363)

by Adrien

created 2016-11-28 23:52 UTC

Style::serialize() A

↳ Parent: Style

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	12
ccs	5
cts	5
cp	1
rs	9.4285
c	1
b	0
f	0
cc	1
eloc	6
nc	1
nop	0
crap	1

<?php

namespace Box\Spout\Writer\Style;

/**
 * Class Style
 * Represents a style to be applied to a cell
 *
 * @package Box\Spout\Writer\Style
 */
class Style
{
    /** Default font values */
    const DEFAULT_FONT_SIZE = 11;
    const DEFAULT_FONT_COLOR = Color::BLACK;
    const DEFAULT_FONT_NAME = 'Arial';

    /** @var int|null Style ID */
    protected $id = null;

    /** @var bool Whether the font should be bold */
    protected $fontBold = false;
    /** @var bool Whether the bold property was set */
    protected $hasSetFontBold = false;

    /** @var bool Whether the font should be italic */
    protected $fontItalic = false;
    /** @var bool Whether the italic property was set */
    protected $hasSetFontItalic = false;

    /** @var bool Whether the font should be underlined */
    protected $fontUnderline = false;
    /** @var bool Whether the underline property was set */
    protected $hasSetFontUnderline = false;

    /** @var bool Whether the font should be struck through */
    protected $fontStrikethrough = false;
    /** @var bool Whether the strikethrough property was set */
    protected $hasSetFontStrikethrough = false;

    /** @var int Font size */
    protected $fontSize = self::DEFAULT_FONT_SIZE;
    /** @var bool Whether the font size property was set */
    protected $hasSetFontSize = false;

    /** @var string Font color */
    protected $fontColor = self::DEFAULT_FONT_COLOR;
    /** @var bool Whether the font color property was set */
    protected $hasSetFontColor = false;

    /** @var string Font name */
    protected $fontName = self::DEFAULT_FONT_NAME;
    /** @var bool Whether the font name property was set */
    protected $hasSetFontName = false;

    /** @var bool Whether specific font properties should be applied */
    protected $shouldApplyFont = false;

    /** @var bool Whether the text should wrap in the cell (useful for long or multi-lines text) */
    protected $shouldWrapText = false;
    /** @var bool Whether the wrap text property was set */
    protected $hasSetWrapText = false;

    /**
     * @var Border
     */
    protected $border = null;

    /**
     * @var bool Whether border properties should be applied
     */
    protected $shouldApplyBorder = false;

    /** @var string Background color */
    protected $backgroundColor = null;

    /** @var bool */
    protected $hasSetBackgroundColor = false;


    /**
     * @return int|null
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param int $id
     * @return Style
     */
    public function setId($id)
    {
        $this->id = $id;
        return $this;
    }

    /**
     * @return Border
     */
    public function getBorder()
    {
        return $this->border;
    }

    /**
     * @param Border $border
     * @return Style
     */
    public function setBorder(Border $border)
    {
        $this->shouldApplyBorder = true;
        $this->border = $border;
        return $this;
    }

    /**
     * @return bool
     */
    public function shouldApplyBorder()
    {
        return $this->shouldApplyBorder;
    }

    /**
     * @return bool
     */
    public function isFontBold()
    {
        return $this->fontBold;
    }

    /**
     * @return Style
     */
    public function setFontBold()
    {
        $this->fontBold = true;
        $this->hasSetFontBold = true;
        $this->shouldApplyFont = true;
        return $this;
    }

    /**
     * @return bool
     */
    public function isFontItalic()
    {
        return $this->fontItalic;
    }

    /**
     * @return Style
     */
    public function setFontItalic()
    {
        $this->fontItalic = true;
        $this->hasSetFontItalic = true;
        $this->shouldApplyFont = true;
        return $this;
    }

    /**
     * @return bool
     */
    public function isFontUnderline()
    {
        return $this->fontUnderline;
    }

    /**
     * @return Style
     */
    public function setFontUnderline()
    {
        $this->fontUnderline = true;
        $this->hasSetFontUnderline = true;
        $this->shouldApplyFont = true;
        return $this;
    }

    /**
     * @return bool
     */
    public function isFontStrikethrough()
    {
        return $this->fontStrikethrough;
    }

    /**
     * @return Style
     */
    public function setFontStrikethrough()
    {
        $this->fontStrikethrough = true;
        $this->hasSetFontStrikethrough = true;
        $this->shouldApplyFont = true;
        return $this;
    }

    /**
     * @return int
     */
    public function getFontSize()
    {
        return $this->fontSize;
    }

    /**
     * @param int $fontSize Font size, in pixels
     * @return Style
     */
    public function setFontSize($fontSize)
    {
        $this->fontSize = $fontSize;
        $this->hasSetFontSize = true;
        $this->shouldApplyFont = true;
        return $this;
    }

    /**
     * @return string
     */
    public function getFontColor()
    {
        return $this->fontColor;
    }

    /**
     * Sets the font color.
     *
     * @param string $fontColor ARGB color (@see Color)
     * @return Style
     */
    public function setFontColor($fontColor)
    {
        $this->fontColor = $fontColor;
        $this->hasSetFontColor = true;
        $this->shouldApplyFont = true;
        return $this;
    }

    /**
     * @return string
     */
    public function getFontName()
    {
        return $this->fontName;
    }

    /**
     * @param string $fontName Name of the font to use
     * @return Style
     */
    public function setFontName($fontName)
    {
        $this->fontName = $fontName;
        $this->hasSetFontName = true;
        $this->shouldApplyFont = true;
        return $this;
    }

    /**
     * @return bool
     */
    public function shouldWrapText()
    {
        return $this->shouldWrapText;
    }

    /**
     * @param bool|void $shouldWrap Should the text be wrapped
     * @return Style
     */
    public function setShouldWrapText($shouldWrap = true)
    {
        $this->shouldWrapText = $shouldWrap;
        $this->hasSetWrapText = true;
        return $this;
    }

    /**
     * @return bool
     */
    public function hasSetWrapText()
    {
        return $this->hasSetWrapText;
    }

    /**
     * @return bool Whether specific font properties should be applied
     */
    public function shouldApplyFont()
    {
        return $this->shouldApplyFont;
    }

    /**
     * Sets the background color
     * @param string $color ARGB color (@see Color)
     * @return Style
     */
    public function setBackgroundColor($color)
    {
        $this->hasSetBackgroundColor = true;
        $this->backgroundColor = $color;
        return $this;
    }

    /**
     * @return string
     */
    public function getBackgroundColor()
    {
        return $this->backgroundColor;
    }

    /**
     *
     * @return bool Whether the background color should be applied
     */
    public function shouldApplyBackgroundColor()
    {
        return $this->hasSetBackgroundColor;
    }

    /**
     * Serializes the style for future comparison with other styles.
     * The ID is excluded from the comparison, as we only care about
     * actual style properties.
     *
     * @return string The serialized style
     */
    public function serialize()
    {
        // In order to be able to properly compare style, set static ID value
        $currentId = $this->id;
        $this->setId(0);

        $serializedStyle = serialize($this);

        $this->setId($currentId);

        return $serializedStyle;
    }

    /**
     * Merges the current style with the given style, using the given style as a base. This means that:
     *   - if current style and base style both have property A set, use current style property's value
     *   - if current style has property A set but base style does not, use current style property's value
     *   - if base style has property A set but current style does not, use base style property's value
     *
     * @NOTE: This function returns a new style.
     *
     * @param Style $baseStyle
     * @return Style New style corresponding to the merge of the 2 styles
     */
    public function mergeWith($baseStyle)
    {
        $mergedStyle = clone $this;

        $this->mergeFontStyles($mergedStyle, $baseStyle);
        $this->mergeOtherFontProperties($mergedStyle, $baseStyle);
        $this->mergeCellProperties($mergedStyle, $baseStyle);

        return $mergedStyle;
    }

    /**
     * @param Style $styleToUpdate (passed as reference)
     * @param Style $baseStyle
     * @return void
     */
    private function mergeFontStyles($styleToUpdate, $baseStyle)
    {
        if (!$this->hasSetFontBold && $baseStyle->isFontBold()) {
            $styleToUpdate->setFontBold();
        }
        if (!$this->hasSetFontItalic && $baseStyle->isFontItalic()) {
            $styleToUpdate->setFontItalic();
        }
        if (!$this->hasSetFontUnderline && $baseStyle->isFontUnderline()) {
            $styleToUpdate->setFontUnderline();
        }
        if (!$this->hasSetFontStrikethrough && $baseStyle->isFontStrikethrough()) {
            $styleToUpdate->setFontStrikethrough();
        }
    }

    /**
     * @param Style $styleToUpdate Style to update (passed as reference)
     * @param Style $baseStyle
     * @return void
     */
    private function mergeOtherFontProperties($styleToUpdate, $baseStyle)
    {
        if (!$this->hasSetFontSize && $baseStyle->getFontSize() !== self::DEFAULT_FONT_SIZE) {
            $styleToUpdate->setFontSize($baseStyle->getFontSize());
        }
        if (!$this->hasSetFontColor && $baseStyle->getFontColor() !== self::DEFAULT_FONT_COLOR) {
            $styleToUpdate->setFontColor($baseStyle->getFontColor());
        }
        if (!$this->hasSetFontName && $baseStyle->getFontName() !== self::DEFAULT_FONT_NAME) {
            $styleToUpdate->setFontName($baseStyle->getFontName());
        }
    }

    /**
     * @param Style $styleToUpdate Style to update (passed as reference)
     * @param Style $baseStyle
     * @return void
     */
    private function mergeCellProperties($styleToUpdate, $baseStyle)
    {
        if (!$this->hasSetWrapText && $baseStyle->shouldWrapText()) {
            $styleToUpdate->setShouldWrapText();
        }
        if (!$this->getBorder() && $baseStyle->shouldApplyBorder()) {
            $styleToUpdate->setBorder($baseStyle->getBorder());
        }
        if (!$this->hasSetBackgroundColor && $baseStyle->shouldApplyBackgroundColor()) {
            $styleToUpdate->setBackgroundColor($baseStyle->getBackgroundColor());
        }
    }
}


1		<?php
2
3		namespace Box\Spout\Writer\Style;
4
5		/**
6		* Class Style
7		* Represents a style to be applied to a cell
8		*
9		* @package Box\Spout\Writer\Style
10		*/
11		class Style
12		{
13		/** Default font values */
14		const DEFAULT_FONT_SIZE = 11;
15		const DEFAULT_FONT_COLOR = Color::BLACK;
16		const DEFAULT_FONT_NAME = 'Arial';
17
18		/** @var int\|null Style ID */
19		protected $id = null;
20
21		/** @var bool Whether the font should be bold */
22		protected $fontBold = false;
23		/** @var bool Whether the bold property was set */
24		protected $hasSetFontBold = false;
25
26		/** @var bool Whether the font should be italic */
27		protected $fontItalic = false;
28		/** @var bool Whether the italic property was set */
29		protected $hasSetFontItalic = false;
30
31		/** @var bool Whether the font should be underlined */
32		protected $fontUnderline = false;
33		/** @var bool Whether the underline property was set */
34		protected $hasSetFontUnderline = false;
35
36		/** @var bool Whether the font should be struck through */
37		protected $fontStrikethrough = false;
38		/** @var bool Whether the strikethrough property was set */
39		protected $hasSetFontStrikethrough = false;
40
41		/** @var int Font size */
42		protected $fontSize = self::DEFAULT_FONT_SIZE;
43		/** @var bool Whether the font size property was set */
44		protected $hasSetFontSize = false;
45
46		/** @var string Font color */
47		protected $fontColor = self::DEFAULT_FONT_COLOR;
48		/** @var bool Whether the font color property was set */
49		protected $hasSetFontColor = false;
50
51		/** @var string Font name */
52		protected $fontName = self::DEFAULT_FONT_NAME;
53		/** @var bool Whether the font name property was set */
54		protected $hasSetFontName = false;
55
56		/** @var bool Whether specific font properties should be applied */
57		protected $shouldApplyFont = false;
58
59		/** @var bool Whether the text should wrap in the cell (useful for long or multi-lines text) */
60		protected $shouldWrapText = false;
61		/** @var bool Whether the wrap text property was set */
62		protected $hasSetWrapText = false;
63
64		/**
65		* @var Border
66		*/
67		protected $border = null;
68
69		/**
70		* @var bool Whether border properties should be applied
71		*/
72		protected $shouldApplyBorder = false;
73
74		/** @var string Background color */
75		protected $backgroundColor = null;
76
77		/** @var bool */
78		protected $hasSetBackgroundColor = false;
79
80
81		/**
82		* @return int\|null
83		*/
84	237	public function getId()
85		{
86	237	return $this->id;
87		}
88
89		/**
90		* @param int $id
91		* @return Style
92		*/
93	279	public function setId($id)
94		{
95	279	$this->id = $id;
96	279	return $this;
97		}
98
99		/**
100		* @return Border
101		*/
102	96	public function getBorder()
103		{
104	96	return $this->border;
105		}
106
107		/**
108		* @param Border $border
109		* @return Style
110	24	*/
111		public function setBorder(Border $border)
112	24	{
113	24	$this->shouldApplyBorder = true;
114	24	$this->border = $border;
115		return $this;
116		}
117
118		/**
119		* @return bool
120	270	*/
121		public function shouldApplyBorder()
122	270	{
123		return $this->shouldApplyBorder;
124		}
125
126		/**
127		* @return bool
128	159	*/
129		public function isFontBold()
130	159	{
131		return $this->fontBold;
132		}
133
134		/**
135		* @return Style
136	48	*/
137		public function setFontBold()
138	48	{
139	48	$this->fontBold = true;
140	48	$this->hasSetFontBold = true;
141	48	$this->shouldApplyFont = true;
142		return $this;
143		}
144
145		/**
146		* @return bool
147	159	*/
148		public function isFontItalic()
149	159	{
150		return $this->fontItalic;
151		}
152
153		/**
154		* @return Style
155	12	*/
156		public function setFontItalic()
157	12	{
158	12	$this->fontItalic = true;
159	12	$this->hasSetFontItalic = true;
160	12	$this->shouldApplyFont = true;
161		return $this;
162		}
163
164		/**
165		* @return bool
166	159	*/
167		public function isFontUnderline()
168	159	{
169		return $this->fontUnderline;
170		}
171
172		/**
173		* @return Style
174	18	*/
175		public function setFontUnderline()
176	18	{
177	18	$this->fontUnderline = true;
178	18	$this->hasSetFontUnderline = true;
179	18	$this->shouldApplyFont = true;
180		return $this;
181		}
182
183		/**
184		* @return bool
185	159	*/
186		public function isFontStrikethrough()
187	159	{
188		return $this->fontStrikethrough;
189		}
190
191		/**
192		* @return Style
193	12	*/
194		public function setFontStrikethrough()
195	12	{
196	12	$this->fontStrikethrough = true;
197	12	$this->hasSetFontStrikethrough = true;
198	12	$this->shouldApplyFont = true;
199		return $this;
200		}
201
202		/**
203		* @return int
204	222	*/
205		public function getFontSize()
206	222	{
207		return $this->fontSize;
208		}
209
210		/**
211		* @param int $fontSize Font size, in pixels
212		* @return Style
213	159	*/
214		public function setFontSize($fontSize)
215	159	{
216	159	$this->fontSize = $fontSize;
217	159	$this->hasSetFontSize = true;
218	159	$this->shouldApplyFont = true;
219		return $this;
220		}
221
222		/**
223		* @return string
224	222	*/
225		public function getFontColor()
226	222	{
227		return $this->fontColor;
228		}
229
230		/**
231		* Sets the font color.
232		*
233		* @param string $fontColor ARGB color (@see Color)
234		* @return Style
235	6	*/
236		public function setFontColor($fontColor)
237	6	{
238	6	$this->fontColor = $fontColor;
239	6	$this->hasSetFontColor = true;
240	6	$this->shouldApplyFont = true;
241		return $this;
242		}
243
244		/**
245		* @return string
246	261	*/
247		public function getFontName()
248	261	{
249		return $this->fontName;
250		}
251
252		/**
253		* @param string $fontName Name of the font to use
254		* @return Style
255	150	*/
256		public function setFontName($fontName)
257	150	{
258	150	$this->fontName = $fontName;
259	150	$this->hasSetFontName = true;
260	150	$this->shouldApplyFont = true;
261		return $this;
262		}
263
264		/**
265		* @return bool
266	234	*/
267		public function shouldWrapText()
268	234	{
269		return $this->shouldWrapText;
270		}
271
272		/**
273		* @param bool\|void $shouldWrap Should the text be wrapped
274		* @return Style
275	30	*/
276		public function setShouldWrapText($shouldWrap = true)
277	30	{
278	30	$this->shouldWrapText = $shouldWrap;
279	30	$this->hasSetWrapText = true;
280		return $this;
281		}
282
283		/**
284		* @return bool
285	186	*/
286		public function hasSetWrapText()
287	186	{
288		return $this->hasSetWrapText;
289		}
290
291		/**
292		* @return bool Whether specific font properties should be applied
293	186	*/
294		public function shouldApplyFont()
295	186	{
296		return $this->shouldApplyFont;
297		}
298
299		/**
300		* Sets the background color
301		* @param string $color ARGB color (@see Color)
302		* @return Style
303	18	*/
304		public function setBackgroundColor($color)
305	18	{
306	18	$this->hasSetBackgroundColor = true;
307	18	$this->backgroundColor = $color;
308		return $this;
309		}
310
311		/**
312		* @return string
313	147	*/
314		public function getBackgroundColor()
315	147	{
316		return $this->backgroundColor;
317		}
318
319		/**
320		*
321		* @return bool Whether the background color should be applied
322	153	*/
323		public function shouldApplyBackgroundColor()
324	153	{
325		return $this->hasSetBackgroundColor;
326		}
327
328		/**
329		* Serializes the style for future comparison with other styles.
330		* The ID is excluded from the comparison, as we only care about
331		* actual style properties.
332		*
333		* @return string The serialized style
334	279	*/
335		public function serialize()
336		{
337	279	// In order to be able to properly compare style, set static ID value
338	279	$currentId = $this->id;
339		$this->setId(0);
340	279
341		$serializedStyle = serialize($this);
342	279
343		$this->setId($currentId);
344	279
345		return $serializedStyle;
346		}
347
348		/**
349		* Merges the current style with the given style, using the given style as a base. This means that:
350		* - if current style and base style both have property A set, use current style property's value
351		* - if current style has property A set but base style does not, use current style property's value
352		* - if base style has property A set but current style does not, use base style property's value
353		*
354		* @NOTE: This function returns a new style.
355		*
356		* @param Style $baseStyle
357		* @return Style New style corresponding to the merge of the 2 styles
358	93	*/
359		public function mergeWith($baseStyle)
360	93	{
361		$mergedStyle = clone $this;
362	93
363	6	$this->mergeFontStyles($mergedStyle, $baseStyle);
364	6	$this->mergeOtherFontProperties($mergedStyle, $baseStyle);
365	93	$this->mergeCellProperties($mergedStyle, $baseStyle);
366	3
367	3	return $mergedStyle;
368	93	}
369	3
370	3	/**
371	93	* @param Style $styleToUpdate (passed as reference)
372	3	* @param Style $baseStyle
373	3	* @return void
374	93	*/
375	42	private function mergeFontStyles($styleToUpdate, $baseStyle)
376	42	{
377	93	if (!$this->hasSetFontBold && $baseStyle->isFontBold()) {
378		$styleToUpdate->setFontBold();
379		}
380	93	if (!$this->hasSetFontItalic && $baseStyle->isFontItalic()) {
381	39	$styleToUpdate->setFontItalic();
382	39	}
383	93	if (!$this->hasSetFontUnderline && $baseStyle->isFontUnderline()) {
384	3	$styleToUpdate->setFontUnderline();
385	3	}
386	93	if (!$this->hasSetFontStrikethrough && $baseStyle->isFontStrikethrough()) {
387	3	$styleToUpdate->setFontStrikethrough();
388	3	}
389	93	}
390
391		/**
392		* @param Style $styleToUpdate Style to update (passed as reference)
393	93	* @param Style $baseStyle
394		* @return void
395		*/
396		private function mergeOtherFontProperties($styleToUpdate, $baseStyle)
397		{
398		if (!$this->hasSetFontSize && $baseStyle->getFontSize() !== self::DEFAULT_FONT_SIZE) {
399		$styleToUpdate->setFontSize($baseStyle->getFontSize());
400		}
401		if (!$this->hasSetFontColor && $baseStyle->getFontColor() !== self::DEFAULT_FONT_COLOR) {
402		$styleToUpdate->setFontColor($baseStyle->getFontColor());
403		}
404		if (!$this->hasSetFontName && $baseStyle->getFontName() !== self::DEFAULT_FONT_NAME) {
405		$styleToUpdate->setFontName($baseStyle->getFontName());
406		}
407		}
408
409		/**
410		* @param Style $styleToUpdate Style to update (passed as reference)
411		* @param Style $baseStyle
412		* @return void
413		*/
414		private function mergeCellProperties($styleToUpdate, $baseStyle)
415		{
416		if (!$this->hasSetWrapText && $baseStyle->shouldWrapText()) {
417		$styleToUpdate->setShouldWrapText();
418		}
419		if (!$this->getBorder() && $baseStyle->shouldApplyBorder()) {
420		$styleToUpdate->setBorder($baseStyle->getBorder());
421		}
422		if (!$this->hasSetBackgroundColor && $baseStyle->shouldApplyBackgroundColor()) {
423		$styleToUpdate->setBackgroundColor($baseStyle->getBackgroundColor());
424		}
425		}
426		}
427

box / spout

Pull Request — master (#363)

Style::serialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like