Additional unit tests and some code deduplication

ivanlanin · ivanlanin · commit a3a9af51e5ed · 2014-04-11T21:28:43.000+07:00
diff --git a/src/PhpWord/Element/Section.php b/src/PhpWord/Element/Section.php
@@ -66,9 +66,6 @@ public function setSettings($settings = null)
                 if (is_null($value)) {
                     continue;
                 }
-                if (substr($key, 0, 1) == '_') {
-                    $key = substr($key, 1);
-                }
                 $this->settings->setSettingValue($key, $value);
             }
         }
diff --git a/src/PhpWord/Shared/String.php b/src/PhpWord/Shared/String.php
@@ -77,6 +77,23 @@ public static function toUTF8($value = '')
         return $value;
     }
 
+    /**
+     * Return name without underscore for < 0.10.0 variable name compatibility
+     *
+     * @param string $value
+     * @return string
+     */
+    public static function removeUnderscorePrefix($value)
+    {
+        if (!is_null($value)) {
+            if (substr($value, 0, 1) == '_') {
+                $value = substr($value, 1);
+            }
+        }
+
+        return $value;
+    }
+
     /**
      * Build control characters array
      */
diff --git a/src/PhpWord/Style/AbstractStyle.php b/src/PhpWord/Style/AbstractStyle.php
@@ -9,6 +9,8 @@
 
 namespace PhpOffice\PhpWord\Style;
 
+use PhpOffice\PhpWord\Shared\String;
+
 /**
  * Abstract style class
  *
@@ -50,22 +52,18 @@ public function setIndex($value = null)
     /**
      * Set style value template method
      *
-     * Some child classes have their own specific overrides
+     * Some child classes have their own specific overrides.
+     * Backward compability check for versions < 0.10.0 which use underscore
+     * prefix for their private properties.
+     * Check if the set method is exists. Throws an exception?
      *
      * @param string $key
      * @param string $value
      * @return self
      */
     public function setStyleValue($key, $value)
     {
-        // Backward compability check for versions < 0.10.0 which use underscore
-        // prefix for their private properties
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
-
-        // Check if the set method is exists. Throws an exception?
-        $method = 'set' . $key;
+        $method = 'set' . String::removeUnderscorePrefix($key);
         if (method_exists($this, $method)) {
             $this->$method($value);
         }
diff --git a/src/PhpWord/Style/Cell.php b/src/PhpWord/Style/Cell.php
@@ -9,6 +9,8 @@
 
 namespace PhpOffice\PhpWord\Style;
 
+use PhpOffice\PhpWord\Shared\String;
+
 /**
  * Table cell style
  */
@@ -145,9 +147,7 @@ public function __construct()
      */
     public function setStyleValue($key, $value)
     {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
+        $key = String::removeUnderscorePrefix($key);
         if ($key == 'borderSize') {
             $this->setBorderSize($value);
         } elseif ($key == 'borderColor') {
diff --git a/src/PhpWord/Style/Font.php b/src/PhpWord/Style/Font.php
@@ -193,8 +193,6 @@ public function setArrayStyle(array $style = array())
             if ($key === 'line-height') {
                 $this->setLineHeight($value);
                 null;
-            } elseif (substr($key, 0, 1) == '_') {
-                $key = substr($key, 1);
             }
             $this->setStyleValue($key, $value);
         }
diff --git a/src/PhpWord/Style/Paragraph.php b/src/PhpWord/Style/Paragraph.php
@@ -10,6 +10,7 @@
 namespace PhpOffice\PhpWord\Style;
 
 use PhpOffice\PhpWord\Exception\InvalidStyleException;
+use PhpOffice\PhpWord\Shared\String;
 
 /**
  * Paragraph style
@@ -127,8 +128,6 @@ public function setArrayStyle(array $style = array())
         foreach ($style as $key => $value) {
             if ($key === 'line-height') {
                 null;
-            } elseif (substr($key, 0, 1) == '_') {
-                $key = substr($key, 1);
             }
             $this->setStyleValue($key, $value);
         }
@@ -144,9 +143,7 @@ public function setArrayStyle(array $style = array())
      */
     public function setStyleValue($key, $value)
     {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
+        $key = String::removeUnderscorePrefix($key);
         if ($key == 'indent' || $key == 'hanging') {
             $value = $value * 720;
         } elseif ($key == 'spacing') {
diff --git a/src/PhpWord/Style/Row.php b/src/PhpWord/Style/Row.php
@@ -45,16 +45,12 @@ public function __construct()
     /**
      * Set tblHeader
      *
-     * @param boolean $pValue
-     * @return $this
+     * @param boolean $value
+     * @return self
      */
-    public function setTblHeader($pValue = false)
+    public function setTblHeader($value = false)
     {
-        if (!is_bool($pValue)) {
-            $pValue = false;
-        }
-        $this->tblHeader = $pValue;
-        return $this;
+        $this->tblHeader = $this->setBoolVal($value, $this->tblHeader);
     }
 
     /**
@@ -70,16 +66,12 @@ public function getTblHeader()
     /**
      * Set cantSplit
      *
-     * @param boolean $pValue
-     * @return $this
+     * @param boolean $value
+     * @return self
      */
-    public function setCantSplit($pValue = false)
+    public function setCantSplit($value = false)
     {
-        if (!is_bool($pValue)) {
-            $pValue = false;
-        }
-        $this->cantSplit = $pValue;
-        return $this;
+        $this->cantSplit = $this->setBoolVal($value, $this->cantSplit);
     }
 
     /**
@@ -95,15 +87,12 @@ public function getCantSplit()
     /**
      * Set exactHeight
      *
-     * @param bool $pValue
-     * @return $this
+     * @param bool $value
+     * @return self
      */
-    public function setExactHeight($pValue = false)
+    public function setExactHeight($value = false)
     {
-        if (!is_bool($pValue)) {
-            $pValue = false;
-        }
-        $this->exactHeight = $pValue;
+        $this->exactHeight = $this->setBoolVal($value, $this->exactHeight);
         return $this;
     }
 
diff --git a/src/PhpWord/Style/Section.php b/src/PhpWord/Style/Section.php
@@ -9,6 +9,8 @@
 
 namespace PhpOffice\PhpWord\Style;
 
+use PhpOffice\PhpWord\Shared\String;
+
 /**
  * Section settings
  */
@@ -217,9 +219,7 @@ public function __construct()
      */
     public function setSettingValue($key, $value)
     {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
+        $key = String::removeUnderscorePrefix($key);
         if ($key == 'orientation' && $value == 'landscape') {
             $this->setLandscape();
         } elseif ($key == 'orientation' && is_null($value)) {
diff --git a/src/PhpWord/Style/TOC.php b/src/PhpWord/Style/TOC.php
@@ -110,15 +110,4 @@ public function setIndent($pValue)
     {
         $this->indent = $pValue;
     }
-
-    /**
-     * Set style value
-     *
-     * @param string $key
-     * @param string $value
-     */
-    public function setStyleValue($key, $value)
-    {
-        $this->$key = $value;
-    }
 }
diff --git a/src/PhpWord/Style/Table.php b/src/PhpWord/Style/Table.php
@@ -9,6 +9,8 @@
 
 namespace PhpOffice\PhpWord\Style;
 
+use PhpOffice\PhpWord\Shared\String;
+
 /**
  * Table style
  */
@@ -161,18 +163,12 @@ public function __construct($styleTable = null, $styleFirstRow = null)
             unset($this->firstRow->borderInsideHColor);
             unset($this->firstRow->borderInsideHSize);
             foreach ($styleFirstRow as $key => $value) {
-                if (substr($key, 0, 1) == '_') {
-                    $key = substr($key, 1);
-                }
                 $this->firstRow->setStyleValue($key, $value);
             }
         }
 
         if (!is_null($styleTable) && is_array($styleTable)) {
             foreach ($styleTable as $key => $value) {
-                if (substr($key, 0, 1) == '_') {
-                    $key = substr($key, 1);
-                }
                 $this->setStyleValue($key, $value);
             }
         }
@@ -186,9 +182,7 @@ public function __construct($styleTable = null, $styleFirstRow = null)
      */
     public function setStyleValue($key, $value)
     {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
+        $key = String::removeUnderscorePrefix($key);
         if ($key == 'borderSize') {
             $this->setBorderSize($value);
         } elseif ($key == 'borderColor') {
diff --git a/src/PhpWord/TOC.php b/src/PhpWord/TOC.php
@@ -82,9 +82,6 @@ public function __construct($styleFont = null, $styleTOC = null, $minDepth = 1,
 
         if (!is_null($styleTOC) && is_array($styleTOC)) {
             foreach ($styleTOC as $key => $value) {
-                if (substr($key, 0, 1) == '_') {
-                    $key = substr($key, 1);
-                }
                 self::$TOCStyle->setStyleValue($key, $value);
             }
         }
@@ -93,9 +90,6 @@ public function __construct($styleFont = null, $styleTOC = null, $minDepth = 1,
             if (is_array($styleFont)) {
                 self::$fontStyle = new Font();
                 foreach ($styleFont as $key => $value) {
-                    if (substr($key, 0, 1) == '_') {
-                        $key = substr($key, 1);
-                    }
                     self::$fontStyle->setStyleValue($key, $value);
                 }
             } else {
diff --git a/tests/PhpWord/Tests/Style/NumberingLevelTest.php b/tests/PhpWord/Tests/Style/NumberingLevelTest.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * PHPWord
+ *
+ * @link        https://github.com/PHPOffice/PHPWord
+ * @copyright   2014 PHPWord
+ * @license     http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
+ */
+
+namespace PhpOffice\PhpWord\Tests\Style;
+
+use PhpOffice\PhpWord\Style\NumberingLevel;
+
+/**
+ * Test class for PhpOffice\PhpWord\Style\NumberingLevel
+ *
+ * @runTestsInSeparateProcesses
+ */
+class NumberingLevelTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Test setting style with normal value
+     */
+    public function testSetGetNormal()
+    {
+        $object = new NumberingLevel();
+
+        $attributes = array(
+            'level' => 1,
+            'start' => 1,
+            'format' => 'decimal',
+            'restart' => 1,
+            'suffix' => 'space',
+            'text' => '%1.',
+            'align' => 'left',
+            'left' => 360,
+            'hanging' => 360,
+            'tabPos' => 360,
+            'font' => 'Arial',
+            'hint' => 'default',
+        );
+        foreach ($attributes as $key => $value) {
+            $set = "set{$key}";
+            $get = "get{$key}";
+            $object->$set($value);
+            $this->assertEquals($value, $object->$get());
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -66,9 +66,6 @@ public function setSettings($settings = null)`
`66`	`66`	`if (is_null($value)) {`
`67`	`67`	`continue;`
`68`	`68`	`}`
`69`		`- if (substr($key, 0, 1) == '_') {`
`70`		`- $key = substr($key, 1);`
`71`		`- }`
`72`	`69`	`$this->settings->setSettingValue($key, $value);`
`73`	`70`	`}`
`74`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -193,8 +193,6 @@ public function setArrayStyle(array $style = array())`
`193`	`193`	`if ($key === 'line-height') {`
`194`	`194`	`$this->setLineHeight($value);`
`195`	`195`	`null;`
`196`		`- } elseif (substr($key, 0, 1) == '_') {`
`197`		`- $key = substr($key, 1);`
`198`	`196`	`}`
`199`	`197`	`$this->setStyleValue($key, $value);`
`200`	`198`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,15 +110,4 @@ public function setIndent($pValue)`
`110`	`110`	`{`
`111`	`111`	`$this->indent = $pValue;`
`112`	`112`	`}`
`113`		`-`
`114`		`- /**`
`115`		`- * Set style value`
`116`		`- *`
`117`		`- * @param string $key`
`118`		`- * @param string $value`
`119`		`- */`
`120`		`- public function setStyleValue($key, $value)`
`121`		`- {`
`122`		`- $this->$key = $value;`
`123`		`- }`
`124`	`113`	`}`