Some adjustments for the new Line element #253

Author: ivanlanin

CHANGELOG.md

@@ -4,7 +4,7 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
 
 ## 0.11.0 - Not yet released
 
-This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Three new elements were added: TextBox, ListItemRun, Line and Field. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemeted. RTF reader were initiated.
+This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Four new elements were added: TextBox, ListItemRun, Field, and Line. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemeted. RTF reader were initiated.
 
 ### Features
 
@@ -30,8 +30,8 @@ This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Three
 - RTF Writer: Ability to write document properties - @ivanlanin
 - RTF Writer: Ability to write image - @ivanlanin
 - Element: New `Field` element - @basjan GH-251
-- Element: New `Line` element - @basjan
-- RTF Reader: Basic RTF reader - @ivanlanin GH-72
+- RTF Reader: Basic RTF reader - @ivanlanin GH-72 GH-252
+- Element: New `Line` element - @basjan GH-253
 
 ### Bugfixes
 

CHANGELOG.md~

@@ -45,6 +45,8 @@ column shows the containers while the rows lists the elements.
 +-------+-----------------+-----------+----------+----------+---------+------------+------------+
 | 18    | Field           | v         | v        | v        | v       | v          | v          |
 +-------+-----------------+-----------+----------+----------+---------+------------+------------+
+| 19    | Line            | v         | v        | v        | v       | v          | v          |
++-------+-----------------+-----------+----------+----------+---------+------------+------------+
 
 Legend:
 
@@ -487,3 +489,8 @@ Fields
 ------
 
 To be completed
+
+Line
+------
+
+To be completed

docs/elements.rst

@@ -35,6 +35,7 @@ Don't forget to change `code::` directive to `code-block::` in the resulting rst
     - [Checkboxes](#checkboxes)
     - [Textboxes](#textboxes)
     - [Fields](#fields)
+    - [Lines](#lines)
 - [Templates](#templates)
 - [Writers & readers](#writers-readers)
     - [OOXML](#ooxml)
@@ -463,6 +464,7 @@ Below are the matrix of element availability in each container. The column shows
 | 16  | CheckBox      | v       | v      | v      | v    | -        | -        |
 | 17  | TextBox       | v       | v      | v      | v    | -        | -        |
 | 18  | Field         | v       | v      | v      | v    | v        | v        |
+| 19  | Line          | v       | v      | v      | v    | v        | v        |
 
 Legend:
 
@@ -844,6 +846,10 @@ To be completed.
 
 To be completed.
 
+## Lines
+
+To be completed.
+
 # Templates
 
 You can create a docx template with included search-patterns that can be replaced by any value you wish. Only single-line values can be replaced. To load a template file, use the `loadTemplate` method. After loading the docx template, you can use the `setValue` method to change the value of a search pattern. The search-pattern model is: `${search-pattern}`. It is not possible to add new PHPWord elements to a loaded template file.

docs/src/documentation.md

@@ -149,11 +149,11 @@ public function addTextRun($paragraphStyle = null)
      * @param string $type
      * @param array $properties
      * @param array $options
+     * @return \PhpOffice\PhpWord\Element\Field
      */
     public function addField($type = null, $properties = array(), $options = array())
     {
         return $this->addElement('Field', $type, $properties, $options);
-
     }
 
     /**

samples/Sample_28_Line.php renamed to samples/Sample_29_Line.php

@@ -95,6 +95,7 @@ public function __construct($type = null, $properties = array(), $options = arra
      *
      * @param string $type
      * @return string
+     * @throws \InvalidArgumentException
      */
     public function setType($type = null)
     {
@@ -123,6 +124,7 @@ public function getType()
      *
      * @param array $properties
      * @return self
+     * @throws \InvalidArgumentException
      */
     public function setProperties($properties = array())
     {
@@ -152,6 +154,7 @@ public function getProperties()
      *
      * @param array $options
      * @return self
+     * @throws \InvalidArgumentException
      */
     public function setOptions($options = array())
     {

src/PhpWord/Element/AbstractContainer.php

@@ -27,25 +27,24 @@ class Line extends AbstractElement
     /**
      * Line style
      *
-     * @var LineStyle
+     * @var \PhpOffice\PhpWord\Style\Line
      */
     private $style;
-    
+
     /**
      * Create new line element
      *
-     * @param string $source
      * @param mixed $style
      */
     public function __construct($style = null)
     {
         $this->style = $this->setStyle(new LineStyle(), $style);
     }
-    
+
     /**
-     * Get Image style
+     * Get line style
      *
-     * @return ImageStyle
+     * @return \PhpOffice\PhpWord\Style\Line
      */
     public function getStyle()
     {