Rasamassen PR 2838

I made RTF usable some time ago. @rasamassen has recently done a lot of useful work to cover many missing areas. Since who knows when those changes will be merged, I intend to incorporate much of that work. I will do this with several pushes, each based on one or more of those changes. This one is based on PR #2838.

Author: oleibman

phpstan-baseline.neon

@@ -480,11 +480,6 @@ parameters:
 			count: 1
 			path: src/PhpWord/Style/AbstractStyle.php
 
-		-
-			message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Border\\:\\:getBorderSize\\(\\) should return array\\<int\\> but returns array\\<int, float\\|int\\>\\.$#"
-			count: 1
-			path: src/PhpWord/Style/Border.php
-
 		-
 			message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Cell\\:\\:getBgColor\\(\\) should return string but returns null\\.$#"
 			count: 1

phpstan-baseline.php73.neon

@@ -470,11 +470,6 @@ parameters:
 			count: 1
 			path: src/PhpWord/Style/AbstractStyle.php
 
-		-
-			message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Border\\:\\:getBorderSize\\(\\) should return array\\<int\\> but returns array\\<int, float\\|int\\>\\.$#"
-			count: 1
-			path: src/PhpWord/Style/Border.php
-
 		-
 			message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Cell\\:\\:getBgColor\\(\\) should return string but returns null\\.$#"
 			count: 1

src/PhpWord/SimpleType/Border.php

@@ -48,7 +48,9 @@ final class Border extends AbstractEnum
     const THIN_THICK_LARGE_GAP = 'thinThickLargeGap'; //A thin line contained within a thick line with a large-sized intermediate gap
     const THIN_THICK_MEDIUM_GAP = 'thinThickMediumGap'; //A thick line contained within a thin line with a medium-sized intermediate gap
     const THIN_THICK_SMALL_GAP = 'thinThickSmallGap'; //A thick line contained within a thin line with a small intermediate gap
+    /** @deprecated 2.0 use THIN_THICK_THIN_LARGE_GAP */
     const THIN_THICK_THINLARGE_GAP = 'thinThickThinLargeGap'; //A thin-thick-thin line with a large gap
+    const THIN_THICK_THIN_LARGE_GAP = 'thinThickThinLargeGap'; //A thin-thick-thin line with a large gap
     const THIN_THICK_THIN_MEDIUM_GAP = 'thinThickThinMediumGap'; //A thin-thick-thin line with a medium gap
     const THIN_THICK_THIN_SMALL_GAP = 'thinThickThinSmallGap'; //A thin-thick-thin line with a small gap
     const THREE_D_EMBOSS = 'threeDEmboss'; //A three-staged gradient line, getting darker towards the paragraph

src/PhpWord/Style/Border.php

@@ -46,6 +46,13 @@ class Border extends AbstractStyle
      */
     protected $borderTopStyle;
 
+    /**
+     * Border Top Space. For section and paragraph borders only.
+     *
+     * @var float|int
+     */
+    protected $borderTopSpace;
+
     /**
      * Border Left Size.
      *
@@ -67,6 +74,13 @@ class Border extends AbstractStyle
      */
     protected $borderLeftStyle;
 
+    /**
+     * Border Left Space. For section and paragraph borders only.
+     *
+     * @var float|int
+     */
+    protected $borderLeftSpace;
+
     /**
      * Border Right Size.
      *
@@ -88,6 +102,13 @@ class Border extends AbstractStyle
      */
     protected $borderRightStyle;
 
+    /**
+     * Border Right Space. For section and paragraph borders only.
+     *
+     * @var float|int
+     */
+    protected $borderRightSpace;
+
     /**
      * Border Bottom Size.
      *
@@ -109,6 +130,13 @@ class Border extends AbstractStyle
      */
     protected $borderBottomStyle;
 
+    /**
+     * Border Bottom Space. For section and paragraph borders only.
+     *
+     * @var float|int
+     */
+    protected $borderBottomSpace;
+
     /**
      * Top margin spacing.
      *
@@ -140,7 +168,7 @@ class Border extends AbstractStyle
     /**
      * Get border size.
      *
-     * @return int[]
+     * @return array<float|int>
      */
     public function getBorderSize()
     {
@@ -233,6 +261,38 @@ public function setBorderStyle($value = null)
         return $this;
     }
 
+    /**
+     * Get border space.
+     *
+     * @return array<float|int>
+     */
+    public function getBorderSpace()
+    {
+        return [
+            $this->getBorderTopSpace(),
+            $this->getBorderLeftSpace(),
+            $this->getBorderRightSpace(),
+            $this->getBorderBottomSpace(),
+        ];
+    }
+
+    /**
+     * Set border space.
+     *
+     * @param float|int $value
+     *
+     * @return self
+     */
+    public function setBorderSpace($value = null)
+    {
+        $this->setBorderTopSpace($value);
+        $this->setBorderLeftSpace($value);
+        $this->setBorderRightSpace($value);
+        $this->setBorderBottomSpace($value);
+
+        return $this;
+    }
+
     /**
      * Get border top size.
      *
@@ -292,7 +352,7 @@ public function getBorderTopStyle()
     }
 
     /**
-     * Set border top Style.
+     * Set border top style.
      *
      * @param string $value
      *
@@ -305,6 +365,30 @@ public function setBorderTopStyle($value = null)
         return $this;
     }
 
+    /**
+     * Get border top space.
+     *
+     * @return float|int
+     */
+    public function getBorderTopSpace()
+    {
+        return $this->borderTopSpace;
+    }
+
+    /**
+     * Set border top space.
+     *
+     * @param float|int $value
+     *
+     * @return self
+     */
+    public function setBorderTopSpace($value = null)
+    {
+        $this->borderTopSpace = $value;
+
+        return $this;
+    }
+
     /**
      * Get border left size.
      *
@@ -377,6 +461,30 @@ public function setBorderLeftStyle($value = null)
         return $this;
     }
 
+    /**
+     * Get border left space.
+     *
+     * @return float|int
+     */
+    public function getBorderLeftSpace()
+    {
+        return $this->borderLeftSpace;
+    }
+
+    /**
+     * Set border left space.
+     *
+     * @param float|int $value
+     *
+     * @return self
+     */
+    public function setBorderLeftSpace($value = null)
+    {
+        $this->borderLeftSpace = $value;
+
+        return $this;
+    }
+
     /**
      * Get border right size.
      *
@@ -449,6 +557,30 @@ public function setBorderRightStyle($value = null)
         return $this;
     }
 
+    /**
+     * Get border right space.
+     *
+     * @return float|int
+     */
+    public function getBorderRightSpace()
+    {
+        return $this->borderRightSpace;
+    }
+
+    /**
+     * Set border right space.
+     *
+     * @param float|int $value
+     *
+     * @return self
+     */
+    public function setBorderRightSpace($value = null)
+    {
+        $this->borderRightSpace = $value;
+
+        return $this;
+    }
+
     /**
      * Get border bottom size.
      *
@@ -521,22 +653,38 @@ public function setBorderBottomStyle($value = null)
         return $this;
     }
 
+    /**
+     * Get border bottom space.
+     *
+     * @return float|int
+     */
+    public function getBorderBottomSpace()
+    {
+        return $this->borderBottomSpace;
+    }
+
+    /**
+     * Set border bottom space.
+     *
+     * @param float|int $value
+     *
+     * @return self
+     */
+    public function setBorderBottomSpace($value = null)
+    {
+        $this->borderBottomSpace = $value;
+
+        return $this;
+    }
+
     /**
      * Check if any of the border is not null.
      *
      * @return bool
      */
     public function hasBorder()
     {
-        $borders = $this->getBorderSize();
-        if ($borders !== array_filter($borders, 'is_null')) {
-            return true;
-        }
-        $borders = $this->getBorderColor();
-        if ($borders !== array_filter($borders, 'is_null')) {
-            return true;
-        }
-        $borders = $this->getBorderStyle();
+        $borders = array_merge($this->getBorderSize(), $this->getBorderColor(), $this->getBorderStyle(), $this->getBorderSpace());
 
         return $borders !== array_filter($borders, 'is_null');
     }