New Indentation and Spacing style; Ability to define first line and right indentation

Author: ivanlanin

CHANGELOG.md

@@ -4,7 +4,7 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
 
 ## 0.10.0 - Not yet released
 
-This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable. Basic HTML and PDF writing support is enabled.
+This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable. Basic HTML and PDF writing support is enabled. Basic ODText reader is introduced.
 
 ### Features
 
@@ -43,6 +43,8 @@ This release marked heavy refactorings on internal code structure with the creat
 - 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
+- Style: New `Indentation` and `Spacing` style - @ivanlanin
+- Paragraph: Ability to define first line and right indentation - @ivanlanin
 
 ### Bugfixes
 
@@ -63,6 +65,7 @@ This release marked heavy refactorings on internal code structure with the creat
 - All current methods on `Media`
 - `Element\Link::getLinkSrc` replaced by `Element\Link::getTarget`
 - `Element\Link::getLinkName` replaced by `Element\Link::getText`
+- `Style\Cell::getDefaultBorderColor`
 
 ### Miscellaneous
 

samples/Sample_08_ParagraphPagination.php

@@ -16,26 +16,26 @@
 $section->addText('Below are the samples on how to control your paragraph ' .
     'pagination. See "Line and Page Break" tab on paragraph properties ' .
     'window to see the attribute set by these controls.',
-    array('bold' => true), null);
+    array('bold' => true), array('space' => array('before' => 360, 'after' => 480)));
 
 $section->addText('Paragraph with widowControl = false (default: true). ' .
     'A "widow" is the last line of a paragraph printed by itself at the top ' .
     'of a page. An "orphan" is the first line of a paragraph printed by ' .
     'itself at the bottom of a page. Set this option to "false" if you want ' .
     'to disable this automatic control.',
-    null, array('widowControl' => false));
+    null, array('widowControl' => false, 'indentation' => array('left' => 240, 'right' => 120)));
 
 $section->addText('Paragraph with keepNext = true (default: false). ' .
     '"Keep with next" is used to prevent Word from inserting automatic page ' .
     'breaks between paragraphs. Set this option to "true" if you do not want ' .
     'your paragraph to be separated with the next paragraph.',
-    null, array('keepNext' => true));
+    null, array('keepNext' => true, 'indentation' => array('firstLine' => 240)));
 
 $section->addText('Paragraph with keepLines = true (default: false). ' .
     '"Keep lines together" will prevent Word from inserting an automatic page ' .
     'break within a paragraph. Set this option to "true" if you do not want ' .
     'all lines of your paragraph to be in the same page.',
-    null, array('keepLines' => true));
+    null, array('keepLines' => true, 'indentation' => array('left' => 240, 'hanging' => 240)));
 
 $section->addText('Keep scrolling. More below.');
 

src/PhpWord/Settings.php

@@ -37,6 +37,8 @@ class Settings
      * Applied to:
      * - Section: margins, header/footer height, gutter, column spacing
      * - Tab: position
+     * - Indentation: left, right, firstLine, hanging
+     * - Spacing: before, after
      *
      * @const int|float
      */

src/PhpWord/Style/Cell.php

@@ -16,29 +16,34 @@
  */
 class Cell extends Border
 {
+    /**
+     * Text direction constants
+     *
+     * @const string
+     */
     const TEXT_DIR_BTLR = 'btLr';
     const TEXT_DIR_TBRL = 'tbRl';
 
     /**
-     * Vertical align (top, center, both, bottom)
+     * Default border color
      *
-     * @var string
+     * @const string
      */
-    private $valign;
+    const DEFAULT_BORDER_COLOR = '000000';
 
     /**
-     * Text Direction
+     * Vertical align (top, center, both, bottom)
      *
      * @var string
      */
-    private $textDirection;
+    private $valign;
 
     /**
-     * Border Default Color
+     * Text Direction
      *
      * @var string
      */
-    private $defaultBorderColor;
+    private $textDirection;
 
     /**
      * colspan
@@ -64,24 +69,6 @@ class Cell extends Border
      */
     private $shading;
 
-    /**
-     * Create a new Cell Style
-     */
-    public function __construct()
-    {
-        $this->valign = null;
-        $this->textDirection = null;
-        $this->borderTopSize = null;
-        $this->borderTopColor = null;
-        $this->borderLeftSize = null;
-        $this->borderLeftColor = null;
-        $this->borderRightSize = null;
-        $this->borderRightColor = null;
-        $this->borderBottomSize = null;
-        $this->borderBottomColor = null;
-        $this->defaultBorderColor = '000000';
-    }
-
     /**
      * Get vertical align
      */
@@ -93,11 +80,11 @@ public function getVAlign()
     /**
      * Set vertical align
      *
-     * @param string $pValue
+     * @param string $value
      */
-    public function setVAlign($pValue = null)
+    public function setVAlign($value = null)
     {
-        $this->valign = $pValue;
+        $this->valign = $value;
     }
 
     /**
@@ -111,11 +98,11 @@ public function getTextDirection()
     /**
      * Set text direction
      *
-     * @param string $pValue
+     * @param string $value
      */
-    public function setTextDirection($pValue = null)
+    public function setTextDirection($value = null)
     {
-        $this->textDirection = $pValue;
+        $this->textDirection = $value;
     }
 
     /**
@@ -134,29 +121,21 @@ public function getBgColor()
      * Set background
      *
      * @param string $value
-     * @return \PhpOffice\PhpWord\Style\Table
+     * @return self
      */
     public function setBgColor($value = null)
     {
-        $this->setShading(array('fill' => $value));
-    }
-
-    /**
-     * Get default border color
-     */
-    public function getDefaultBorderColor()
-    {
-        return $this->defaultBorderColor;
+        return $this->setShading(array('fill' => $value));
     }
 
     /**
      * Set grid span (colspan)
      *
-     * @param int $pValue
+     * @param int $value
      */
-    public function setGridSpan($pValue = null)
+    public function setGridSpan($value = null)
     {
-        $this->gridSpan = $pValue;
+        $this->gridSpan = $value;
     }
 
     /**
@@ -170,11 +149,11 @@ public function getGridSpan()
     /**
      * Set vertical merge (rowspan)
      *
-     * @param string $pValue
+     * @param string $value
      */
-    public function setVMerge($pValue = null)
+    public function setVMerge($value = null)
     {
-        $this->vMerge = $pValue;
+        $this->vMerge = $value;
     }
 
     /**
@@ -214,4 +193,15 @@ public function setShading($value = null)
 
         return $this;
     }
+
+    /**
+     * Get default border color
+     *
+     * @deprecated 0.10.0
+     * @codeCoverageIgnore
+     */
+    public function getDefaultBorderColor()
+    {
+        return self::DEFAULT_BORDER_COLOR;
+    }
 }

src/PhpWord/Style/Indentation.php

@@ -0,0 +1,149 @@
+<?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\Style;
+
+/**
+ * Paragraph indentation style
+ *
+ * @link http://www.schemacentral.com/sc/ooxml/t-w_CT_Ind.html
+ * @since 0.10.0
+ */
+class Indentation extends AbstractStyle
+{
+    /**
+     * Left indentation (twip)
+     *
+     * @var int|float
+     */
+    private $left = 0;
+
+    /**
+     * Right indentation (twip)
+     *
+     * @var int|float
+     */
+    private $right = 0;
+
+    /**
+     * Additional first line indentation (twip)
+     *
+     * @var int|float
+     */
+    private $firstLine;
+
+    /**
+     * Indentation removed from first line (twip)
+     *
+     * @var int|float
+     */
+    private $hanging;
+
+    /**
+     * Create a new instance
+     *
+     * @param array $style
+     */
+    public function __construct($style = array())
+    {
+        $this->setStyleByArray($style);
+    }
+
+    /**
+     * Get left
+     *
+     * @return int|float
+     */
+    public function getLeft()
+    {
+        return $this->left;
+    }
+
+    /**
+     * Set left
+     *
+     * @param int|float $value
+     * @return self
+     */
+    public function setLeft($value = null)
+    {
+        $this->left = $this->setNumericVal($value, $this->left);
+
+        return $this;
+    }
+
+    /**
+     * Get right
+     *
+     * @return int|float
+     */
+    public function getRight()
+    {
+        return $this->right;
+    }
+
+    /**
+     * Set right
+     *
+     * @param int|float $value
+     * @return self
+     */
+    public function setRight($value = null)
+    {
+        $this->right = $this->setNumericVal($value, $this->right);
+
+        return $this;
+    }
+
+    /**
+     * Get first line
+     *
+     * @return int|float
+     */
+    public function getFirstLine()
+    {
+        return $this->firstLine;
+    }
+
+    /**
+     * Set first line
+     *
+     * @param int|float $value
+     * @return self
+     */
+    public function setFirstLine($value = null)
+    {
+        $this->firstLine = $this->setNumericVal($value, $this->firstLine);
+
+        return $this;
+    }
+
+    /**
+     * Get hanging
+     *
+     * @return int|float
+     */
+    public function getHanging()
+    {
+        return $this->hanging;
+    }
+
+    /**
+     * Set hanging
+     *
+     * @param int|float $value
+     * @return self
+     */
+    public function setHanging($value = null)
+    {
+        $this->hanging = $this->setNumericVal($value, $this->hanging);
+
+        return $this;
+    }
+}