Add support for changing the document language (#1108)

Author: troosan

CHANGELOG.md

@@ -14,8 +14,8 @@ This is the last version to support PHP 5.3
 - Introduced the `\PhpOffice\PhpWord\SimpleType\NumberFormat` simple type. - @troosan
 - Support for ContextualSpacing - @postHawk #1088
 - Possiblity to hide spelling and/or grammatical errors - @troosan #542
+- Possiblity to set default document language as well as changing the language for each text element - @troosan #1108
 - Support for Comments - @troosan #1067
-- Add support for changing the document language - @troosan #1108
 
 ### Fixed
 - Loosen dependency to Zend

docs/general.rst

@@ -201,6 +201,25 @@ The default symbol to represent a decimal figure is the ``.`` in english. In fre
 
     $phpWord->getSettings()->setDecimalSymbol(',');
 
+Document Language
+~~~~~~~~~~~~~~~~~
+The default language of the document can be change with the following.
+
+.. code-block:: php
+
+    $phpWord->getSettings()->setThemeFontLang(new Language(Language::FR_BE));
+
+``Languge`` has 3 parameters, one for Latin languages, one for East Asian languages and one for Complex (Bi-Directional) languages.
+A couple of language codes are provided in the ``PhpOffice\PhpWord\ComplexType\Language`` class but any valid code/ID can be used.
+
+In case you are generating an RTF document the Language need to be set differently.
+
+.. code-block:: php
+
+    $lang = new Language();
+    $lang->setLangId(Language::EN_GB_ID);
+    $phpWord->getSettings()->setThemeFontLang($lang);
+
 Document information
 --------------------
 

docs/styles.rst

@@ -55,6 +55,8 @@ Available Font style options:
 - ``subScript``. Subscript, *true* or *false*.
 - ``superScript``. Superscript, *true* or *false*.
 - ``underline``. Underline, *dash*, *dotted*, etc.
+- ``lang``. Language, either a language code like *en-US*, *fr-BE*, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages
+   See ``\PhpOffice\PhpWord\Style\Language`` class for some language codes.
 
 .. _paragraph-style:
 
@@ -64,7 +66,7 @@ Paragraph
 Available Paragraph style options:
 
 - ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
-See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
+   See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
 - ``basedOn``. Parent style.
 - ``hanging``. Hanging by how much.
 - ``indent``. Indent by how much.
@@ -87,7 +89,7 @@ Table
 Available Table style options:
 
 - ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
-See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` classes for the details.
+   See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` classes for the details.
 - ``bgColor``. Background color, e.g. '9966CC'.
 - ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
 - ``border(Top|Right|Bottom|Left)Size``. Border size in twips.
@@ -106,7 +108,8 @@ Available Cell style options:
 - ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
 - ``border(Top|Right|Bottom|Left)Size``. Border size in twips.
 - ``gridSpan``. Number of columns spanned.
-- ``textDirection(btLr|tbRl)``. Direction of text. You can use constants ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_BTLR`` and ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_TBRL``
+- ``textDirection(btLr|tbRl)``. Direction of text.
+   You can use constants ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_BTLR`` and ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_TBRL``
 - ``valign``. Vertical alignment, *top*, *center*, *both*, *bottom*.
 - ``vMerge``. *restart* or *continue*.
 - ``width``. Cell width in twips.
@@ -133,7 +136,7 @@ Numbering level
 Available NumberingLevel style options:
 
 - ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
-See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
+   See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
 - ``font``. Font name.
 - ``format``. Numbering format bullet\|decimal\|upperRoman\|lowerRoman\|upperLetter\|lowerLetter.
 - ``hanging``. See paragraph style.

samples/Sample_01_SimpleText.php

@@ -1,9 +1,16 @@
 <?php
+use PhpOffice\PhpWord\Style\Paragraph;
+use PhpOffice\PhpWord\Style\Font;
+
 include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , ' Create new PhpWord object' , EOL;
+
+$languageEnGb = new \PhpOffice\PhpWord\Style\Language(\PhpOffice\PhpWord\Style\Language::EN_GB);
+
 $phpWord = new \PhpOffice\PhpWord\PhpWord();
+$phpWord->getSettings()->setThemeFontLang($languageEnGb);
 
 $fontStyleName = 'rStyle';
 $phpWord->addFontStyle($fontStyleName, array('bold' => true, 'italic' => true, 'size' => 16, 'allCaps' => true, 'doubleStrikethrough' => true));
@@ -20,6 +27,10 @@
 $section->addTitle('Welcome to PhpWord', 1);
 $section->addText('Hello World!');
 
+// $pStyle = new Font();
+// $pStyle->setLang()
+$section->addText('Ce texte-ci est en français.', array('lang' => \PhpOffice\PhpWord\Style\Language::FR_BE));
+
 // Two text break
 $section->addTextBreak(2);
 

samples/Sample_10_EastAsianFontStyle.php

@@ -7,7 +7,7 @@
 $section = $phpWord->addSection();
 $header = array('size' => 16, 'bold' => true);
 //1.Use EastAisa FontStyle
-$section->addText('中文楷体样式测试', array('name' => '楷体', 'size' => 16, 'color' => '1B2232'));
+$section->addText('中文楷体样式测试', array('name' => '楷体', 'size' => 16, 'color' => '1B2232', 'lang' => array('latin' => 'en-US', 'eastAsia' => 'zh-CN')));
 
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);

src/PhpWord/ComplexType/TrackChangesView.php

@@ -135,10 +135,10 @@ public function hasFormatting()
     /**
      * Set Display Formatting Revisions
      *
-     * @param boolean $insDel
+     * @param boolean|null $formatting
      *            Set to true to show formatting revisions
      */
-    public function setFormatting($formatting)
+    public function setFormatting($formatting = null)
     {
         $this->formatting = $formatting === null ? true : $formatting;
     }

src/PhpWord/Element/AbstractElement.php

@@ -231,7 +231,7 @@ public function setElementIndex($value)
     /**
      * Get element unique ID
      *
-     * @return string
+     * @return integer
      */
     public function getElementId()
     {

src/PhpWord/Element/Bookmark.php

@@ -45,9 +45,7 @@ class Bookmark extends AbstractElement
      */
     public function __construct($name)
     {
-
         $this->name = CommonText::toUTF8($name);
-        return $this;
     }
 
     /**

src/PhpWord/Element/CheckBox.php

@@ -40,7 +40,6 @@ class CheckBox extends Text
      * @param string $text
      * @param mixed $fontStyle
      * @param mixed $paragraphStyle
-     * @return self
      */
     public function __construct($name = null, $text = null, $fontStyle = null, $paragraphStyle = null)
     {

src/PhpWord/Element/Comment.php

@@ -61,7 +61,6 @@ public function __construct($author, $date, $initials)
     {
         parent::__construct($author, $date);
         $this->initials = $initials;
-        return $this;
     }
 
     /**