Responding to Scrutinizer Comments

Mostly docblock changes, specifying that members can be null if so.

Author: oleibman

src/PhpWord/Style/Font.php

@@ -248,7 +248,7 @@ class Font extends AbstractStyle
     /**
      * Languages
      *
-     * @var \PhpOffice\PhpWord\Style\Language
+     * @var \PhpOffice\PhpWord\Style\Language|null
      */
     private $lang;
 
@@ -856,7 +856,7 @@ public function setShading($value = null)
     /**
      * Get language
      *
-     * @return \PhpOffice\PhpWord\Style\Language
+     * @return \PhpOffice\PhpWord\Style\Language|null
      */
     public function getLang()
     {

src/PhpWord/Style/Paragraph.php

@@ -85,7 +85,7 @@ class Paragraph extends Border
     /**
      * Indentation
      *
-     * @var \PhpOffice\PhpWord\Style\Indentation
+     * @var \PhpOffice\PhpWord\Style\Indentation|null
      */
     private $indentation;
 
@@ -99,7 +99,7 @@ class Paragraph extends Border
     /**
      * Text line height
      *
-     * @var int
+     * @var int|float|null
      */
     private $lineHeight;
 
@@ -343,9 +343,9 @@ public function setNext($value = null)
     }
 
     /**
-     * Get shading
+     * Get indentation
      *
-     * @return \PhpOffice\PhpWord\Style\Indentation
+     * @return \PhpOffice\PhpWord\Style\Indentation|null
      */
     public function getIndentation()
     {
@@ -519,7 +519,7 @@ public function setSpacingLineRule($value)
     /**
      * Get line height
      *
-     * @return int|float
+     * @return int|float|null
      */
     public function getLineHeight()
     {

src/PhpWord/Writer/HTML.php

@@ -86,19 +86,17 @@ public function getContent()
         $content .= '<!-- Generated by PHPWord -->' . PHP_EOL;
         $langtext = '';
         $phpWord = $this->getPhpWord();
-        if ($phpWord) {
-            $lang = $phpWord->getSettings()->getThemeFontLang();
-            if ($lang) {
-                $lang2 = $lang->getLatin();
-                if (!$lang2) {
-                    $lang2 = $lang->getEastAsia();
-                }
-                if (!$lang2) {
-                    $lang2 = $lang->getBidirectional();
-                }
-                if ($lang2) {
-                    $langtext = " lang='" . $lang2 . "'";
-                }
+        $lang = $phpWord->getSettings()->getThemeFontLang();
+        if (!empty($lang)) {
+            $lang2 = $lang->getLatin();
+            if (!$lang2) {
+                $lang2 = $lang->getEastAsia();
+            }
+            if (!$lang2) {
+                $lang2 = $lang->getBidirectional();
+            }
+            if ($lang2) {
+                $langtext = " lang='" . $lang2 . "'";
             }
         }
         $content .= "<html$langtext>" . PHP_EOL;

src/PhpWord/Writer/HTML/Element/Text.php

@@ -76,6 +76,9 @@ public function write()
         $content .= $this->openingText;
         $content .= $this->openingTags;
         if (Settings::isOutputEscapingEnabled()) {
+            // Scrutinizer notes that escapeHTML does not exist on AbstractEscaper.
+            // Nevertheless, it does exist for HTML writer.
+            /** @scrutinizer ignore-call */
             $contenx = $this->escaper->escapeHtml($element->getText());
         } else {
             $contenx = $element->getText();
@@ -264,10 +267,13 @@ private function getFontStyle()
                 $style = " style=\"$styl2\"";
             }
             $lang = $fontStyle->getLang();
-        } elseif (is_string($fontStyle)) {
+        } elseif (!empty($fontStyle)) {
             $style = " class=\"$fontStyle\"";
             $styl2 = Style::getStyle($fontStyle);
-            if ($styl2) {
+            if (!empty($styl2)) {
+                // Scrutinizer notes that getLang does not exist on Abstract Style.
+                // Nevertheless, it does exist for Font Style.
+                /** @scrutinizer ignore-call */
                 $lang = $styl2->getLang();
             }
         }

src/PhpWord/Writer/HTML/Part/AbstractPart.php

@@ -18,7 +18,7 @@
 namespace PhpOffice\PhpWord\Writer\HTML\Part;
 
 use PhpOffice\PhpWord\Exception\Exception;
-use PhpOffice\PhpWord\Writer\AbstractWriter;
+use PhpOffice\PhpWord\Writer\HTML;
 use Zend\Escaper\Escaper;
 
 /**
@@ -27,7 +27,7 @@
 abstract class AbstractPart
 {
     /**
-     * @var \PhpOffice\PhpWord\Writer\AbstractWriter
+     * @var \PhpOffice\PhpWord\Writer\HTML
      */
     private $parentWriter;
 
@@ -47,17 +47,17 @@ public function __construct()
     abstract public function write();
 
     /**
-     * @param \PhpOffice\PhpWord\Writer\AbstractWriter $writer
+     * @param \PhpOffice\PhpWord\Writer\HTML $writer
      */
-    public function setParentWriter(AbstractWriter $writer = null)
+    public function setParentWriter(HTML $writer = null)
     {
         $this->parentWriter = $writer;
     }
 
     /**
      * @throws \PhpOffice\PhpWord\Exception\Exception
      *
-     * @return \PhpOffice\PhpWord\Writer\AbstractWriter
+     * @return \PhpOffice\PhpWord\Writer\HTML
      */
     public function getParentWriter()
     {

src/PhpWord/Writer/HTML/Style/Font.php

@@ -63,7 +63,9 @@ public function write()
         $css['display'] = $this->getValueIf($style->isHidden(), 'none');
 
         $whitespace = $style->getHtmlWhiteSpace();
-        $css['white-space'] = $this->getValueIf($whitespace, $whitespace);
+        if ($whitespace) {
+            $css['white-space'] = $whitespace;
+        }
 
         $spacing = $style->getSpacing();
         $css['letter-spacing'] = $this->getValueIf(!is_null($spacing), ($spacing / 20) . 'pt');

src/PhpWord/Writer/HTML/Style/Paragraph.php

@@ -94,7 +94,7 @@ public function write()
                 $css['margin-right'] = ((string) $inches) . 'in';
             }
         }
-        if ($style->getPageBreakBefore()) {
+        if ($style->hasPageBreakBefore()) {
             $css['page-break-before'] = 'always';
         }