Merge pull request #137 from ivanlanin/fancy-samples

Fancy web interface for samples

samples/Sample_01_SimpleText.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , " Create new PHPWord object" , EOL;
@@ -57,6 +54,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_02_TabStops.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , ' Create new PHPWord object' , EOL;
@@ -45,6 +42,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_03_Sections.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , ' Create new PHPWord object' , EOL;
@@ -38,6 +35,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_04_Textrun.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , ' Create new PHPWord object' , EOL;
@@ -45,6 +42,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_05_Multicolumn.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , " Create new PHPWord object" , EOL;
@@ -48,6 +45,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_06_Footnote.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , " Create new PHPWord object" , EOL;
@@ -46,6 +43,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_07_TemplateCloneRow.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s') , " Create new PHPWord object" , EOL;
@@ -56,11 +53,9 @@ $document->setValue('userFirstName#3', 'Michael');
 $document->setValue('userName#3', 'Ray');
 $document->setValue('userPhone#3', '+1 428 889 775');
 
-$name = 'Sample_07_TemplateCloneRow_result.docx';
+$name = 'Sample_07_TemplateCloneRow.docx';
 echo date('H:i:s'), " Write to Word2007 format", EOL;
 $document->saveAs($name);
 rename($name, "results/{$name}");
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_08_ParagraphPagination.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s') , " Create new PHPWord object" , EOL;
@@ -58,6 +55,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_09_Tables.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , ' Create new PHPWord object' , EOL;
@@ -86,6 +83,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_10_EastAsianFontStyle.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word Document
 echo date('H:i:s') , ' Create new PHPWord object' , EOL;
@@ -22,6 +19,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_11_ReadWord2007.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // Read contents
 $name = basename(__FILE__, '.php');
@@ -19,6 +16,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_12_HeaderFooter.php

@@ -1,8 +1,5 @@
 <?php
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s') , " Create new PHPWord object" , EOL;
@@ -69,6 +66,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_13_Images.php

@@ -2,11 +2,7 @@
 /**
  * Image creation
  */
-
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s'), " Create new PHPWord object", EOL;
@@ -37,6 +33,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_14_ListItem.php

@@ -2,11 +2,7 @@
 /**
  * List item sample
  */
-
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s'), " Create new PHPWord object", EOL;
@@ -61,6 +57,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_15_Link.php

@@ -2,11 +2,7 @@
 /**
  * Link sample
  */
-
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s'), " Create new PHPWord object", EOL;
@@ -35,6 +31,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_16_Object.php

@@ -2,11 +2,7 @@
 /**
  * Object sample
  */
-
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s'), " Create new PHPWord object", EOL;
@@ -30,6 +26,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_17_TitleTOC.php

@@ -1,12 +1,8 @@
 <?php
 /**
- * Generic template for creating PHPWord samples
+ * Titles and TOC
  */
-
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s'), " Create new PHPWord object", EOL;
@@ -62,6 +58,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_18_Watermark.php

@@ -1,12 +1,8 @@
 <?php
 /**
- * Generic template for creating PHPWord samples
+ * Watermark
  */
-
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s'), " Create new PHPWord object", EOL;
@@ -31,6 +27,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_19_TextBreak.php

@@ -1,12 +1,8 @@
 <?php
 /**
- * Generic template for creating PHPWord samples
+ * Text break
  */
-
-// Init
-error_reporting(E_ALL);
-define('EOL', (PHP_SAPI == 'cli') ? PHP_EOL : '<br />');
-require_once '../Classes/PHPWord.php';
+include_once 'Sample_Header.php';
 
 // New Word document
 echo date('H:i:s'), " Create new PHPWord object", EOL;
@@ -44,6 +40,4 @@ foreach ($writers as $writer => $extension) {
     rename("{$name}.{$extension}", "results/{$name}.{$extension}");
 }
 
-// Done
-echo date('H:i:s'), " Done writing file(s)", EOL;
-echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+include_once 'Sample_Footer.php';

samples/Sample_Footer.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Footer file
+ */
+// Do not show execution time for index
+if (!$isIndexFile) {
+    echo date('H:i:s'), " Done writing file(s)", EOL;
+    echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
+}
+// Show message when executed with CLI, show links when using browsers
+if (CLI) {
+    echo 'The results are stored in the "results" subdirectory.', EOL;
+} else {
+    if (!$isIndexFile) {
+        $types = array('docx', 'odt', 'rtf');
+        echo '<p>&nbsp;</p>';
+        echo '<p>Results: ';
+        foreach ($types as $type) {
+            $result = "results/{$sampleFile}.{$type}";
+            if (file_exists($result)) {
+                echo "<a href='{$result}' class='btn btn-primary'>{$type}</a> ";
+            }
+        }
+        echo '</p>';
+    }
+?>
+</div>
+<script src="bootstrap/js/jquery.min.js"></script>
+<script src="bootstrap/js/bootstrap.min.js"></script>
+</body>
+</html>
+<?php
+} // if (CLI)
+

samples/Sample_Header.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * Header file
+ */
+error_reporting(E_ALL);
+define('CLI', (PHP_SAPI == 'cli') ? true : false);
+define('EOL', CLI ? PHP_EOL : '<br />');
+require_once '../Classes/PHPWord.php';
+// Return to the caller script when runs by CLI
+if (CLI) {
+    return;
+}
+
+// Set titles and names
+$sampleFile = basename($_SERVER['SCRIPT_FILENAME'], '.php');
+$isIndexFile = ($sampleFile == 'index');
+$pageHeading = str_replace('_', ' ', $sampleFile);
+$pageTitle = $isIndexFile ? 'Welcome to ' : "{$pageHeading} - ";
+$pageTitle .= 'PHPWord';
+$pageHeading = $isIndexFile ? '' : "<h1>{$pageHeading}</h1>";
+// Populate samples
+$files = '';
+if ($handle = opendir('.')) {
+    while (false !== ($file = readdir($handle))) {
+        if (preg_match('/^Sample_\d+_/', $file)) {
+            $name = str_replace('_', ' ', preg_replace('/(Sample_|\.php)/', '', $file));
+            $files .= "<li><a href='{$file}'>{$name}</a></li>";
+        }
+    }
+    closedir($handle);
+}
+?>
+<title><?php echo $pageTitle; ?></title>
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge" />
+<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+<link rel="stylesheet" href="bootstrap/css/bootstrap.min.css" />
+<link rel="stylesheet" href="bootstrap/css/phpword.css" />
+</head>
+<body>
+<div class="container">
+<div class="navbar navbar-default" role="navigation">
+    <div class="container-fluid">
+        <div class="navbar-header">
+            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+            <span class="sr-only">Toggle navigation</span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            </button>
+            <a class="navbar-brand" href="./">PHPWord</a>
+        </div>
+        <div class="navbar-collapse collapse">
+            <ul class="nav navbar-nav">
+                <li class="dropdown active">
+                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Samples
+                        <strong class="caret"></strong></a>
+                    <ul class="dropdown-menu"><?php echo $files; ?></ul>
+                </li>
+            </ul>
+            <ul class="nav navbar-nav navbar-right">
+                <li><a href="https://github.com/PHPOffice/PHPWord">Github</a></li>
+                <li><a href="http://phpword.readthedocs.org/en/develop/">Docs</a></li>
+            </ul>
+        </div>
+    </div>
+</div>
+<?php echo $pageHeading; ?>

samples/bootstrap/css/phpword.css

@@ -0,0 +1,13 @@
+body {
+    padding-top: 20px;
+    padding-bottom: 20px;
+}
+.navbar {
+    margin-bottom: 20px;
+}
+.passed {
+    color: #339900;
+}
+.failed {
+    color: #ff0000;
+}

samples/index.php

@@ -0,0 +1,28 @@
+<?php
+include_once 'Sample_Header.php';
+if (!CLI) {
+?>
+<div class="jumbotron">
+<p>Welcome to PHPWord, a library written in pure PHP that provides a set of classes to write to and read from different document file formats, i.e. Word (.docx), WordPad (.rtf), and Libre/OpenOffice Writer (.odt).</p>
+<p>Please use the menu above to browse PHPWord samples.</p>
+<p>
+    <a class="btn btn-lg btn-primary" href="https://github.com/PHPOffice/PHPWord" role="button">Fork us on Github!</a>
+    <a class="btn btn-lg btn-primary" href="http://phpword.readthedocs.org/en/develop/" role="button">Read the Docs</a>
+</p>
+</div>
+<?
+$requirements = array(
+    'php' => array('PHP 5.3.0', version_compare(phpversion(), '5.3.0', '>=')),
+    'zip' => array('PHP extension ZipArchive', extension_loaded('zip')),
+    'xml' => array('PHP extension XML', extension_loaded('xml')),
+    'gd'  => array('PHP extension GD (optional)', extension_loaded('gd')),
+);
+echo "<h3>Requirements</h3>";
+echo "<ul>";
+foreach ($requirements as $key => $value) {
+    $status = $value[1] ? 'passed' : 'failed';
+    echo "<li>{$value[0]} ... <span class='{$status}'>{$status}</span></li>";
+}
+echo "</ul>";
+} // if (!CLI)
+include_once 'Sample_Footer.php';