Paragraph: Ability to define (1) normal paragraph style with PHPWord::setNormalStyle() and (2) parent style (basedOn) and style for following paragraph (next)

ivanlanin · ivanlanin · commit 09ba95bd88c0 · 2014-03-07T18:02:47.000+07:00
diff --git a/Classes/PHPWord.php b/Classes/PHPWord.php
@@ -198,6 +198,16 @@ public function addTitleStyle($titleCount, $styleFont, $styleParagraph = null)
         PHPWord_Style::addTitleStyle($titleCount, $styleFont, $styleParagraph);
     }
 
+    /**
+     * Set normal paragraph style definition to styles.xml
+     *
+     * @param   array   $styles Paragraph style definition
+     */
+    public function setNormalStyle($styles)
+    {
+        PHPWord_Style::setNormalStyle($styles);
+    }
+
     /**
      * Adds a hyperlink style to styles.xml
      *
diff --git a/Classes/PHPWord/Style.php b/Classes/PHPWord/Style.php
@@ -140,6 +140,16 @@ public static function addTitleStyle($titleCount, $styleFont, $styleParagraph =
         }
     }
 
+    /**
+     * Set normal (default) paragraph style
+     *
+     * @param   array   $styles Paragraph style definition
+     */
+    public static function setNormalStyle($styles)
+    {
+        self::addParagraphStyle('Normal', $styles);
+    }
+
     /**
      * Get all styles
      *
diff --git a/Classes/PHPWord/Style/Paragraph.php b/Classes/PHPWord/Style/Paragraph.php
@@ -80,6 +80,20 @@ class PHPWord_Style_Paragraph
      */
     private $_hanging;
 
+    /**
+     * Parent style
+     *
+     * @var string
+     */
+    private $_basedOn;
+
+    /**
+     * Style for next paragraph
+     *
+     * @var string
+     */
+    private $_next;
+
     /**
      * New Paragraph Style
      */
@@ -92,6 +106,8 @@ public function __construct()
         $this->_tabs = null;
         $this->_indent = null;
         $this->_hanging = null;
+        $this->_basedOn = 'Normal';
+        $this->_next = null;
     }
 
     /**
@@ -231,6 +247,16 @@ public function setIndent($pValue = null)
         return $this;
     }
 
+    /**
+     * Get hanging
+     *
+     * @return int
+     */
+    public function getHanging()
+    {
+        return $this->_hanging;
+    }
+
     /**
      * Set hanging
      *
@@ -244,22 +270,57 @@ public function setHanging($pValue = null)
     }
 
     /**
-     * Get hanging
+     * Get tabs
      *
-     * @return int
+     * @return PHPWord_Style_Tabs
      */
-    public function getHanging()
+    public function getTabs()
     {
-        return $this->_hanging;
+        return $this->_tabs;
     }
 
     /**
-     * Get tabs
+     * Get parent style ID
      *
-     * @return PHPWord_Style_Tabs
+     * @return  string
      */
-    public function getTabs()
+    public function getBasedOn()
     {
-        return $this->_tabs;
+        return $this->_basedOn;
+    }
+
+    /**
+     * Set parent style ID
+     *
+     * @param   string  $pValue
+     * @return  PHPWord_Style_Paragraph
+     */
+    public function setBasedOn($pValue = 'Normal')
+    {
+        $this->_basedOn = $pValue;
+        return $this;
     }
+
+    /**
+     * Get style for next paragraph
+     *
+     * @return string
+     */
+    public function getNext()
+    {
+        return $this->_next;
+    }
+
+    /**
+     * Set style for next paragraph
+     *
+     * @param   string  $pValue
+     * @return  PHPWord_Style_Paragraph
+     */
+    public function setNext($pValue = null)
+    {
+        $this->_next = $pValue;
+        return $this;
+    }
+
 }
diff --git a/Classes/PHPWord/Writer/Word2007/Styles.php b/Classes/PHPWord/Writer/Word2007/Styles.php
@@ -59,8 +59,30 @@ public function writeStyles(PHPWord $pPHPWord = null)
 
         // Write Style Definitions
         $styles = PHPWord_Style::getStyles();
+
+        // Write normal paragraph style
+        $normalStyle = null;
+        if (array_key_exists('Normal', $styles)) {
+            $normalStyle = $styles['Normal'];
+        }
+        $objWriter->startElement('w:style');
+        $objWriter->writeAttribute('w:type', 'paragraph');
+        $objWriter->writeAttribute('w:default', '1');
+        $objWriter->writeAttribute('w:styleId', 'Normal');
+        $objWriter->startElement('w:name');
+        $objWriter->writeAttribute('w:val', 'Normal');
+        $objWriter->endElement();
+        if (!is_null($normalStyle)) {
+            $this->_writeParagraphStyle($objWriter, $normalStyle);
+        }
+        $objWriter->endElement();
+
+        // Write other styles
         if (count($styles) > 0) {
             foreach ($styles as $styleName => $style) {
+                if ($styleName == 'Normal') {
+                    continue;
+                }
                 if ($style instanceof PHPWord_Style_Font) {
 
                     $paragraphStyle = $style->getParagraphStyle();
@@ -92,6 +114,10 @@ public function writeStyles(PHPWord $pPHPWord = null)
                     $objWriter->endElement();
 
                     if (!is_null($paragraphStyle)) {
+                        // Point parent style to Normal
+                        $objWriter->startElement('w:basedOn');
+                        $objWriter->writeAttribute('w:val', 'Normal');
+                        $objWriter->endElement();
                         $this->_writeParagraphStyle($objWriter, $paragraphStyle);
                     }
 
@@ -109,6 +135,22 @@ public function writeStyles(PHPWord $pPHPWord = null)
                     $objWriter->writeAttribute('w:val', $styleName);
                     $objWriter->endElement();
 
+                    // Parent style
+                    $basedOn = $style->getBasedOn();
+                    if (!is_null($basedOn)) {
+                        $objWriter->startElement('w:basedOn');
+                        $objWriter->writeAttribute('w:val', $basedOn);
+                        $objWriter->endElement();
+                    }
+
+                    // Next paragraph style
+                    $next = $style->getNext();
+                    if (!is_null($next)) {
+                        $objWriter->startElement('w:next');
+                        $objWriter->writeAttribute('w:val', $next);
+                        $objWriter->endElement();
+                    }
+
                     $this->_writeParagraphStyle($objWriter, $style);
                     $objWriter->endElement();
 
diff --git a/changelog.txt b/changelog.txt
@@ -38,7 +38,9 @@ Changes in branch for release 0.7.1 :
 - Feature:  (ivanlanin)       GH-48 GH-86       - Paragraph: Hanging paragraph
 - Feature:  (ivanlanin)       GH-48 GH-86       - Section: Multicolumn and section break
 - QA:       (Progi1984)                         - UnitTests
-- Feature:  (ivanlanin)                         - General: PHPWord_Shared_Font::pointSizeToTwips converter
+- Feature:  (ivanlanin)                         - General: PHPWord_Shared_Font::pointSizeToTwips() converter
+- Feature:  (ivanlanin)                         - Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle()
+- Feature:  (ivanlanin)                         - Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next)
 
 Changes in branch for release 0.7.0 :
 - Bugfix:   (RomanSyroeshko)  GH-32             - "Warning: Invalid error type specified in ...\PHPWord.php on line 226" is thrown when the specified template file is not found

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,16 @@ public static function addTitleStyle($titleCount, $styleFont, $styleParagraph =`
`140`	`140`	`}`
`141`	`141`	`}`
`142`	`142`
	`143`	`+ /**`
	`144`	`+ * Set normal (default) paragraph style`
	`145`	`+ *`
	`146`	`+ * @param array $styles Paragraph style definition`
	`147`	`+ */`
	`148`	`+ public static function setNormalStyle($styles)`
	`149`	`+ {`
	`150`	`+ self::addParagraphStyle('Normal', $styles);`
	`151`	`+ }`
	`152`	`+`
`143`	`153`	`/**`
`144`	`154`	`* Get all styles`
`145`	`155`	`*`