#51 (updated tests, refactored a little).

PHPOffice · Jul 31, 2016 · Feb 6, 2015 · Feb 6, 2015 · Feb 21, 2015 · Feb 21, 2015
commit 2a5c66784b5e723d0cdae9249f80d44522196a3b
diff --git a/docs/general.rst b/docs/general.rst
@@ -28,7 +28,9 @@ folder <https://github.com/PHPOffice/PHPWord/tree/master/samples/>`__.
         htmlspecialchars(
             '"Learn from yesterday, live for today, hope for tomorrow. '
                 . 'The important thing is not to stop questioning." '
-                . '(Albert Einstein)'
+                . '(Albert Einstein)',
+            ENT_COMPAT,
+            'UTF-8'
         )
     );
 
@@ -44,7 +46,9 @@ folder <https://github.com/PHPOffice/PHPWord/tree/master/samples/>`__.
         htmlspecialchars(
             '"Great achievement is usually born of great sacrifice, '
                 . 'and is never the result of selfishness." '
-                . '(Napoleon Hill)'
+                . '(Napoleon Hill)',
+            ENT_COMPAT,
+            'UTF-8'
         ),
         array('name' => 'Tahoma', 'size' => 10)
     );
@@ -59,7 +63,9 @@ folder <https://github.com/PHPOffice/PHPWord/tree/master/samples/>`__.
         htmlspecialchars(
             '"The greatest accomplishment is not in never falling, '
                 . 'but in rising again after you fall." '
-                . '(Vince Lombardi)'
+                . '(Vince Lombardi)',
+            ENT_COMPAT,
+            'UTF-8'
         ),
         $fontStyleName
     );
@@ -70,7 +76,7 @@ folder <https://github.com/PHPOffice/PHPWord/tree/master/samples/>`__.
     $fontStyle->setName('Tahoma');
     $fontStyle->setSize(13);
     $myTextElement = $section->addText(
-        htmlspecialchars('"Believe you can and you\'re halfway there." (Theodor Roosevelt)')
+        htmlspecialchars('"Believe you can and you\'re halfway there." (Theodor Roosevelt)', ENT_COMPAT, 'UTF-8')
     );
     $myTextElement->setFontStyle($fontStyle);
 

diff --git a/docs/src/documentation.md b/docs/src/documentation.md
@@ -228,7 +228,9 @@ $section->addText(
     htmlspecialchars(
         '"Learn from yesterday, live for today, hope for tomorrow. '
             . 'The important thing is not to stop questioning." '
-            . '(Albert Einstein)'
+            . '(Albert Einstein)',
+        ENT_COMPAT,
+        'UTF-8'
     )
 );
 
@@ -244,7 +246,9 @@ $section->addText(
     htmlspecialchars(
         '"Great achievement is usually born of great sacrifice, '
             . 'and is never the result of selfishness." '
-            . '(Napoleon Hill)'
+            . '(Napoleon Hill)',
+        ENT_COMPAT,
+        'UTF-8'
     ),
     array('name' => 'Tahoma', 'size' => 10)
 );
@@ -259,7 +263,9 @@ $section->addText(
     htmlspecialchars(
         '"The greatest accomplishment is not in never falling, '
             . 'but in rising again after you fall." '
-            . '(Vince Lombardi)'
+            . '(Vince Lombardi)',
+        ENT_COMPAT,
+        'UTF-8'
     ),
     $fontStyleName
 );
@@ -270,7 +276,7 @@ $fontStyle->setBold(true);
 $fontStyle->setName('Tahoma');
 $fontStyle->setSize(13);
 $myTextElement = $section->addText(
-    htmlspecialchars('"Believe you can and you\'re halfway there." (Theodor Roosevelt)')
+    htmlspecialchars('"Believe you can and you\'re halfway there." (Theodor Roosevelt)', ENT_COMPAT, 'UTF-8')
 );
 $myTextElement->setFontStyle($fontStyle);
 

diff --git a/samples/Sample_01_SimpleText.php b/samples/Sample_01_SimpleText.php
@@ -12,16 +12,16 @@
 $section = $phpWord->addSection();
 
 // Simple text
-$section->addTitle(htmlspecialchars('Welcome to PhpWord'), 1);
-$section->addText(htmlspecialchars('Hello World!'));
+$section->addTitle(htmlspecialchars('Welcome to PhpWord', ENT_COMPAT, 'UTF-8'), 1);
+$section->addText(htmlspecialchars('Hello World!', ENT_COMPAT, 'UTF-8'));
 
 // Two text break
 $section->addTextBreak(2);
 
 // Defined style
-$section->addText(htmlspecialchars('I am styled by a font style definition.'), 'rStyle');
-$section->addText(htmlspecialchars('I am styled by a paragraph style definition.'), null, 'pStyle');
-$section->addText(htmlspecialchars('I am styled by both font and paragraph style.'), 'rStyle', 'pStyle');
+$section->addText(htmlspecialchars('I am styled by a font style definition.', ENT_COMPAT, 'UTF-8'), 'rStyle');
+$section->addText(htmlspecialchars('I am styled by a paragraph style definition.', ENT_COMPAT, 'UTF-8'), null, 'pStyle');
+$section->addText(htmlspecialchars('I am styled by both font and paragraph style.', ENT_COMPAT, 'UTF-8'), 'rStyle', 'pStyle');
 
 $section->addTextBreak();
 
@@ -30,39 +30,39 @@
 $fontStyle['size'] = 20;
 
 $textrun = $section->addTextRun();
-$textrun->addText(htmlspecialchars('I am inline styled '), $fontStyle);
-$textrun->addText(htmlspecialchars('with '));
-$textrun->addText(htmlspecialchars('color'), array('color' => '996699'));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('bold'), array('bold' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('italic'), array('italic' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('underline'), array('underline' => 'dash'));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('strikethrough'), array('strikethrough' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('doubleStrikethrough'), array('doubleStrikethrough' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('superScript'), array('superScript' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('subScript'), array('subScript' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('smallCaps'), array('smallCaps' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('allCaps'), array('allCaps' => true));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('fgColor'), array('fgColor' => 'yellow'));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('scale'), array('scale' => 200));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('spacing'), array('spacing' => 120));
-$textrun->addText(htmlspecialchars(', '));
-$textrun->addText(htmlspecialchars('kerning'), array('kerning' => 10));
-$textrun->addText(htmlspecialchars('. '));
+$textrun->addText(htmlspecialchars('I am inline styled ', ENT_COMPAT, 'UTF-8'), $fontStyle);
+$textrun->addText(htmlspecialchars('with ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('color', ENT_COMPAT, 'UTF-8'), array('color' => '996699'));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('bold', ENT_COMPAT, 'UTF-8'), array('bold' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('italic', ENT_COMPAT, 'UTF-8'), array('italic' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('underline', ENT_COMPAT, 'UTF-8'), array('underline' => 'dash'));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('strikethrough', ENT_COMPAT, 'UTF-8'), array('strikethrough' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('doubleStrikethrough', ENT_COMPAT, 'UTF-8'), array('doubleStrikethrough' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('superScript', ENT_COMPAT, 'UTF-8'), array('superScript' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('subScript', ENT_COMPAT, 'UTF-8'), array('subScript' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('smallCaps', ENT_COMPAT, 'UTF-8'), array('smallCaps' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('allCaps', ENT_COMPAT, 'UTF-8'), array('allCaps' => true));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('fgColor', ENT_COMPAT, 'UTF-8'), array('fgColor' => 'yellow'));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('scale', ENT_COMPAT, 'UTF-8'), array('scale' => 200));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('spacing', ENT_COMPAT, 'UTF-8'), array('spacing' => 120));
+$textrun->addText(htmlspecialchars(', ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('kerning', ENT_COMPAT, 'UTF-8'), array('kerning' => 10));
+$textrun->addText(htmlspecialchars('. ', ENT_COMPAT, 'UTF-8'));
 
 // Link
-$section->addLink('http://www.google.com', htmlspecialchars('Google'));
+$section->addLink('https://github.com/PHPOffice/PHPWord', htmlspecialchars('PHPWord on GitHub', ENT_COMPAT, 'UTF-8'));
 $section->addTextBreak();
 
 // Image

diff --git a/samples/Sample_02_TabStops.php b/samples/Sample_02_TabStops.php
@@ -29,9 +29,9 @@
 $section = $phpWord->addSection();
 
 // Add listitem elements
-$section->addText(htmlspecialchars("Multiple Tabs:\tOne\tTwo\tThree"), null, 'multipleTab');
-$section->addText(htmlspecialchars("Left Aligned\tRight Aligned"), null, 'rightTab');
-$section->addText(htmlspecialchars("\tCenter Aligned"), null, 'centerTab');
+$section->addText(htmlspecialchars("Multiple Tabs:\tOne\tTwo\tThree", ENT_COMPAT, 'UTF-8'), null, 'multipleTab');
+$section->addText(htmlspecialchars("Left Aligned\tRight Aligned", ENT_COMPAT, 'UTF-8'), null, 'rightTab');
+$section->addText(htmlspecialchars("\tCenter Aligned", ENT_COMPAT, 'UTF-8'), null, 'centerTab');
 
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);

diff --git a/samples/Sample_03_Sections.php b/samples/Sample_03_Sections.php
@@ -7,13 +7,15 @@
 
 // New portrait section
 $section = $phpWord->addSection(array('borderColor' => '00FF00', 'borderSize' => 12));
-$section->addText(htmlspecialchars('I am placed on a default section.'));
+$section->addText(htmlspecialchars('I am placed on a default section.', ENT_COMPAT, 'UTF-8'));
 
 // New landscape section
 $section = $phpWord->addSection(array('orientation' => 'landscape'));
 $section->addText(
     htmlspecialchars(
-        'I am placed on a landscape section. Every page starting from this section will be landscape style.'
+        'I am placed on a landscape section. Every page starting from this section will be landscape style.',
+        ENT_COMPAT,
+        'UTF-8'
     )
 );
 $section->addPageBreak();
@@ -23,7 +25,7 @@
 $section = $phpWord->addSection(
     array('paperSize' => 'Folio', 'marginLeft' => 600, 'marginRight' => 600, 'marginTop' => 600, 'marginBottom' => 600)
 );
-$section->addText(htmlspecialchars('This section uses other margins with folio papersize.'));
+$section->addText(htmlspecialchars('This section uses other margins with folio papersize.', ENT_COMPAT, 'UTF-8'));
 
 // New portrait section with Header & Footer
 $section = $phpWord->addSection(
@@ -36,9 +38,9 @@
         'footerHeight' => 50,
     )
 );
-$section->addText(htmlspecialchars('This section and we play with header/footer height.'));
-$section->addHeader()->addText(htmlspecialchars('Header'));
-$section->addFooter()->addText(htmlspecialchars('Footer'));
+$section->addText(htmlspecialchars('This section and we play with header/footer height.', ENT_COMPAT, 'UTF-8'));
+$section->addHeader()->addText(htmlspecialchars('Header', ENT_COMPAT, 'UTF-8'));
+$section->addFooter()->addText(htmlspecialchars('Footer', ENT_COMPAT, 'UTF-8'));
 
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);

diff --git a/samples/Sample_04_Textrun.php b/samples/Sample_04_Textrun.php
@@ -20,24 +20,24 @@
 // Add text run
 $textrun = $section->addTextRun('pStyle');
 
-$textrun->addText(htmlspecialchars('Each textrun can contain native text, link elements or an image.'));
-$textrun->addText(htmlspecialchars(' No break is placed after adding an element.'), 'BoldText');
-$textrun->addText(htmlspecialchars(' Both '));
-$textrun->addText(htmlspecialchars('superscript'), array('superScript' => true));
-$textrun->addText(htmlspecialchars(' and '));
-$textrun->addText(htmlspecialchars('subscript'), array('subScript' => true));
-$textrun->addText(htmlspecialchars(' are also available.'));
+$textrun->addText(htmlspecialchars('Each textrun can contain native text, link elements or an image.', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars(' No break is placed after adding an element.', ENT_COMPAT, 'UTF-8'), 'BoldText');
+$textrun->addText(htmlspecialchars(' Both ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('superscript', ENT_COMPAT, 'UTF-8'), array('superScript' => true));
+$textrun->addText(htmlspecialchars(' and ', ENT_COMPAT, 'UTF-8'));
+$textrun->addText(htmlspecialchars('subscript', ENT_COMPAT, 'UTF-8'), array('subScript' => true));
+$textrun->addText(htmlspecialchars(' are also available.', ENT_COMPAT, 'UTF-8'));
 $textrun->addText(
-    htmlspecialchars(' All elements are placed inside a paragraph with the optionally given p-Style.'),
+    htmlspecialchars(' All elements are placed inside a paragraph with the optionally given p-Style.', ENT_COMPAT, 'UTF-8'),
     'ColoredText'
 );
-$textrun->addText(htmlspecialchars(' Sample Link: '));
-$textrun->addLink('http://www.google.com', null, 'NLink');
-$textrun->addText(htmlspecialchars(' Sample Image: '));
+$textrun->addText(htmlspecialchars(' Sample Link: ', ENT_COMPAT, 'UTF-8'));
+$textrun->addLink('https://github.com/PHPOffice/PHPWord', htmlspecialchars('PHPWord on GitHub', ENT_COMPAT, 'UTF-8'), 'NLink');
+$textrun->addText(htmlspecialchars(' Sample Image: ', ENT_COMPAT, 'UTF-8'));
 $textrun->addImage('resources/_earth.jpg', array('width' => 18, 'height' => 18));
-$textrun->addText(htmlspecialchars(' Sample Object: '));
+$textrun->addText(htmlspecialchars(' Sample Object: ', ENT_COMPAT, 'UTF-8'));
 $textrun->addObject('resources/_sheet.xls');
-$textrun->addText(htmlspecialchars(' Here is some more text. '));
+$textrun->addText(htmlspecialchars(' Here is some more text. ', ENT_COMPAT, 'UTF-8'));
 
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);

diff --git a/samples/Sample_05_Multicolumn.php b/samples/Sample_05_Multicolumn.php
@@ -11,7 +11,7 @@
 
 // Normal
 $section = $phpWord->addSection();
-$section->addText(htmlspecialchars("Normal paragraph. {$filler}"));
+$section->addText(htmlspecialchars("Normal paragraph. {$filler}", ENT_COMPAT, 'UTF-8'));
 
 // Two columns
 $section = $phpWord->addSection(
@@ -21,11 +21,11 @@
         'breakType' => 'continuous',
     )
 );
-$section->addText(htmlspecialchars("Two columns, one inch (1440 twips) spacing. {$filler}"));
+$section->addText(htmlspecialchars("Two columns, one inch (1440 twips) spacing. {$filler}", ENT_COMPAT, 'UTF-8'));
 
 // Normal
 $section = $phpWord->addSection(array('breakType' => 'continuous'));
-$section->addText(htmlspecialchars("Normal paragraph again. {$filler}"));
+$section->addText(htmlspecialchars("Normal paragraph again. {$filler}", ENT_COMPAT, 'UTF-8'));
 
 // Three columns
 $section = $phpWord->addSection(
@@ -35,11 +35,11 @@
         'breakType' => 'continuous',
     )
 );
-$section->addText(htmlspecialchars("Three columns, half inch (720 twips) spacing. {$filler}"));
+$section->addText(htmlspecialchars("Three columns, half inch (720 twips) spacing. {$filler}", ENT_COMPAT, 'UTF-8'));
 
 // Normal
 $section = $phpWord->addSection(array('breakType' => 'continuous'));
-$section->addText(htmlspecialchars('Normal paragraph again.'));
+$section->addText(htmlspecialchars('Normal paragraph again.', ENT_COMPAT, 'UTF-8'));
 
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);

diff --git a/samples/Sample_06_Footnote.php b/samples/Sample_06_Footnote.php
@@ -20,30 +20,32 @@
 
 // Add text elements
 $textrun = $section->addTextRun('pStyle');
-$textrun->addText(htmlspecialchars('This is some lead text in a paragraph with a following footnote. '), 'pStyle');
+$textrun->addText(htmlspecialchars('This is some lead text in a paragraph with a following footnote. ', ENT_COMPAT, 'UTF-8'), 'pStyle');
 
 $footnote = $textrun->addFootnote();
-$footnote->addText(htmlspecialchars('Just like a textrun, a footnote can contain native texts. '));
-$footnote->addText(htmlspecialchars('No break is placed after adding an element. '), 'BoldText');
-$footnote->addText(htmlspecialchars('All elements are placed inside a paragraph. '), 'ColoredText');
+$footnote->addText(htmlspecialchars('Just like a textrun, a footnote can contain native texts. ', ENT_COMPAT, 'UTF-8'));
+$footnote->addText(htmlspecialchars('No break is placed after adding an element. ', ENT_COMPAT, 'UTF-8'), 'BoldText');
+$footnote->addText(htmlspecialchars('All elements are placed inside a paragraph. ', ENT_COMPAT, 'UTF-8'), 'ColoredText');
 $footnote->addTextBreak();
-$footnote->addText(htmlspecialchars('But you can insert a manual text break like above, '));
-$footnote->addText(htmlspecialchars('links like '));
-$footnote->addLink('http://www.google.com', null, 'NLink');
-$footnote->addText(htmlspecialchars(', image like '));
+$footnote->addText(htmlspecialchars('But you can insert a manual text break like above, ', ENT_COMPAT, 'UTF-8'));
+$footnote->addText(htmlspecialchars('links like ', ENT_COMPAT, 'UTF-8'));
+$footnote->addLink('https://github.com/PHPOffice/PHPWord', htmlspecialchars('PHPWord on GitHub', ENT_COMPAT, 'UTF-8'), 'NLink');
+$footnote->addText(htmlspecialchars(', image like ', ENT_COMPAT, 'UTF-8'));
 $footnote->addImage('resources/_earth.jpg', array('width' => 18, 'height' => 18));
-$footnote->addText(htmlspecialchars(', or object like '));
+$footnote->addText(htmlspecialchars(', or object like ', ENT_COMPAT, 'UTF-8'));
 $footnote->addObject('resources/_sheet.xls');
-$footnote->addText(htmlspecialchars('But you can only put footnote in section, not in header or footer.'));
+$footnote->addText(htmlspecialchars('But you can only put footnote in section, not in header or footer.', ENT_COMPAT, 'UTF-8'));
 
 $section->addText(
     htmlspecialchars(
         'You can also create the footnote directly from the section making it wrap in a paragraph '
-            . 'like the footnote below this paragraph. But is is best used from within a textrun.'
+            . 'like the footnote below this paragraph. But is is best used from within a textrun.',
+        ENT_COMPAT,
+        'UTF-8'
     )
 );
 $footnote = $section->addFootnote();
-$footnote->addText(htmlspecialchars('The reference for this is wrapped in its own line'));
+$footnote->addText(htmlspecialchars('The reference for this is wrapped in its own line', ENT_COMPAT, 'UTF-8'));
 
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);