Style: Remove bgColor from Font, Table, and Cell and put it into the new Shading style

Author: ivanlanin

CHANGELOG.md

@@ -42,6 +42,7 @@ This release marked heavy refactorings on internal code structure with the creat
 - Section: Ability to define gutter and line numbering - @ivanlanin
 - Font: Small caps, all caps, and double strikethrough - @ivanlanin GH-151
 - Settings: Ability to use measurement unit other than twips with `setMeasurementUnit` - @ivanlanin GH-199
+- Style: Remove `bgColor` from `Font`, `Table`, and `Cell` and put it into the new `Shading` style - @ivanlanin
 
 ### Bugfixes
 

samples/Sample_04_Textrun.php

@@ -8,7 +8,7 @@
 // Ads styles
 $phpWord->addParagraphStyle('pStyle', array('spacing'=>100));
 $phpWord->addFontStyle('BoldText', array('bold'=>true));
-$phpWord->addFontStyle('ColoredText', array('color'=>'FF8080'));
+$phpWord->addFontStyle('ColoredText', array('color'=>'FF8080', 'bgColor' => 'FFFFCC'));
 $phpWord->addLinkStyle('NLink', array('color'=>'0000FF', 'underline' => \PhpOffice\PhpWord\Style\Font::UNDERLINE_SINGLE));
 
 // New portrait section

samples/Sample_09_Tables.php

@@ -55,7 +55,7 @@
 $section->addText("Table with colspan and rowspan", $header);
 
 $styleTable = array('borderSize' => 6, 'borderColor' => '999999');
-$cellRowSpan = array('vMerge' => 'restart', 'valign' => 'center');
+$cellRowSpan = array('vMerge' => 'restart', 'valign' => 'center', 'bgColor' => 'FFFF00');
 $cellRowContinue = array('vMerge' => 'continue');
 $cellColSpan = array('gridSpan' => 2, 'valign' => 'center');
 $cellHCentered = array('align' => 'center');

src/PhpWord/Style/Cell.php

@@ -9,7 +9,7 @@
 
 namespace PhpOffice\PhpWord\Style;
 
-use PhpOffice\PhpWord\Shared\String;
+use PhpOffice\PhpWord\Style\Shading;
 
 /**
  * Table cell style
@@ -33,13 +33,6 @@ class Cell extends Border
      */
     private $textDirection;
 
-    /**
-     * Background-Color
-     *
-     * @var string
-     */
-    private $bgColor;
-
     /**
      * Border Default Color
      *
@@ -64,14 +57,20 @@ class Cell extends Border
      */
     private $vMerge = null;
 
+    /**
+     * Shading
+     *
+     * @var \PhpOffice\PhpWord\Style\Shading
+     */
+    private $shading;
+
     /**
      * Create a new Cell Style
      */
     public function __construct()
     {
         $this->valign = null;
         $this->textDirection = null;
-        $this->bgColor = null;
         $this->borderTopSize = null;
         $this->borderTopColor = null;
         $this->borderLeftSize = null;
@@ -83,24 +82,6 @@ public function __construct()
         $this->defaultBorderColor = '000000';
     }
 
-    /**
-     * Set style value
-     *
-     * @param string $key
-     * @param mixed $value
-     */
-    public function setStyleValue($key, $value)
-    {
-        $key = String::removeUnderscorePrefix($key);
-        if ($key == 'borderSize') {
-            $this->setBorderSize($value);
-        } elseif ($key == 'borderColor') {
-            $this->setBorderColor($value);
-        } else {
-            $this->$key = $value;
-        }
-    }
-
     /**
      * Get vertical align
      */
@@ -138,21 +119,26 @@ public function setTextDirection($pValue = null)
     }
 
     /**
-     * Get background color
+     * Get background
+     *
+     * @return string
      */
     public function getBgColor()
     {
-        return $this->bgColor;
+        if (!is_null($this->shading)) {
+            return $this->shading->getFill();
+        }
     }
 
     /**
-     * Set background color
+     * Set background
      *
-     * @param string $pValue
+     * @param string $value
+     * @return \PhpOffice\PhpWord\Style\Table
      */
-    public function setBgColor($pValue = null)
+    public function setBgColor($value = null)
     {
-        $this->bgColor = $pValue;
+        $this->setShading(array('fill' => $value));
     }
 
     /**
@@ -198,4 +184,34 @@ public function getVMerge()
     {
         return $this->vMerge;
     }
+
+    /**
+     * Get shading
+     *
+     * @return \PhpOffice\PhpWord\Style\Shading
+     */
+    public function getShading()
+    {
+        return $this->shading;
+    }
+
+    /**
+     * Set shading
+     *
+     * @param array $value
+     * @return self
+     */
+    public function setShading($value = null)
+    {
+        if (is_array($value)) {
+            if (!$this->shading instanceof Shading) {
+                $this->shading = new Shading();
+            }
+            $this->shading->setStyleByArray($value);
+        } else {
+            $this->shading = null;
+        }
+
+        return $this;
+    }
 }

src/PhpWord/Style/Font.php

@@ -11,6 +11,7 @@
 
 use PhpOffice\PhpWord\PhpWord;
 use PhpOffice\PhpWord\Exception\InvalidStyleException;
+use PhpOffice\PhpWord\Style\Shading;
 
 /**
  * Font style
@@ -153,12 +154,6 @@ class Font extends AbstractStyle
      */
     private $fgColor = null;
 
-    /**
-     * Background color
-     *
-     * @var string
-     */
-    private $bgColor = null;
     /**
      * Text line height
      *
@@ -195,6 +190,13 @@ class Font extends AbstractStyle
      */
     private $allCaps = false;
 
+    /**
+     * Shading
+     *
+     * @var \PhpOffice\PhpWord\Style\Shading
+     */
+    private $shading;
+
     /**
      * Create new font style
      *
@@ -501,26 +503,26 @@ public function setFgColor($value = null)
     }
 
     /**
-     * Get background color
+     * Get background
      *
-     * @return  string
+     * @return string
      */
     public function getBgColor()
     {
-        return $this->bgColor;
+        if (!is_null($this->shading)) {
+            return $this->shading->getFill();
+        }
     }
 
     /**
-     * Set background color
+     * Set background
      *
      * @param string $value
-     * @return $this
+     * @return \PhpOffice\PhpWord\Style\Table
      */
     public function setBgColor($value = null)
     {
-        $this->bgColor = $value;
-
-        return $this;
+        $this->setShading(array('fill' => $value));
     }
 
     /**
@@ -649,4 +651,34 @@ public function setAllCaps($value = false)
 
         return $this;
     }
+
+    /**
+     * Get shading
+     *
+     * @return \PhpOffice\PhpWord\Style\Shading
+     */
+    public function getShading()
+    {
+        return $this->shading;
+    }
+
+    /**
+     * Set shading
+     *
+     * @param array $value
+     * @return self
+     */
+    public function setShading($value = null)
+    {
+        if (is_array($value)) {
+            if (!$this->shading instanceof Shading) {
+                $this->shading = new Shading();
+            }
+            $this->shading->setStyleByArray($value);
+        } else {
+            $this->shading = null;
+        }
+
+        return $this;
+    }
 }

src/PhpWord/Style/LineNumbering.php

@@ -142,7 +142,7 @@ public function getRestart()
     /**
      * Set distance
      *
-     * @param int|float $value
+     * @param string $value
      * @return self
      */
     public function setRestart($value = null)

src/PhpWord/Style/Section.php

@@ -9,6 +9,8 @@
 
 namespace PhpOffice\PhpWord\Style;
 
+use PhpOffice\PhpWord\Style\LineNumbering;
+
 /**
  * Section settings
  */
@@ -146,7 +148,7 @@ class Section extends Border
     /**
      * Line numbering
      *
-     * @var array
+     * @var \PhpOffice\PhpWord\Style\LineNumbering
      * @link http://www.schemacentral.com/sc/ooxml/e-w_lnNumType-1.html
      */
     private $lineNumbering;
@@ -491,7 +493,7 @@ public function setBreakType($value = null)
     /**
      * Get line numbering
      *
-     * @return self
+     * @return \PhpOffice\PhpWord\Style\LineNumbering
      */
     public function getLineNumbering()
     {
@@ -506,20 +508,15 @@ public function getLineNumbering()
      */
     public function setLineNumbering($value = null)
     {
-        if ($this->lineNumbering instanceof LineNumbering) {
+        if (is_array($value)) {
+            if (!$this->lineNumbering instanceof LineNumbering) {
+                $this->lineNumbering = new LineNumbering($value);
+            }
             $this->lineNumbering->setStyleByArray($value);
         } else {
-            $this->lineNumbering = new LineNumbering($value);
+            $this->lineNumbering = null;
         }
 
         return $this;
     }
-
-    /**
-     * Remove line numbering
-     */
-    public function removeLineNumbering()
-    {
-        $this->lineNumbering = null;
-    }
 }