QA: Code cleanup and some additional tests

Author: ivanlanin

src/PhpWord/DocumentProperties.php

@@ -416,8 +416,9 @@ public function getCustomPropertyValue($propertyName)
     {
         if ($this->isCustomPropertySet($propertyName)) {
             return $this->customProperties[$propertyName]['value'];
+        } else {
+            return null;
         }
-
     }
 
     /**
@@ -430,8 +431,9 @@ public function getCustomPropertyType($propertyName)
     {
         if ($this->isCustomPropertySet($propertyName)) {
             return $this->customProperties[$propertyName]['type'];
+        } else {
+            return null;
         }
-
     }
 
     /**

src/PhpWord/Element/AbstractContainer.php

@@ -313,6 +313,7 @@ public function addTextBox($style = null)
      *
      * @param string $method
      * @return bool
+     * @throws \BadMethodCallException
      */
     private function checkValidity($method)
     {
@@ -389,6 +390,7 @@ private function getMediaContainer()
      *
      * @param string $src
      * @param mixed $style
+     * @return \PhpOffice\PhpWord\Element\Image
      * @deprecated 0.9.0
      * @codeCoverageIgnore
      */
@@ -401,6 +403,7 @@ public function addMemoryImage($src, $style = null)
      * Create textrun element
      *
      * @param mixed $paragraphStyle
+     * @return \PhpOffice\PhpWord\Element\TextRun
      * @deprecated 0.10.0
      * @codeCoverageIgnore
      */
@@ -413,6 +416,7 @@ public function createTextRun($paragraphStyle = null)
      * Create footnote element
      *
      * @param mixed $paragraphStyle
+     * @return \PhpOffice\PhpWord\Element\Footnote
      * @deprecated 0.10.0
      * @codeCoverageIgnore
      */

src/PhpWord/Element/AbstractElement.php

@@ -220,6 +220,7 @@ public function isInSection()
      * @param mixed $styleObject Style object
      * @param mixed $styleValue Style value
      * @param bool $returnObject Always return object
+     * @return mixed
      */
     protected function setStyle($styleObject, $styleValue = null, $returnObject = false)
     {

src/PhpWord/Element/Image.php

@@ -283,6 +283,8 @@ public function setMediaIndex($value)
      * Check memory image, supported type, image functions, and proportional width/height
      *
      * @param string $source
+     * @throws \PhpOffice\PhpWord\Exception\InvalidImageException
+     * @throws \PhpOffice\PhpWord\Exception\UnsupportedImageTypeException
      */
     private function checkImage($source)
     {

src/PhpWord/Element/Object.php

@@ -58,6 +58,7 @@ class Object extends AbstractElement
      *
      * @param string $source
      * @param mixed $style
+     * @throws \PhpOffice\PhpWord\Exception\InvalidObjectException
      */
     public function __construct($source, $style = null)
     {

src/PhpWord/Element/PreserveText.php

@@ -54,7 +54,7 @@ class PreserveText extends AbstractElement
      * @param string $text
      * @param mixed $fontStyle
      * @param mixed $paragraphStyle
-     * @return $this
+     * @return self
      */
     public function __construct($text = null, $fontStyle = null, $paragraphStyle = null)
     {

src/PhpWord/Element/Section.php

@@ -18,7 +18,6 @@
 namespace PhpOffice\PhpWord\Element;
 
 use PhpOffice\PhpWord\Exception\Exception;
-use PhpOffice\PhpWord\PhpWord;
 use PhpOffice\PhpWord\Style\Section as SectionSettings;
 
 /**

src/PhpWord/PhpWord.php

@@ -301,13 +301,13 @@ public function addTableStyle($styleName, $styleTable, $styleFirstRow = null)
     /**
      * Adds a heading style definition to styles.xml
      *
-     * @param int $titleCount
+     * @param int $depth
      * @param mixed $fontStyle
      * @param mixed $paragraphStyle
      */
-    public function addTitleStyle($titleCount, $fontStyle, $paragraphStyle = null)
+    public function addTitleStyle($depth, $fontStyle, $paragraphStyle = null)
     {
-        Style::addTitleStyle($titleCount, $fontStyle, $paragraphStyle);
+        Style::addTitleStyle($depth, $fontStyle, $paragraphStyle);
     }
 
     /**

src/PhpWord/Reader/ODText/AbstractPart.php

@@ -27,6 +27,8 @@ abstract class AbstractPart extends \PhpOffice\PhpWord\Reader\Word2007\AbstractP
     /**
      * Read w:r (override)
      *
+     * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
+     * @param \DOMElement $domNode
      * @param mixed $parent
      * @param string $docPart
      * @param mixed $paragraphStyle

src/PhpWord/Reader/Word2007/AbstractPart.php

@@ -138,12 +138,14 @@ protected function readRun(XMLReader $xmlReader, \DOMElement $domNode, &$parent,
     /**
      * Read w:pPr
      *
+     * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
+     * @param \DOMElement $domNode
      * @return array|null
      */
     protected function readParagraphStyle(XMLReader $xmlReader, \DOMElement $domNode)
     {
         if (!$xmlReader->elementExists('w:pPr', $domNode)) {
-            return;
+            return '';
         }
 
         $style = array();
@@ -200,19 +202,21 @@ protected function readParagraphStyle(XMLReader $xmlReader, \DOMElement $domNode
     /**
      * Read w:rPr
      *
+     * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
+     * @param \DOMElement $domNode
      * @return array|null
      */
     protected function readFontStyle(XMLReader $xmlReader, \DOMElement $domNode)
     {
         if (is_null($domNode)) {
-            return;
+            return null;
         }
         // Hyperlink has an extra w:r child
         if ($domNode->nodeName == 'w:hyperlink') {
             $domNode = $xmlReader->getElement('w:r', $domNode);
         }
         if (!$xmlReader->elementExists('w:rPr', $domNode)) {
-            return;
+            return null;
         }
 
         $style = array();
@@ -272,6 +276,8 @@ protected function readFontStyle(XMLReader $xmlReader, \DOMElement $domNode)
     /**
      * Read w:tblPr
      *
+     * @param \PhpOffice\PhpWord\Shared\XMLReader $xmlReader
+     * @param \DOMElement $domNode
      * @return string|array|null
      * @todo Capture w:tblStylePr w:type="firstRow"
      */