]*>\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]<\/text:p>@smU';
- $reg = '@\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]@smU';
- $this->contentXml = preg_replace($reg, $segment->getXmlParsed(), $this->contentXml);
- foreach ($segment->manif_vars as $val) {
- $this->manif_vars[] = $val; //copy all segment image names into current array
- }
- return $this;
- }
-
- /**
- * Display all the current template variables
- *
- * @return string
- */
- public function printVars()
- {
- return print_r('' . print_r($this->vars, true) . '
', true);
- }
-
- /**
- * Display the XML content of the file from odt document
- * as it is at the moment
- *
- * @return string
- */
- public function __toString()
- {
- return $this->contentXml;
- }
-
- /**
- * Display loop segments declared with setSegment()
- *
- * @return string
- */
- public function printDeclaredSegments()
- {
- return '' . print_r(implode(' ', array_keys($this->segments)), true) . '';
- }
-
- /**
- * Declare a segment in order to use it in a loop
- *
- * @param string $segment
- * @throws OdfException
- * @return Segment
- */
- public function setSegment($segment)
- {
- if (array_key_exists($segment, $this->segments)) {
- return $this->segments[$segment];
- }
- // $reg = "#\[!--\sBEGIN\s$segment\s--\]<\/text:p>(.*?)\[!--\sEND\s$segment\s--\]#sm";
- $reg = "#\[!--\sBEGIN\s$segment\s--\](.*?)\[!--\sEND\s$segment\s--\]#smU";
- if (preg_match($reg, html_entity_decode($this->contentXml), $m) == 0) {
- throw new OdfException("'$segment' segment not found in the document");
- }
- $this->segments[$segment] = new Segment($segment, $m[1], $this);
- return $this->segments[$segment];
- }
-
- /**
- * Save the odt file on the disk
- *
- * @param string $file name of the desired file
- * @throws OdfException
- * @return void
- */
- public function saveToDisk($file = null)
- {
- if ($file !== null && is_string($file)) {
- if (file_exists($file) && !(is_file($file) && is_writable($file))) {
- throw new OdfException('Permission denied : can\'t create ' . $file);
- }
- $this->_save();
- copy($this->tmpfile, $file);
- } else {
- $this->_save();
- }
- }
-
- /**
- * Internal save
- *
- * @throws OdfException
- * @return void
- */
- private function _save()
- {
- $this->file->open($this->tmpfile);
- $this->_parse();
- if (!$this->file->addFromString('content.xml', $this->contentXml) || !$this->file->addFromString('styles.xml', $this->stylesXml)) {
- throw new OdfException('Error during file export addFromString');
- }
- $lastpos=strrpos($this->manifestXml, "\n", -15); //find second last newline in the manifest.xml file
- $manifdata = "";
-
- //Enter all images description in $manifdata variable
- foreach ($this->manif_vars as $val) {
- $ext = substr(strrchr($val, '.'), 1);
- $manifdata = $manifdata.''."\n";
- }
- //Place content of $manifdata variable in manifest.xml file at appropriate place
- $this->manifestXml = substr_replace($this->manifestXml, "\n".$manifdata, $lastpos+1, 0);
- //$this->manifestXml = $this->manifestXml ."\n".$manifdata;
-
- if (! $this->file->addFromString('META-INF/manifest.xml', $this->manifestXml)) {
- throw new OdfException('Error during manifest file export');
- }
- foreach ($this->images as $imageKey => $imageValue) {
- $this->file->addFile($imageKey, 'Pictures/' . $imageValue);
- }
- $this->file->close(); // seems to bug on windows CLI sometimes
- }
-
- /**
- * Export the file as attached file by HTTP
- *
- * @param string $name (optionnal)
- * @throws OdfException
- * @return void
- */
- public function exportAsAttachedFile($name = "")
- {
- $this->_save();
- if (headers_sent($filename, $linenum)) {
- throw new OdfException("headers already sent ($filename at $linenum)");
- }
-
- if ($name == "") {
- $name = md5(uniqid()) . ".odt";
- }
-
- header('Content-type: application/vnd.oasis.opendocument.text');
- header('Content-Disposition: attachment; filename="'.$name.'"');
- readfile($this->tmpfile);
- }
-
- /**
- * Returns a variable of configuration
- *
- * @return string The requested variable of configuration
- */
- public function getConfig($configKey)
- {
- if (array_key_exists($configKey, $this->config)) {
- return $this->config[$configKey];
- }
- return false;
- }
-
- /**
- * Returns the temporary working file
- *
- * @return string le chemin vers le fichier temporaire de travail
- */
- public function getTmpfile()
- {
- return $this->tmpfile;
- }
-
-
- /**
- * Recursive htmlspecialchars
- */
- protected function recursiveHtmlspecialchars($value)
- {
- if (is_array($value)) {
- return array_map(array($this, 'recursiveHtmlspecialchars'), $value);
- } else {
- return htmlspecialchars($value);
- }
+
+ $this->images[$value] = $file;
+ $this->manifestVars[] = $file;
+ $this->setVars($key, $xml, FALSE);
+ return $this;
+ }
+
+ /**
+ * Move segment tags for lines of tables.
+ *
+ * Called automatically within the constructor.
+ *
+ * @return void
+ * Modifies the internal XML content by moving segment tags.
+ */
+ private function moveRowSegments(): void {
+ // Search all possible rows in the document.
+ $reg1 = "#]*>(.*)#smU";
+ preg_match_all($reg1, $this->contentXml, $matches);
+ for ($i = 0, $size = count($matches[0]); $i < $size; $i++) {
+ // Check if the current row contains a segment row.*.
+ $reg2 = '#\[!--\sBEGIN\s(row.[\S]*)\s--\](.*)\[!--\sEND\s\\1\s--\]#smU';
+ if (preg_match($reg2, $matches[0][$i], $matches2)) {
+ $balise = str_replace('row.', '', $matches2[1]);
+ // Move segment tags around the row.
+ $replace = [
+ '[!-- BEGIN ' . $matches2[1] . ' --]' => '',
+ '[!-- END ' . $matches2[1] . ' --]' => '',
+ ' '[!-- BEGIN ' . $balise . ' --]' => '[!-- END ' . $balise . ' --]'
+ ];
+ $replacedXML = str_replace(array_keys($replace), array_values($replace), $matches[0][$i]);
+ $this->contentXml = str_replace($matches[0][$i], $replacedXML, $this->contentXml);
+ }
}
+ }
+
+ /**
+ * Merge template variables.
+ *
+ * Called automatically for a save operation.
+ *
+ * @return void
+ * Processes and updates the internal XML content with merged variables.
+ */
+ private function parse(): void {
+ $this->contentXml = str_replace(array_keys($this->vars), array_values($this->vars), $this->contentXml);
+ $this->stylesXml = str_replace(array_keys($this->vars), array_values($this->vars), $this->stylesXml);
+ }
+
+ /**
+ * Add the merged segment to the document.
+ *
+ * @param \Odtphp\Segment $segment
+ * The segment to merge.
+ *
+ * @throws \Odtphp\Exceptions\OdfException
+ * When the segment cannot be merged or has not been set.
+ *
+ * @return $this
+ * The current ODT object instance.
+ */
+ public function mergeSegment(Segment $segment): self {
+ if (!array_key_exists($segment->getName(), $this->segments)) {
+ throw new OdfException($segment->getName() . ' cannot be parsed, has it been set yet?');
+ }
+ $string = $segment->getName();
+ $reg = '@\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]@smU';
+ $this->contentXml = preg_replace($reg, $segment->getXmlParsed(), $this->contentXml);
+ foreach ($segment->manifestVars as $val) {
+ // Copy all segment image names into current array.
+ $this->manifestVars[] = $val;
+ }
+ return $this;
+ }
+
+ /**
+ * Display all the current template variables.
+ *
+ * @return string
+ * The formatted string containing all template variables.
+ */
+ public function printVars(): string {
+ return print_r('' . print_r($this->vars, TRUE) . '
', TRUE);
+ }
+
+ /**
+ * Display the XML content of the file from ODT document as it is at the moment.
+ *
+ * @return string
+ * The XML content of the ODT document.
+ */
+ public function __toString(): string {
+ return $this->contentXml;
+ }
+
+ /**
+ * Display loop segments declared with setSegment().
+ *
+ * @return string
+ * Space-separated list of declared segments.
+ */
+ public function printDeclaredSegments(): string {
+ return '' . print_r(implode(' ', array_keys($this->segments)), TRUE) . '';
+ }
+
+ /**
+ * Check if the specified segment exists in the document.
+ *
+ * @param string $segment
+ * The name of the segment to check.
+ *
+ * @return bool
+ * TRUE when segment exists, FALSE otherwise.
+ */
+ public function segmentExists($segment): bool {
+ $reg = "#\[!--\sBEGIN\s$segment\s--](.*?)\[!--\sEND\s$segment\s--]#smU";
+ return preg_match($reg, html_entity_decode($this->contentXml), $m) != 0;
+ }
+
+ /**
+ * Declare a segment in order to use it in a loop.
+ *
+ * @param string $segment
+ * The name of the segment to declare.
+ *
+ * @throws \Odtphp\Exceptions\OdfException
+ * When the segment cannot be found in the document.
+ *
+ * @return \Odtphp\Segment
+ * The requested segment object for use in a loop.
+ */
+ public function setSegment($segment): Segment {
+ if (array_key_exists($segment, $this->segments)) {
+ return $this->segments[$segment];
+ }
+ $reg = "#\[!--\sBEGIN\s$segment\s--\](.*?)\[!--\sEND\s$segment\s--\]#smU";
+ if (preg_match($reg, html_entity_decode($this->contentXml), $m) == 0) {
+ throw new OdfException("'$segment' segment not found in the document");
+ }
+ $this->segments[$segment] = new Segment($segment, $m[1], $this);
+ return $this->segments[$segment];
+ }
+
+ /**
+ * Save the ODT file to disk.
+ *
+ * @param string|null $file
+ * Name of the desired file. If null, uses the original filename.
+ *
+ * @throws \Odtphp\Exceptions\OdfException
+ * When the file cannot be saved to disk.
+ *
+ * @return void
+ * Saves the ODT file to the specified location.
+ */
+ public function saveToDisk($file = NULL): void {
+ $this->saveInternal();
+ if ($file === NULL) {
+ $file = $this->filename;
+ }
+ copy($this->tmpfile, $file);
+ }
+
+ /**
+ * Export the file as an attached file via HTTP.
+ *
+ * @param string $name
+ * Optional name for the downloaded file.
+ *
+ * @throws \Odtphp\Exceptions\OdfException
+ * When the file cannot be exported or sent via HTTP.
+ *
+ * @return void
+ * Sends the ODT file as an HTTP attachment.
+ */
+ public function exportAsAttachedFile($name = ""): void {
+ $this->saveInternal();
+ if (empty($name)) {
+ $name = basename($this->filename);
+ }
+ header('Content-type: application/vnd.oasis.opendocument.text');
+ header('Content-Disposition: attachment; filename="' . $name . '"');
+ readfile($this->tmpfile);
+ }
+
+ /**
+ * Save internal ODT file state.
+ *
+ * @throws \Odtphp\Exceptions\OdfException
+ * When the internal file state cannot be saved.
+ *
+ * @return void
+ * Updates the internal ODT file state with current changes.
+ */
+ private function saveInternal(): void {
+ $this->file->open($this->tmpfile);
+ $this->parse();
+ if (!$this->file->addFromString('content.xml', $this->contentXml) || !$this->file->addFromString('styles.xml', $this->stylesXml)) {
+ throw new OdfException('Error during file export addFromString');
+ }
+ // Find second last newline in the manifest.xml file.
+ $lastpos = strrpos($this->manifestXml, "\n", -15);
+ $manifdata = "";
+
+ // Enter all images description in $manifdata variable.
+ foreach ($this->manifestVars as $val) {
+ $ext = substr(strrchr($val, '.'), 1);
+ $manifdata = $manifdata . '' . "\n";
+ }
+
+ // Place content of $manifdata variable in manifest.xml file at appropriate place.
+ $replace = '';
+ if ((strlen($manifdata) > 0) && (strpos($this->manifestXml, $replace) !== FALSE)) {
+ $this->manifestXml = str_replace($replace,
+ $replace . "\n" . $manifdata, $this->manifestXml);
+ }
+ else {
+ // This branch is a fail-safe but normally should not be used.
+ $this->manifestXml = substr_replace($this->manifestXml, "\n" . $manifdata, $lastpos + 1, 0);
+ }
+ if (!$this->file->addFromString('META-INF/manifest.xml', $this->manifestXml)) {
+ throw new OdfException('Error during manifest file export');
+ }
+ foreach ($this->images as $imageKey => $imageValue) {
+ $this->file->addFile($imageKey, 'Pictures/' . $imageValue);
+ }
+ // Seems to bug on windows CLI sometimes.
+ $this->file->close();
+ }
+
+ /**
+ * Returns a variable of configuration.
+ *
+ * @param string $configKey
+ * The name of the configuration variable to retrieve.
+ *
+ * @return string
+ * The requested configuration value.
+ */
+ public function getConfig($configKey): string {
+ if (array_key_exists($configKey, $this->config)) {
+ return $this->config[$configKey];
+ }
+ return FALSE;
+ }
+
+ /**
+ * Get the current configuration.
+ *
+ * @return array
+ * The complete configuration array.
+ */
+ public function getAllConfig(): array {
+ return $this->config;
+ }
+
+ /**
+ * Returns the temporary working file.
+ *
+ * @return string
+ * The path to the temporary working file.
+ */
+ public function getTmpfile(): string {
+ return $this->tmpfile;
+ }
+
+ /**
+ * Get the pixel to centimeter conversion ratio.
+ *
+ * @return float
+ * The pixel to centimeter conversion ratio.
+ */
+ public function getPixelToCm(): float {
+ return self::PIXEL_TO_CM;
+ }
+
+ /**
+ * Recursive htmlspecialchars.
+ *
+ * @param mixed $value
+ * The value to convert.
+ *
+ * @return mixed
+ * The converted value.
+ */
+ protected function recursiveHtmlspecialchars($value): mixed {
+ if (is_array($value)) {
+ return array_map([$this, 'recursiveHtmlspecialchars'], $value);
+ }
+ else {
+ return htmlspecialchars($value);
+ }
+ }
+
}
diff --git a/src/Segment.php b/src/Segment.php
old mode 100644
new mode 100755
index c68fe31..7f2f60e
--- a/src/Segment.php
+++ b/src/Segment.php
@@ -3,240 +3,379 @@
namespace Odtphp;
use Odtphp\SegmentIterator;
+use Odtphp\Exceptions\SegmentException;
+use Odtphp\Exceptions\OdfException;
/**
- * Class for handling templating segments with odt files
- * You need PHP 5.2 at least
- * You need Zip Extension or PclZip library
- * Encoding : ISO-8859-1
- * Author: neveldo $
- * Modified by: Vikas Mahajan http://vikasmahajan.wordpress.com
- * Date - $Date: 2010-12-09 11:11:57
- * SVN Revision - $Rev: 44 $
- * Id : $Id: Segment.php 44 2009-06-17 10:12:59Z neveldo $
+ * Class for handling templating segments with ODT files.
*
- * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
- * @license http://www.gnu.org/copyleft/gpl.html GPL License
+ * You need PHP 8.1 at least.
+ * You need Zip Extension or PclZip library.
+ * Encoding: ISO-8859-1.
+ *
+ * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GPL License
* @version 1.3
*/
-class Segment implements \IteratorAggregate, \Countable
-{
- protected $xml;
- protected $xmlParsed = '';
- protected $name;
- protected $children = array();
- protected $vars = array();
- public $manif_vars = array();
- protected $images = array();
- protected $odf;
- protected $file;
-
- /**
- * Constructor
- *
- * @param string $name name of the segment to construct
- * @param string $xml XML tree of the segment
- */
- public function __construct($name, $xml, $odf)
- {
- $this->name = (string) $name;
- $this->xml = (string) $xml;
- $this->odf = $odf;
- $zipHandler = $this->odf->getConfig('ZIP_PROXY');
- $this->file = new $zipHandler();
- $this->_analyseChildren($this->xml);
- }
+class Segment implements \IteratorAggregate, \Countable {
+ /**
+ * XML content of the segment.
+ *
+ * @var string
+ */
+ protected $xml;
- /**
- * Returns the name of the segment
- *
- * @return string
- */
- public function getName()
- {
- return $this->name;
- }
+ /**
+ * Parsed XML content of the segment.
+ *
+ * @var string
+ */
+ protected $xmlParsed = '';
- /**
- * Does the segment have children ?
- *
- * @return bool
- */
- public function hasChildren()
- {
- return $this->getIterator()->hasChildren();
- }
+ /**
+ * Name of the segment.
+ *
+ * @var string
+ */
+ protected $name;
- /**
- * Countable interface
- *
- * @return int
- */
- public function count()
- {
- return count($this->children);
- }
+ /**
+ * Child segments of this segment.
+ *
+ * @var Segment[]
+ */
+ protected $children = [];
- /**
- * IteratorAggregate interface
- *
- * @return Iterator
- */
- public function getIterator()
- {
- return new \RecursiveIteratorIterator(new SegmentIterator($this->children), 1);
- }
+ /**
+ * Variables to be replaced in the segment.
+ *
+ * @var array
+ */
+ protected $vars = [];
- /**
- * Replace variables of the template in the XML code
- * All the children are also called
- *
- * @return string
- */
- public function merge()
- {
- $this->xmlParsed .= str_replace(array_keys($this->vars), array_values($this->vars), $this->xml);
- if ($this->hasChildren()) {
- foreach ($this->children as $child) {
- $this->xmlParsed = str_replace($child->xml, ($child->xmlParsed=="")?$child->merge():$child->xmlParsed, $this->xmlParsed);
- $child->xmlParsed = '';
- //Store all image names used in child segments in current segment array
- foreach ($child->manif_vars as $file) {
- $this->manif_vars[] = $file;
- }
-
- $child->manif_vars = array();
- }
- }
- $reg = "/\[!--\sBEGIN\s$this->name\s--\](.*)\[!--\sEND\s$this->name\s--\]/smU";
- $this->xmlParsed = preg_replace($reg, '$1', $this->xmlParsed);
- $this->file->open($this->odf->getTmpfile());
- foreach ($this->images as $imageKey => $imageValue) {
- if ($this->file->getFromName('Pictures/' . $imageValue) === false) {
- $this->file->addFile($imageKey, 'Pictures/' . $imageValue);
- }
+ /**
+ * Manifest variables for the segment.
+ *
+ * @var array
+ */
+ public $manifestVars = [];
+
+ /**
+ * Images used in the segment.
+ *
+ * @var array
+ */
+ protected $images = [];
+
+ /**
+ * ODT file object.
+ *
+ * @var object
+ */
+ protected $odf;
+
+ /**
+ * Zip file handler.
+ *
+ * @var object
+ */
+ protected $file;
+
+ /**
+ * Constructor.
+ *
+ * @param string $name
+ * Name of the segment to construct.
+ * @param string $xml
+ * XML tree of the segment.
+ * @param object $odf
+ * ODT file object.
+ */
+ public function __construct($name, $xml, $odf) {
+ $this->name = (string) $name;
+ $this->xml = (string) $xml;
+ $this->odf = $odf;
+ $zipHandler = $this->odf->getConfig('ZIP_PROXY');
+ $this->file = new $zipHandler();
+ $this->analyseChildren($this->xml);
+ }
+
+ /**
+ * Returns the name of the segment.
+ *
+ * @return string
+ * The name of the segment.
+ */
+ public function getName(): string {
+ return $this->name;
+ }
+
+ /**
+ * Checks if the segment has children.
+ *
+ * @return bool
+ * TRUE if the segment has children, FALSE otherwise.
+ */
+ public function hasChildren(): bool {
+ return !empty($this->children);
+ }
+
+ /**
+ * Implements the Countable interface.
+ *
+ * @return int
+ * Number of children in the segment.
+ */
+ #[\ReturnTypeWillChange]
+ public function count(): int {
+ return count($this->children);
+ }
+
+ /**
+ * Implements the IteratorAggregate interface.
+ *
+ * @return \RecursiveIteratorIterator
+ * Iterator for the segment's children.
+ */
+ #[\ReturnTypeWillChange]
+ public function getIterator(): \RecursiveIteratorIterator {
+ return new \RecursiveIteratorIterator(new SegmentIterator($this->children), 1);
+ }
+
+ /**
+ * Replace variables of the template in the XML code.
+ *
+ * All the children are also processed.
+ *
+ * @return string
+ * The merged XML content with variables replaced.
+ */
+ public function merge(): string {
+ $this->xmlParsed .= str_replace(array_keys($this->vars), array_values($this->vars), $this->xml);
+ if ($this->hasChildren()) {
+ foreach ($this->children as $child) {
+ $this->xmlParsed = str_replace($child->xml, ($child->xmlParsed == "") ? $child->merge() : $child->xmlParsed, $this->xmlParsed);
+ $child->xmlParsed = '';
+ // Store all image names used in child segments in current segment array.
+ foreach ($child->manifestVars as $file) {
+ $this->manifestVars[] = $file;
}
- $this->file->close();
- return $this->xmlParsed;
+ $child->manifestVars = [];
+ }
+ }
+ $reg = "/\[!--\sBEGIN\s$this->name\s--\](.*)\[!--\sEND\s$this->name\s--\]/smU";
+ $this->xmlParsed = preg_replace($reg, '$1', $this->xmlParsed);
+ $this->file->open($this->odf->getTmpfile());
+ foreach ($this->images as $imageKey => $imageValue) {
+ if ($this->file->getFromName('Pictures/' . $imageValue) === FALSE) {
+ $this->file->addFile($imageKey, 'Pictures/' . $imageValue);
+ }
}
- /**
- * Analyse the XML code in order to find children
- *
- * @param string $xml
- * @return Segment
- */
- protected function _analyseChildren($xml)
- {
- // $reg2 = "#\[!--\sBEGIN\s([\S]*)\s--\](?:<\/text:p>)?(.*)(?:)?\[!--\sEND\s(\\1)\s--\]#sm";
- $reg2 = "#\[!--\sBEGIN\s([\S]*)\s--\](.*)\[!--\sEND\s(\\1)\s--\]#smU";
- preg_match_all($reg2, $xml, $matches);
- for ($i = 0, $size = count($matches[0]); $i < $size; $i++) {
- if ($matches[1][$i] != $this->name) {
- $this->children[$matches[1][$i]] = new self($matches[1][$i], $matches[0][$i], $this->odf);
- } else {
- $this->_analyseChildren($matches[2][$i]);
- }
- }
- return $this;
+ $this->file->close();
+ return $this->xmlParsed;
+ }
+
+ /**
+ * Analyse the XML code to find children segments.
+ *
+ * @param string $xml
+ * XML content to analyse.
+ *
+ * @return $this
+ * The current segment instance.
+ */
+ protected function analyseChildren($xml): self {
+ $reg2 = "#\[!--\sBEGIN\s([\S]*)\s--\](.*)\[!--\sEND\s(\\1)\s--\]#smU";
+ preg_match_all($reg2, $xml, $matches);
+ for ($i = 0, $size = count($matches[0]); $i < $size; $i++) {
+ if ($matches[1][$i] != $this->name) {
+ $this->children[$matches[1][$i]] = new self($matches[1][$i], $matches[0][$i], $this->odf);
+ }
+ else {
+ $this->analyseChildren($matches[2][$i]);
+ }
}
+ return $this;
+ }
- /**
- * Assign a template variable to replace
- *
- * @param string $key
- * @param string $value
- * @throws SegmentException
- * @return Segment
- */
- public function setVars($key, $value, $encode = true, $charset = 'ISO-8859')
- {
- if (strpos($this->xml, $this->odf->getConfig('DELIMITER_LEFT') . $key . $this->odf->getConfig('DELIMITER_RIGHT')) === false) {
- throw new SegmentException("var $key not found in {$this->getName()}");
- }
- $value = $encode ? htmlspecialchars($value) : $value;
- $value = ($charset == 'ISO-8859') ? utf8_encode($value) : $value;
- $this->vars[$this->odf->getConfig('DELIMITER_LEFT') . $key . $this->odf->getConfig('DELIMITER_RIGHT')] = str_replace("\n", "", $value);
- return $this;
+ /**
+ * Assign a template variable to replace.
+ *
+ * @param string $key
+ * The variable key to replace.
+ * @param string $value
+ * The value to replace the variable with.
+ * @param bool $encode
+ * Whether to HTML encode the value.
+ * @param string $charset
+ * Character set for encoding.
+ *
+ * @throws \Odtphp\Exceptions\SegmentException
+ * If the variable is not found in the segment.
+ *
+ * @return $this
+ * The current segment instance.
+ */
+ public function setVars($key, $value, $encode = TRUE, $charset = 'UTF-8'): self {
+ if (strpos($this->xml, $this->odf->getConfig('DELIMITER_LEFT') . $key . $this->odf->getConfig('DELIMITER_RIGHT')) === FALSE) {
+ throw new SegmentException("var $key not found in {$this->getName()}");
}
+ $value = $encode ? htmlspecialchars($value) : $value;
+ $value = ($charset != 'UTF-8') ? mb_convert_encoding($value, 'UTF-8', $charset) : $value;
+ $this->vars[$this->odf->getConfig('DELIMITER_LEFT') . $key . $this->odf->getConfig('DELIMITER_RIGHT')] = str_replace("\n", "", $value);
+ return $this;
+ }
- /**
- * Assign a template variable as a picture
- *
- * @param string $key name of the variable within the template
- * @param string $value path to the picture
- * @param string $page anchor to page number (or -1 if anchor-type is aschar)
- * @param string $width width of picture (keep original if null)
- * @param string $height height of picture (keep original if null)
- * @param string $offsetX offset by horizontal (not used if $page = -1)
- * @param string $offsetY offset by vertical (not used if $page = -1)
- * @throws OdfException
- * @return Segment
- */
- public function setImage($key, $value, $page = null, $width = null, $height = null, $offsetX = null, $offsetY = null)
- {
- $filename = strtok(strrchr($value, '/'), '/.');
- $file = substr(strrchr($value, '/'), 1);
- $size = @getimagesize($value);
- if ($size === false) {
- throw new OdfException("Invalid image");
- }
- if (!$width && !$height) {
- list ($width, $height) = $size;
- $width *= Odf::PIXEL_TO_CM;
- $height *= Odf::PIXEL_TO_CM;
- }
- $anchor = $page == -1 ? 'text:anchor-type="aschar"' : "text:anchor-type=\"page\" text:anchor-page-number=\"{$page}\" svg:x=\"{$offsetX}cm\" svg:y=\"{$offsetY}cm\"";
- $xml = <<![]()
odf->getPixelToCm();
+ $height *= $this->odf->getPixelToCm();
+ }
+ $anchor = $page == -1 ? 'text:anchor-type="as-char"' : "text:anchor-type=\"page\" text:anchor-page-number=\"{$page}\" svg:x=\"{$offsetX}cm\" svg:y=\"{$offsetY}cm\"";
+ $xml = <<![]()
IMG;
- $this->images[$value] = $file;
- $this->manif_vars[] = $file; //save image name as array element
- $this->setVars($key, $xml, false);
- return $this;
- }
+ $this->images[$value] = $file;
+ $this->manifestVars[] = $file;
+ $this->setVars($key, $xml, FALSE);
+ return $this;
+ }
- /**
- * Shortcut to retrieve a child
- *
- * @param string $prop
- * @return Segment
- * @throws SegmentException
- */
- public function __get($prop)
- {
- if (array_key_exists($prop, $this->children)) {
- return $this->children[$prop];
- } else {
- throw new SegmentException('child ' . $prop . ' does not exist');
- }
+ /**
+ * Shortcut to retrieve a child.
+ *
+ * @param string $prop
+ * The name of the child segment to retrieve.
+ *
+ * @return Segment
+ * The child segment instance if it exists.
+ *
+ * @throws \Odtphp\Exceptions\SegmentException
+ * If the child segment does not exist.
+ */
+ public function __get($prop): Segment {
+ if (array_key_exists($prop, $this->children)) {
+ return $this->children[$prop];
+ }
+ else {
+ throw new SegmentException('child ' . $prop . ' does not exist');
}
+ }
- /**
- * Proxy for setVars
- *
- * @param string $meth
- * @param array $args
- * @return Segment
- */
- public function __call($meth, $args)
- {
- try {
- array_unshift($args, $meth);
- return call_user_func_array(array($this, 'setVars'), $args);
- } catch (SegmentException $e) {
- throw new SegmentException("method $meth nor var $meth exist");
- }
+ /**
+ * Proxy for setVars.
+ *
+ * @param string $meth
+ * The method name being called.
+ * @param array $args
+ * The arguments passed to the method.
+ *
+ * @return Segment
+ * The current segment instance after setting variables.
+ *
+ * @throws \Odtphp\Exceptions\SegmentException
+ * If the method or variable does not exist.
+ */
+ public function __call($meth, $args): Segment {
+ try {
+ array_unshift($args, $meth);
+ return call_user_func_array([$this, 'setVars'], $args);
+ }
+ catch (SegmentException $e) {
+ throw new SegmentException("method $meth nor var $meth exist");
}
-
- /**
- * Returns the parsed XML
- *
- * @return string
- */
- public function getXmlParsed()
- {
- return $this->xmlParsed;
+ }
+
+ /**
+ * Retrieve the parsed XML content.
+ *
+ * @return string
+ * The parsed XML content of the segment.
+ */
+ public function getXmlParsed(): string {
+ return $this->xmlParsed;
+ }
+
+ /**
+ * Create a new child segment.
+ *
+ * @param string $name
+ * Name of the child segment.
+ *
+ * @return Segment
+ * The child segment with the specified name.
+ *
+ * @throws \Odtphp\Exceptions\SegmentException
+ * If the segment does not exist.
+ */
+ public function setSegment($name): Segment {
+ if (!isset($this->children[$name])) {
+ throw new SegmentException("Segment '$name' does not exist");
}
+ return $this->children[$name];
+ }
+
+ /**
+ * Retrieve the XML content of the segment.
+ *
+ * @return string
+ * The original XML content of the segment.
+ */
+ public function getXml(): string {
+ return $this->xml;
+ }
+
+ /**
+ * Retrieve the segment's children.
+ *
+ * @return Segment[]
+ * An array of child segments.
+ */
+ public function getChildren(): array {
+ return $this->children;
+ }
+
+ /**
+ * Retrieve the segment's variables.
+ *
+ * @return array
+ * An array of variables in the segment.
+ */
+ public function getVars(): array {
+ return $this->vars;
+ }
+
}
diff --git a/src/SegmentIterator.php b/src/SegmentIterator.php
old mode 100644
new mode 100755
index dbde5ed..2fec05c
--- a/src/SegmentIterator.php
+++ b/src/SegmentIterator.php
@@ -1,65 +1,73 @@
*/
-class SegmentIterator implements \RecursiveIterator
-{
- private $ref;
- private $key;
+class SegmentIterator implements \Iterator, \Countable {
+ /**
+ * Current position in the iterator.
+ */
+ private int $position = 0;
- public function __construct(array $ref)
- {
- $this->ref = $ref;
- $this->key = 0;
- $this->keys = array_keys($this->ref);
- }
+ /**
+ * Initialize segment iterator.
+ *
+ * @param array $segments
+ * Array of segments to iterate over.
+ */
+ public function __construct(
+ private readonly array $segments,
+ ) {}
- public function hasChildren()
- {
- return $this->valid() && $this->current() instanceof Segment;
- }
+ /**
+ * Reset iterator position.
+ */
+ public function rewind(): void {
+ $this->position = 0;
+ }
- public function current()
- {
- return $this->ref[$this->keys[$this->key]];
- }
+ /**
+ * Get current segment.
+ */
+ public function current(): Segment {
+ return $this->segments[$this->position];
+ }
- public function getChildren()
- {
- return new self($this->current()->children);
- }
+ /**
+ * Get current position.
+ */
+ public function key(): int {
+ return $this->position;
+ }
- public function key()
- {
- return $this->key;
- }
+ /**
+ * Move to next segment.
+ */
+ public function next(): void {
+ ++$this->position;
+ }
- public function valid()
- {
- return array_key_exists($this->key, $this->keys);
- }
+ /**
+ * Check if current position is valid.
+ */
+ public function valid(): bool {
+ return isset($this->segments[$this->position]);
+ }
- public function rewind()
- {
- $this->key = 0;
- }
+ /**
+ * Get total number of segments.
+ */
+ public function count(): int {
+ return count($this->segments);
+ }
- public function next()
- {
- $this->key ++;
- }
}
diff --git a/src/Zip/PclZipProxy.php b/src/Zip/PclZipProxy.php
old mode 100644
new mode 100755
index b65786a..eadc7dc
--- a/src/Zip/PclZipProxy.php
+++ b/src/Zip/PclZipProxy.php
@@ -6,176 +6,244 @@
use Odtphp\Exceptions\PclZipProxyException;
/**
- * Proxy class for the PclZip library
- * You need PHP 5.2 at least
- * You need Zip Extension or PclZip library
- * Encoding : ISO-8859-1
- * Last commit by $Author: neveldo $
- * Date - $Date: 2009-05-29 10:05:11 +0200 (ven., 29 mai 2009) $
- * SVN Revision - $Rev: 28 $
- * Id : $Id: odf.php 28 2009-05-29 08:05:11Z neveldo $
+ * Proxy class for the PclZip library.
*
- * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
- * @license http://www.gnu.org/copyleft/gpl.html GPL License
+ * You need PHP 8.1 at least.
+ * You need Zip Extension or PclZip library.
+ * Encoding: ISO-8859-1.
+ *
+ * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GPL License
* @version 1.3
*/
-class PclZipProxy implements ZipInterface
-{
- const TMP_DIR = './tmp';
- protected $openned = false;
- protected $filename;
- protected $pclzip;
- /**
- * Class constructor
- *
- * @throws PclZipProxyException
- */
- public function __construct()
- {
- if (!class_exists('PclZip')) {
- throw new PclZipProxyException('PclZip class not loaded - PclZip library is required for using PclZipProxy');
- }
+class PclZipProxy implements ZipInterface {
+
+ /**
+ * Temporary directory path for processing zip files.
+ *
+ * @var string
+ */
+ protected $tmpDir;
+
+ /**
+ * Flag indicating if the zip file is opened.
+ *
+ * @var bool
+ */
+ protected $opened = FALSE;
+
+ /**
+ * Path to the current zip file.
+ *
+ * @var string
+ */
+ protected $filename;
+
+ /**
+ * PclZip instance for handling zip operations.
+ *
+ * @var \PclZip
+ */
+ protected $pclzip;
+
+ /**
+ * Class constructor.
+ *
+ * @throws \Odtphp\Exceptions\PclZipProxyException
+ * When PclZip library is not loaded.
+ */
+ public function __construct() {
+ if (!class_exists('PclZip')) {
+ throw new PclZipProxyException('PclZip class not loaded - PclZip library is required for using PclZipProxy');
}
- /**
- * Open a Zip archive
- *
- * @param string $filename the name of the archive to open
- * @return true if openning has succeeded
- */
- public function open($filename)
- {
- if (true === $this->openned) {
- $this->close();
- }
- if (!file_exists(self::TMP_DIR)) {
- mkdir(self::TMP_DIR);
- }
- $this->filename = $filename;
- $this->pclzip = new \PclZip($this->filename);
- $this->openned = true;
- return true;
- }
-
- /**
- * Retrieve the content of a file within the archive from its name
- *
- * @param string $name the name of the file to extract
- * @return the content of the file in a string
- */
- public function getFromName($name)
- {
- if (false === $this->openned) {
- return false;
- }
- $name = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $name);
- $extraction = $this->pclzip->extract(PCLZIP_OPT_BY_NAME, $name, PCLZIP_OPT_EXTRACT_AS_STRING);
- if (!empty($extraction)) {
- return $extraction[0]['content'];
- }
- return false;
- }
-
- /**
- * Add a file within the archive from a string
- *
- * @param string $localname the local path to the file in the archive
- * @param string $contents the content of the file
- * @return true if the file has been successful added
- */
- public function addFromString($localname, $contents)
- {
- if (false === $this->openned) {
- return false;
- }
- if (file_exists($this->filename) && !is_writable($this->filename)) {
- return false;
- }
- $localname = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $localname);
- $localpath = dirname($localname);
- $tmpfilename = self::TMP_DIR . '/' . basename($localname);
- if (false !== file_put_contents($tmpfilename, $contents)) {
- $this->pclzip->delete(PCLZIP_OPT_BY_NAME, $localname);
- $add = $this->pclzip->add($tmpfilename, PCLZIP_OPT_REMOVE_PATH, self::TMP_DIR, PCLZIP_OPT_ADD_PATH, $localpath);
- unlink($tmpfilename);
- if (!empty($add)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Add a file within the archive from a file
- *
- * @param string $filename the path to the file we want to add
- * @param string $localname the local path to the file in the archive
- * @return true if the file has been successful added
- */
- public function addFile($filename, $localname = null)
- {
- if (false === $this->openned) {
- return false;
- }
- if ((file_exists($this->filename) && !is_writable($this->filename))
- || !file_exists($filename)) {
- return false;
- }
- if (isset($localname)) {
- $localname = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $localname);
- $localpath = dirname($localname);
- $tmpfilename = self::TMP_DIR . '/' . basename($localname);
- } else {
- $localname = basename($filename);
- $tmpfilename = self::TMP_DIR . '/' . $localname;
- $localpath = '';
- }
- if (file_exists($filename)) {
- copy($filename, $tmpfilename);
- $this->pclzip->delete(PCLZIP_OPT_BY_NAME, $localname);
- $this->pclzip->add($tmpfilename, PCLZIP_OPT_REMOVE_PATH, self::TMP_DIR, PCLZIP_OPT_ADD_PATH, $localpath);
- unlink($tmpfilename);
- return true;
- }
- return false;
+
+ if (!function_exists("getmypid")) {
+ $pseudo_pid = mt_rand(1, 99999);
+ }
+ else {
+ $pseudo_pid = getmypid();
+ if (!$pseudo_pid) {
+ $pseudo_pid = mt_rand(1, 99999);
+ }
}
- /**
- * Close the Zip archive
- * @return true
- */
- public function close()
- {
- if (false === $this->openned) {
- return false;
- }
- $this->pclzip = $this->filename = null;
- $this->openned = false;
- if (file_exists(self::TMP_DIR)) {
- $this->_rrmdir(self::TMP_DIR);
- rmdir(self::TMP_DIR);
- }
- return true;
- }
-
- /**
- * Empty the temporary working directory recursively
- * @param $dir the temporary working directory
- * @return void
- */
- private function _rrmdir($dir)
- {
- if ($handle = opendir($dir)) {
- while (false !== ($file = readdir($handle))) {
- if ($file != '.' && $file != '..') {
- if (is_dir($dir . '/' . $file)) {
- $this->_rrmdir($dir . '/' . $file);
- rmdir($dir . '/' . $file);
- } else {
- unlink($dir . '/' . $file);
- }
- }
- }
- closedir($handle);
+ // Make a name that is unique enough for parallel processing: uniqid() by itself
+ // is not unique enough, it's just a hex representation of the system time.
+ $this->tmpDir = sys_get_temp_dir() . '/tmpdir_odtphp_' . uniqid(sprintf('%04X%04X%04X%04X%d',
+ mt_rand(0, 65535), mt_rand(0, 65535),
+ mt_rand(0, 65535), mt_rand(0, 65535), $pseudo_pid),
+ TRUE);
+ }
+
+ /**
+ * Open a Zip archive.
+ *
+ * @param string $filename
+ * The name of the archive to open.
+ *
+ * @return bool
+ * TRUE if opening has succeeded.
+ */
+ public function open($filename) {
+ if (TRUE === $this->opened) {
+ $this->close();
+ }
+ $this->filename = $filename;
+ $this->pclzip = new \PclZip($this->filename);
+ if (!file_exists($this->tmpDir)) {
+ if (mkdir($this->tmpDir)) {
+ // Created a new directory.
+ $this->opened = TRUE;
+ return TRUE;
+ }
+ else {
+ // Failed to create a directory.
+ $this->opened = FALSE;
+ return FALSE;
+ }
+ }
+ else {
+ // Directory already existed.
+ $this->opened = FALSE;
+ return FALSE;
+ }
+ }
+
+ /**
+ * Retrieve the content of a file within the archive from its name.
+ *
+ * @param string $name
+ * The name of the file to extract.
+ *
+ * @return string|bool
+ * The content of the file as a string, or FALSE if retrieval fails.
+ */
+ public function getFromName($name) {
+ if (FALSE === $this->opened) {
+ return FALSE;
+ }
+ $name = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $name);
+ $extraction = $this->pclzip->extract(PCLZIP_OPT_BY_NAME, $name, PCLZIP_OPT_EXTRACT_AS_STRING);
+ if (!empty($extraction)) {
+ return $extraction[0]['content'];
+ }
+ return FALSE;
+ }
+
+ /**
+ * Add a file within the archive from a string.
+ *
+ * @param string $localname
+ * The local path to the file in the archive.
+ * @param string $contents
+ * The content of the file.
+ *
+ * @return bool
+ * TRUE if the file has been successfully added.
+ */
+ public function addFromString($localname, $contents) {
+ if (FALSE === $this->opened) {
+ return FALSE;
+ }
+ if (file_exists($this->filename) && !is_writable($this->filename)) {
+ return FALSE;
+ }
+ $localname = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $localname);
+ $localpath = dirname($localname);
+ $tmpfilename = $this->tmpDir . '/' . basename($localname);
+ if (FALSE !== file_put_contents($tmpfilename, $contents)) {
+ $this->pclzip->delete(PCLZIP_OPT_BY_NAME, $localname);
+ $add = $this->pclzip->add($tmpfilename, PCLZIP_OPT_REMOVE_PATH, $this->tmpDir, PCLZIP_OPT_ADD_PATH, $localpath);
+ unlink($tmpfilename);
+ if (!empty($add)) {
+ return TRUE;
+ }
+ }
+ return FALSE;
+ }
+
+ /**
+ * Add a file within the archive from a file.
+ *
+ * @param string $filename
+ * The path to the file we want to add.
+ * @param string|null $localname
+ * The local path to the file in the archive.
+ *
+ * @return bool
+ * TRUE if the file has been successfully added.
+ */
+ public function addFile($filename, $localname = NULL) {
+ if (FALSE === $this->opened) {
+ return FALSE;
+ }
+ if ((file_exists($this->filename) && !is_writable($this->filename))
+ || !file_exists($filename)) {
+ return FALSE;
+ }
+ if (isset($localname)) {
+ $localname = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $localname);
+ $localpath = dirname($localname);
+ $tmpfilename = $this->tmpDir . '/' . basename($localname);
+ }
+ else {
+ $localname = basename($filename);
+ $tmpfilename = $this->tmpDir . '/' . $localname;
+ $localpath = '';
+ }
+ if (file_exists($filename)) {
+ copy($filename, $tmpfilename);
+ $this->pclzip->delete(PCLZIP_OPT_BY_NAME, $localname);
+ $this->pclzip->add($tmpfilename, PCLZIP_OPT_REMOVE_PATH, $this->tmpDir, PCLZIP_OPT_ADD_PATH, $localpath);
+ unlink($tmpfilename);
+ return TRUE;
+ }
+ return FALSE;
+ }
+
+ /**
+ * Close the Zip archive.
+ *
+ * @return bool
+ * TRUE if the archive was closed successfully.
+ */
+ public function close() {
+ if (FALSE === $this->opened) {
+ return FALSE;
+ }
+ $this->pclzip = $this->filename = NULL;
+ $this->opened = FALSE;
+ if (file_exists($this->tmpDir)) {
+ $this->removeDir($this->tmpDir);
+ }
+ return TRUE;
+ }
+
+ /**
+ * Remove directory recursively.
+ *
+ * @param string $dir
+ * The directory to remove.
+ *
+ * @return bool
+ * TRUE if the directory was successfully removed.
+ */
+ private function removeDir($dir): bool {
+ if ($handle = opendir($dir)) {
+ while (FALSE !== ($file = readdir($handle))) {
+ if ($file != '.' && $file != '..') {
+ if (is_dir($dir . '/' . $file)) {
+ $this->removeDir($dir . '/' . $file);
+ rmdir($dir . '/' . $file);
+ }
+ else {
+ unlink($dir . '/' . $file);
+ }
}
+ }
+ closedir($handle);
}
+ return rmdir($dir);
+ }
+
}
diff --git a/src/Zip/PhpZipProxy.php b/src/Zip/PhpZipProxy.php
old mode 100644
new mode 100755
index 9275bcb..a80496c
--- a/src/Zip/PhpZipProxy.php
+++ b/src/Zip/PhpZipProxy.php
@@ -6,98 +6,117 @@
use Odtphp\Exceptions\PhpZipProxyException;
/**
- * Proxy class for the PHP Zip Extension
- * You need PHP 5.2 at least
- * You need Zip Extension or PclZip library
- * Encoding : ISO-8859-1
- * Last commit by $Author: neveldo $
- * Date - $Date: 2009-05-29 10:05:11 +0200 (ven., 29 mai 2009) $
- * SVN Revision - $Rev: 28 $
- * Id : $Id: odf.php 28 2009-05-29 08:05:11Z neveldo $
+ * Proxy class for the PHP Zip Extension.
*
- * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
- * @license http://www.gnu.org/copyleft/gpl.html GPL License
+ * You need PHP 8.1 at least.
+ * You need Zip Extension or PclZip library.
+ * Encoding: ISO-8859-1.
+ *
+ * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GPL License
* @version 1.3
*/
+class PhpZipProxy implements ZipInterface {
-class PhpZipProxy implements ZipInterface
-{
- protected $zipArchive;
- protected $filename;
+ /**
+ * ZipArchive instance for handling zip operations.
+ *
+ * @var \ZipArchive
+ */
+ protected $zipArchive;
- /**
- * Class constructor
- *
- * @throws PhpZipProxyException
- */
- public function __construct()
- {
- if (! class_exists('ZipArchive')) {
- throw new PhpZipProxyException('Zip extension not loaded - check your php settings, PHP5.2 minimum with zip extension is required for using PhpZipProxy');
- }
- $this->zipArchive = new ZipArchive();
- }
+ /**
+ * Path to the current zip file.
+ *
+ * @var string
+ */
+ protected $filename;
- /**
- * Open a Zip archive
- *
- * @param string $filename the name of the archive to open
- * @return true if openning has succeeded
- */
- public function open($filename)
- {
- $this->filename = $filename;
- return $this->zipArchive->open($filename, ZIPARCHIVE::CREATE);
+ /**
+ * Class constructor.
+ *
+ * @throws \Odtphp\Exceptions\PhpZipProxyException
+ * When Zip extension is not loaded.
+ */
+ public function __construct() {
+ if (!class_exists('ZipArchive')) {
+ throw new PhpZipProxyException('Zip extension not loaded - check your php settings, PHP5.2 minimum with zip extension is required for using PhpZipProxy');
}
+ $this->zipArchive = new \ZipArchive();
+ }
- /**
- * Retrieve the content of a file within the archive from its name
- *
- * @param string $name the name of the file to extract
- * @return the content of the file in a string
- */
- public function getFromName($name)
- {
- return $this->zipArchive->getFromName($name);
- }
+ /**
+ * Open a Zip archive.
+ *
+ * @param string $filename
+ * The name of the archive to open.
+ *
+ * @return bool
+ * TRUE if opening has succeeded.
+ */
+ public function open($filename) {
+ $this->filename = $filename;
+ return $this->zipArchive->open($filename, \ZIPARCHIVE::CREATE);
+ }
- /**
- * Add a file within the archive from a string
- *
- * @param string $localname the local path to the file in the archive
- * @param string $contents the content of the file
- * @return true if the file has been successful added
- */
- public function addFromString($localname, $contents)
- {
- if (file_exists($this->filename) && !is_writable($this->filename)) {
- return false;
- }
- return $this->zipArchive->addFromString($localname, $contents);
- }
+ /**
+ * Retrieve the content of a file within the archive from its name.
+ *
+ * @param string $name
+ * The name of the file to extract.
+ *
+ * @return string|bool
+ * The content of the file as a string, or FALSE if retrieval fails.
+ */
+ public function getFromName($name) {
+ return $this->zipArchive->getFromName($name);
+ }
- /**
- * Add a file within the archive from a file
- *
- * @param string $filename the path to the file we want to add
- * @param string $localname the local path to the file in the archive
- * @return true if the file has been successful added
- */
- public function addFile($filename, $localname = null)
- {
- if ((file_exists($this->filename) && !is_writable($this->filename))
- || !file_exists($filename)) {
- return false;
- }
- return $this->zipArchive->addFile($filename, $localname);
+ /**
+ * Add a file within the archive from a string.
+ *
+ * @param string $localname
+ * The local path to the file in the archive.
+ * @param string $contents
+ * The content of the file.
+ *
+ * @return bool
+ * TRUE if the file has been successfully added.
+ */
+ public function addFromString($localname, $contents) {
+ if (file_exists($this->filename) && !is_writable($this->filename)) {
+ return FALSE;
}
+ return $this->zipArchive->addFromString($localname, $contents);
+ }
- /**
- * Close the Zip archive
- * @return true
- */
- public function close()
- {
- return $this->zipArchive->close();
+ /**
+ * Add a file within the archive from a file.
+ *
+ * @param string $filename
+ * The path to the file we want to add.
+ * @param string|null $localname
+ * The local path to the file in the archive.
+ *
+ * @return bool
+ * TRUE if the file has been successfully added.
+ */
+ public function addFile($filename, $localname = NULL) {
+ if ((file_exists($this->filename) && !is_writable($this->filename))
+ || !file_exists($filename)) {
+ return FALSE;
}
+ return $this->zipArchive->addFile($filename, $localname);
+ }
+
+ /**
+ * Close the Zip archive.
+ *
+ * @return bool
+ * TRUE if the archive was closed successfully.
+ */
+ public function close() {
+ return $this->zipArchive->close();
+ }
+
}
diff --git a/src/Zip/ZipInterface.php b/src/Zip/ZipInterface.php
old mode 100644
new mode 100755
index 5da90f7..7d831de
--- a/src/Zip/ZipInterface.php
+++ b/src/Zip/ZipInterface.php
@@ -3,58 +3,72 @@
namespace Odtphp\Zip;
/**
- * Interface for Zip libraries used in odtPHP
- * You need PHP 5.2 at least
- * You need Zip Extension or PclZip library
- * Encoding : ISO-8859-1
- * Last commit by $Author: neveldo $
- * Date - $Date: 2009-05-29 10:05:11 +0200 (ven., 29 mai 2009) $
- * SVN Revision - $Rev: 28 $
- * Id : $Id: odf.php 28 2009-05-29 08:05:11Z neveldo $
+ * Interface for Zip libraries used in ODT PHP.
*
- * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
- * @license http://www.gnu.org/copyleft/gpl.html GPL License
+ * You need PHP 8.1 at least.
+ * You need Zip Extension or PclZip library.
+ * Encoding: ISO-8859-1.
+ *
+ * @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GPL License
* @version 1.3
*/
-interface ZipInterface
-{
- /**
- * Open a Zip archive
- *
- * @param string $filename the name of the archive to open
- * @return true if openning has succeeded
- */
- public function open($filename);
-
- /**
- * Retrieve the content of a file within the archive from its name
- *
- * @param string $name the name of the file to extract
- * @return the content of the file in a string
- */
- public function getFromName($name);
-
- /**
- * Add a file within the archive from a string
- *
- * @param string $localname the local path to the file in the archive
- * @param string $contents the content of the file
- * @return true if the file has been successful added
- */
- public function addFromString($localname, $contents);
-
- /**
- * Add a file within the archive from a file
- *
- * @param string $filename the path to the file we want to add
- * @param string $localname the local path to the file in the archive
- * @return true if the file has been successful added
- */
- public function addFile($filename, $localname = null);
-
- /**
- * Close the Zip archive
- * @return true
- */
- public function close();
+interface ZipInterface {
+
+ /**
+ * Open a Zip archive.
+ *
+ * @param string $filename
+ * The name of the archive to open.
+ *
+ * @return bool
+ * TRUE if opening has succeeded.
+ */
+ public function open($filename);
+
+ /**
+ * Retrieve the content of a file within the archive from its name.
+ *
+ * @param string $name
+ * The name of the file to extract.
+ *
+ * @return string|bool
+ * The content of the file as a string, or FALSE if retrieval fails.
+ */
+ public function getFromName($name);
+
+ /**
+ * Add a file within the archive from a string.
+ *
+ * @param string $localname
+ * The local path to the file in the archive.
+ * @param string $contents
+ * The content of the file.
+ *
+ * @return bool
+ * TRUE if the file has been successfully added.
+ */
+ public function addFromString($localname, $contents);
+
+ /**
+ * Add a file within the archive from a file.
+ *
+ * @param string $filename
+ * The path to the file we want to add.
+ * @param string|null $localname
+ * The local path to the file in the archive.
+ *
+ * @return bool
+ * TRUE if the file has been successfully added.
+ */
+ public function addFile($filename, $localname = NULL);
+
+ /**
+ * Close the Zip archive.
+ *
+ * @return bool
+ * TRUE if the archive was closed successfully.
+ */
+ public function close();
+
}
diff --git a/tests/src/Basic1Test.php b/tests/src/Basic1Test.php
new file mode 100755
index 0000000..d42095f
--- /dev/null
+++ b/tests/src/Basic1Test.php
@@ -0,0 +1,56 @@
+odfPhpZipConfig();
+ $gold_dir = 'gold_phpzip';
+ $type_name = 'PhpZip';
+ }
+ else {
+ $config = $this->odfPclZipConfig();
+ $gold_dir = 'gold_pclzip';
+ $type_name = 'PclZip';
+ }
+
+ $input_file = __DIR__ . '/files/input/BasicTest1.odt';
+ $odf = new Odf($input_file, $config);
+
+ $odf->setVars('titre',
+ 'PHP: Hypertext Preprocessor');
+
+ $message = "PHP (sigle de PHP: Hypertext Preprocessor), est un langage de scripts libre
+principalement utilisé pour produire des pages Web dynamiques via un serveur HTTP, mais
+pouvant également fonctionner comme n'importe quel langage interprété de façon locale,
+en exécutant les programmes en ligne de commande.";
+
+ $odf->setVars('message', $message, TRUE, 'UTF-8');
+
+ $output_name = __DIR__ . "/files/output/BasicTest1" . $type_name . "Output.odt";
+ // We export the file
+ $odf->saveToDisk($output_name);
+
+ // print("\nComparing files:\n $output_name\n files/$gold_dir/BasicTest1Gold.odt\n");
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, __DIR__ . "/files/$gold_dir/BasicTest1Gold.odt"));
+
+ unlink($output_name);
+ }
+
+ public function testBasicPclZip1(): void {
+ $this->basic1(self::PCLZIP_TYPE);
+ }
+
+ public function testBasicPhpZip1(): void {
+ $this->basic1(self::PHPZIP_TYPE);
+ }
+
+}
diff --git a/tests/src/Basic2Test.php b/tests/src/Basic2Test.php
new file mode 100755
index 0000000..5e957da
--- /dev/null
+++ b/tests/src/Basic2Test.php
@@ -0,0 +1,54 @@
+odfPhpZipConfig();
+ $gold_dir = 'gold_phpzip';
+ $type_name = 'PhpZip';
+ }
+ else {
+ $config = $this->odfPclZipConfig();
+ $gold_dir = 'gold_pclzip';
+ $type_name = 'PclZip';
+ }
+
+ $input_file = __DIR__ . '/files/input/BasicTest2.odt';
+ $odf = new Odf($input_file, $config);
+
+ $odf->setVars('titre', 'PHP: Hypertext Preprocessor');
+
+ $message = "PHP (sigle de PHP: Hypertext Preprocessor), est un langage de scripts libre
+principalement utilisé pour produire des pages Web dynamiques via un serveur HTTP, mais
+pouvant également fonctionner comme n'importe quel langage interprété de façon locale,
+en exécutant les programmes en ligne de commande.";
+
+ $odf->setVars('message', $message, TRUE, 'UTF-8');
+
+ $odf->setImage('image', __DIR__ . '/files/images/anaska.jpg');
+
+ $output_name = __DIR__ . "/files/output/BasicTest2" . $type_name . "Output.odt";
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, __DIR__ . "/files/$gold_dir/BasicTest2Gold.odt"));
+
+ unlink($output_name);
+ }
+
+ public function testBasicPclZip2(): void {
+ $this->basic2(self::PCLZIP_TYPE);
+ }
+
+ public function testBasicPhpZip2(): void {
+ $this->basic2(self::PHPZIP_TYPE);
+ }
+}
diff --git a/tests/src/BasicTest1.odt b/tests/src/BasicTest1.odt
new file mode 100755
index 0000000..05eab71
Binary files /dev/null and b/tests/src/BasicTest1.odt differ
diff --git a/tests/src/ConfigTest.php b/tests/src/ConfigTest.php
new file mode 100755
index 0000000..97a232a
--- /dev/null
+++ b/tests/src/ConfigTest.php
@@ -0,0 +1,45 @@
+expectException(\TypeError::class);
+ $this->expectExceptionMessage('Argument #2 ($config) must be of type array');
+ new Odf(__DIR__ . '/files/input/BasicTest1.odt', 'invalid');
+ }
+
+ public function testCustomDelimiters(): void {
+ $config = array_merge($this->odfPhpZipConfig(), [
+ 'DELIMITER_LEFT' => '[[',
+ 'DELIMITER_RIGHT' => ']]'
+ ]);
+
+ $odf = new Odf(__DIR__ . "/files/input/ConfigTest.odt", $config);
+ $odf->setVars('test_var', 'test value');
+
+ $output_name = __DIR__ . "/files/output/ConfigTestOutput.odt";
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, __DIR__ . "/files/gold_phpzip/ConfigTestGold.odt"));
+ unlink($output_name);
+ }
+
+ public function testInvalidTempPath(): void {
+ $config = array_merge($this->odfPhpZipConfig(), [
+ 'PATH_TO_TMP' => '/nonexistent/path'
+ ]);
+
+ $this->expectException(OdfException::class);
+ new Odf(__DIR__ . "/files/input/BasicTest1.odt", $config);
+ }
+}
diff --git a/tests/src/EdgeCaseTest.php b/tests/src/EdgeCaseTest.php
new file mode 100755
index 0000000..ec09f0c
--- /dev/null
+++ b/tests/src/EdgeCaseTest.php
@@ -0,0 +1,177 @@
+odfPhpZipConfig();
+ $gold_dir = 'gold_phpzip';
+ $type_name = 'PhpZip';
+ }
+ else {
+ $config = $this->odfPclZipConfig();
+ $gold_dir = 'gold_pclzip';
+ $type_name = 'PclZip';
+ }
+
+ switch ($testName) {
+ case 'LargeVariableSubstitution':
+ $input_file = __DIR__ . '/files/input/LargeVariableTest.odt';
+ $output_name = __DIR__ . '/files/output/LargeVariableTest' . $type_name . 'Output.odt';
+ $gold_file = __DIR__ . '/files/' . $gold_dir . '/LargeVariableTestGold.odt';
+
+ $odf = new Odf($input_file, $config);
+
+ // Generate a large text block
+ $largeText = str_repeat("This is a large text block with many repetitions. ", 1000);
+
+ $odf->setVars('large_content', $largeText, true, 'UTF-8');
+
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, $gold_file));
+
+ unlink($output_name);
+ break;
+
+ case 'ComplexSegmentMerging':
+ $input_file = __DIR__ . '/files/input/NestedSegmentTest.odt';
+ $output_name = __DIR__ . '/files/output/NestedSegmentTest' . $type_name . 'Output.odt';
+ $gold_file = __DIR__ . '/files/' . $gold_dir . '/NestedSegmentTestGold.odt';
+
+ $odf = new Odf($input_file, $config);
+
+ // Create a nested data structure
+ $departments = [
+ [
+ 'name' => 'Engineering',
+ 'employees' => [
+ ['name' => 'Alice', 'role' => 'Senior Developer'],
+ ['name' => 'Bob', 'role' => 'Junior Developer']
+ ]
+ ],
+ [
+ 'name' => 'Marketing',
+ 'employees' => [
+ ['name' => 'Charlie', 'role' => 'Marketing Manager'],
+ ['name' => 'David', 'role' => 'Content Strategist']
+ ]
+ ]
+ ];
+
+ $departmentSegment = $odf->setSegment('departments');
+
+ foreach ($departments as $department) {
+ $departmentSegment->setVars('department_name', $department['name']);
+
+ $employeeSegment = $departmentSegment->setSegment('employees');
+
+ foreach ($department['employees'] as $employee) {
+ $employeeSegment->setVars('employee_name', $employee['name']);
+ $employeeSegment->setVars('employee_role', $employee['role']);
+ $employeeSegment->merge();
+ }
+ $departmentSegment->merge();
+ }
+ $odf->mergeSegment($departmentSegment);
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, $gold_file));
+
+ unlink($output_name);
+ break;
+
+ case 'SpecialCharacterEncoding':
+ $input_file = __DIR__ . '/files/input/EncodingTest.odt';
+ $output_name = __DIR__ . '/files/output/EncodingTest' . $type_name . 'Output.odt';
+ $gold_file = __DIR__ . '/files/' . $gold_dir . '/EncodingTestGold.odt';
+
+ $specialCharText = "Special characters: éèà €ñ¿ § ® © µ";
+
+ $odf = new Odf($input_file, $config);
+
+ $odf->setVars('special_chars', $specialCharText, true, 'UTF-8');
+
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, $gold_file));
+
+ unlink($output_name);
+ break;
+
+ case 'AdvancedImageInsertion':
+ $input_file = __DIR__ . '/files/input/ImageTest.odt';
+ $output_name = __DIR__ . '/files/output/AdvancedImageTest' . $type_name . 'Output.odt';
+ $gold_file = __DIR__ . '/files/' . $gold_dir . '/AdvancedImageTestGold.odt';
+
+ $odf = new Odf($input_file, $config);
+
+ // Test different image types and sizes
+ $images = [
+ 'small_png' => __DIR__ . '/files/images/voronoi_sphere.png',
+ 'large_jpg' => __DIR__ . '/files/images/test.jpg',
+ 'transparent_gif' => __DIR__ . '/files/images/circle_transparent.gif'
+ ];
+
+ foreach ($images as $key => $imagePath) {
+ $odf->setImage($key, $imagePath);
+ }
+
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, $gold_file));
+
+ unlink($output_name);
+ break;
+ }
+ }
+
+ public function testLargeVariableSubstitutionPclZip(): void {
+ $this->edgeCase(self::PCLZIP_TYPE, 'LargeVariableSubstitution');
+ }
+
+ public function testLargeVariableSubstitutionPhpZip(): void {
+ $this->edgeCase(self::PHPZIP_TYPE, 'LargeVariableSubstitution');
+ }
+
+ public function testComplexSegmentMergingPclZip(): void {
+ $this->edgeCase(self::PCLZIP_TYPE, 'ComplexSegmentMerging');
+ }
+
+ public function testComplexSegmentMergingPhpZip(): void {
+ $this->edgeCase(self::PHPZIP_TYPE, 'ComplexSegmentMerging');
+ }
+
+ public function testSpecialCharacterEncodingPclZip(): void {
+ $this->edgeCase(self::PCLZIP_TYPE, 'SpecialCharacterEncoding');
+ }
+
+ public function testSpecialCharacterEncodingPhpZip(): void {
+ $this->edgeCase(self::PHPZIP_TYPE, 'SpecialCharacterEncoding');
+ }
+
+ public function testAdvancedImageInsertionPclZip(): void {
+ $this->edgeCase(self::PCLZIP_TYPE, 'AdvancedImageInsertion');
+ }
+
+ public function testAdvancedImageInsertionPhpZip(): void {
+ $this->edgeCase(self::PHPZIP_TYPE, 'AdvancedImageInsertion');
+ }
+
+ /**
+ * Test handling of invalid template files.
+ */
+ public function testInvalidTemplateHandling(): void {
+ $this->expectException(\Odtphp\Exceptions\OdfException::class);
+ $this->expectExceptionMessage("File '" . __DIR__ . "/files/input/NonexistentTemplate.odt' does not exist");
+ new Odf(__DIR__ . '/files/input/NonexistentTemplate.odt');
+ }
+}
diff --git a/tests/src/ImageTest.php b/tests/src/ImageTest.php
new file mode 100755
index 0000000..2a761a8
--- /dev/null
+++ b/tests/src/ImageTest.php
@@ -0,0 +1,40 @@
+odfPclZipConfig();
+ $odf = new Odf(__DIR__ . "/files/input/ImageTest.odt", $config);
+ $odf->setImage('test_image', __DIR__ . "/files/images/voronoi_sphere.png");
+ $output_name = __DIR__ . "/files/output/ImageTestOutput.odt";
+ $odf->saveToDisk($output_name);
+ $this->assertFileExists($output_name);
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, __DIR__ . "/files/gold_phpzip/ImageTestGold.odt"));
+ unlink($output_name);
+ }
+
+ public function testImageResizing(): void {
+ $config = $this->odfPclZipConfig();
+ $odf = new Odf(__DIR__ . "/files/input/ImageTest.odt", $config);
+ $odf->setImage('test_image', __DIR__ . "/files/images/test.jpg", -1, 100, 100);
+ $output_name = __DIR__ . "/files/output/ImageTestResizedOutput.odt";
+ $odf->saveToDisk($output_name);
+ $this->assertFileExists($output_name);
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, __DIR__ . "/files/gold_phpzip/ImageTestResizedGold.odt"));
+ unlink($output_name);
+ }
+
+ public function testInvalidImagePath(): void {
+ $config = $this->odfPclZipConfig();
+ $odf = new Odf(__DIR__ . "/files/input/ImageTest.odt", $config);
+ $this->expectException(OdfException::class);
+ $odf->setImage('test_image', __DIR__ . "/files/images/nonexistent.png");
+ }
+}
diff --git a/tests/src/OdtTestCase.php b/tests/src/OdtTestCase.php
new file mode 100755
index 0000000..d6295e3
--- /dev/null
+++ b/tests/src/OdtTestCase.php
@@ -0,0 +1,100 @@
+ \Odtphp\Zip\PhpZipProxy::class,
+ 'DELIMITER_LEFT' => '{',
+ 'DELIMITER_RIGHT' => '}',
+ ];
+ }
+
+ protected function odfPclZipConfig() {
+ return [
+ 'ZIP_PROXY' => \Odtphp\Zip\PclZipProxy::class,
+ 'DELIMITER_LEFT' => '{',
+ 'DELIMITER_RIGHT' => '}',
+ ];
+ }
+
+
+ protected function extractText($filename) {
+ $file_parts = explode('.', $filename);
+ $ext = end($file_parts);
+ if ($ext == 'docx') {
+ $dataFile = "word/document.xml";
+ }
+ else {
+ $dataFile = "content.xml";
+ }
+ $zip = new \ZipArchive;
+ if (TRUE === $zip->open($filename)) {
+ if (($index = $zip->locateName($dataFile)) !== FALSE) {
+ // Index found! Now read it to a string
+ $text = $zip->getFromIndex($index);
+ // Load XML from a string
+ // Ignore errors and warnings
+ $doc = new DOMDocument();
+ $rcode = $doc->loadXML($text,
+ LIBXML_NOENT | LIBXML_XINCLUDE | LIBXML_NOERROR | LIBXML_NOWARNING);
+ // Remove XML formatting tags and return the text
+ return strip_tags($doc->saveXML());
+ }
+ // Close the archive file
+ $zip->close();
+ }
+ // In case of failure return a message
+ return "File not found";
+ }
+
+
+ function odtFilesAreIdentical($file1, $file2)
+ {
+ // Ensure both files exist
+ if (!file_exists($file1)) {
+ throw new Exception("File $file1 does not exist.");
+ }
+
+ if (!file_exists($file2)) {
+ throw new Exception("File $file2 does not exist.");
+ }
+
+ // Open the first .odt file as a ZIP archive and extract content.xml
+ $zip1 = new \ZipArchive;
+ $zip2 = new \ZipArchive;
+
+ if ($zip1->open($file1) !== true) {
+ throw new Exception("Unable to open file: " . $file1);
+ }
+
+ if ($zip2->open($file2) !== true) {
+ $zip1->close();
+ throw new Exception("Unable to open file: " . $file2);
+ }
+
+ // Read the content.xml files from both .odt files
+ $content1 = $zip1->getFromName("content.xml");
+ $content2 = $zip2->getFromName("content.xml");
+
+ // Close the archives
+ $zip1->close();
+ $zip2->close();
+
+ // Compare the contents of content.xml
+ return $content1 === $content2;
+ }
+}
diff --git a/tests/src/VariableTest.php b/tests/src/VariableTest.php
new file mode 100755
index 0000000..ffcbd99
--- /dev/null
+++ b/tests/src/VariableTest.php
@@ -0,0 +1,46 @@
+odfPhpZipConfig();
+ $odf = new Odf(__DIR__ . "/files/input/VariableTest.odt", $config);
+
+ $this->assertTrue($odf->variableExists('test_var'));
+ $this->assertFalse($odf->variableExists('nonexistent_var'));
+ }
+
+ public function testSpecialCharacterEncoding(): void {
+ $config = $this->odfPhpZipConfig();
+ $odf = new Odf(__DIR__ . "/files/input/VariableTest.odt", $config);
+
+ $specialChars = "<>&'\"";
+ $odf->setVars('test_var', $specialChars, true);
+
+ $output_name = __DIR__ . "/files/output/VariableTestOutputSpecialChars.odt";
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, __DIR__ . "/files/gold_phpzip/VariableTestSpecialCharsGold.odt"));
+ unlink($output_name);
+ }
+
+ public function testMultilineText(): void {
+ $config = $this->odfPhpZipConfig();
+ $odf = new Odf(__DIR__ . "/files/input/VariableTest.odt", $config);
+
+ $multiline = "Line 1\nLine 2\nLine 3";
+ $odf->setVars('test_var', $multiline, true);
+
+ $output_name = __DIR__ . "/files/output/VariableTestOutputMultiline.odt";
+ $odf->saveToDisk($output_name);
+
+ $this->assertTrue($this->odtFilesAreIdentical($output_name, __DIR__ . "/files/gold_phpzip/VariableTestMultilineGold.odt"));
+ unlink($output_name);
+ }
+}
diff --git a/tests/src/files/gold_pclzip/AdvancedImageTestGold.odt b/tests/src/files/gold_pclzip/AdvancedImageTestGold.odt
new file mode 100755
index 0000000..b0045f6
Binary files /dev/null and b/tests/src/files/gold_pclzip/AdvancedImageTestGold.odt differ
diff --git a/tests/src/files/gold_pclzip/BasicTest1Gold.odt b/tests/src/files/gold_pclzip/BasicTest1Gold.odt
new file mode 100755
index 0000000..9cda417
Binary files /dev/null and b/tests/src/files/gold_pclzip/BasicTest1Gold.odt differ
diff --git a/tests/src/files/gold_pclzip/BasicTest2Gold.odt b/tests/src/files/gold_pclzip/BasicTest2Gold.odt
new file mode 100755
index 0000000..af50d9c
Binary files /dev/null and b/tests/src/files/gold_pclzip/BasicTest2Gold.odt differ
diff --git a/tests/src/files/gold_pclzip/ConfigTestGold.odt b/tests/src/files/gold_pclzip/ConfigTestGold.odt
new file mode 100755
index 0000000..5fac55e
Binary files /dev/null and b/tests/src/files/gold_pclzip/ConfigTestGold.odt differ
diff --git a/tests/src/files/gold_pclzip/EncodingTestGold.odt b/tests/src/files/gold_pclzip/EncodingTestGold.odt
new file mode 100755
index 0000000..7243f7a
Binary files /dev/null and b/tests/src/files/gold_pclzip/EncodingTestGold.odt differ
diff --git a/tests/src/files/gold_pclzip/ImageTestGold.odt b/tests/src/files/gold_pclzip/ImageTestGold.odt
new file mode 100755
index 0000000..ad10489
Binary files /dev/null and b/tests/src/files/gold_pclzip/ImageTestGold.odt differ
diff --git a/tests/src/files/gold_pclzip/ImageTestOutputGold.odt b/tests/src/files/gold_pclzip/ImageTestOutputGold.odt
new file mode 100755
index 0000000..ad10489
Binary files /dev/null and b/tests/src/files/gold_pclzip/ImageTestOutputGold.odt differ
diff --git a/tests/src/files/gold_pclzip/ImageTestResizedGold.odt b/tests/src/files/gold_pclzip/ImageTestResizedGold.odt
new file mode 100755
index 0000000..1e3360f
Binary files /dev/null and b/tests/src/files/gold_pclzip/ImageTestResizedGold.odt differ
diff --git a/tests/src/files/gold_pclzip/ImageTestResizedOutputGold.odt b/tests/src/files/gold_pclzip/ImageTestResizedOutputGold.odt
new file mode 100755
index 0000000..1e3360f
Binary files /dev/null and b/tests/src/files/gold_pclzip/ImageTestResizedOutputGold.odt differ
diff --git a/tests/src/files/gold_pclzip/LargeVariableTestGold.odt b/tests/src/files/gold_pclzip/LargeVariableTestGold.odt
new file mode 100755
index 0000000..86562d4
Binary files /dev/null and b/tests/src/files/gold_pclzip/LargeVariableTestGold.odt differ
diff --git a/tests/src/files/gold_pclzip/NestedSegmentTestGold.odt b/tests/src/files/gold_pclzip/NestedSegmentTestGold.odt
new file mode 100755
index 0000000..a87b007
Binary files /dev/null and b/tests/src/files/gold_pclzip/NestedSegmentTestGold.odt differ
diff --git a/tests/src/files/gold_pclzip/VariableTestGold.odt b/tests/src/files/gold_pclzip/VariableTestGold.odt
new file mode 100755
index 0000000..5100ff7
--- /dev/null
+++ b/tests/src/files/gold_pclzip/VariableTestGold.odt
@@ -0,0 +1,8 @@
+
+
+
+
+ <>&'"
+
+
+
diff --git a/tests/src/files/gold_phpzip/AdvancedImageTestGold.odt b/tests/src/files/gold_phpzip/AdvancedImageTestGold.odt
new file mode 100755
index 0000000..b0045f6
Binary files /dev/null and b/tests/src/files/gold_phpzip/AdvancedImageTestGold.odt differ
diff --git a/tests/src/files/gold_phpzip/BasicTest1Gold.odt b/tests/src/files/gold_phpzip/BasicTest1Gold.odt
new file mode 100755
index 0000000..b864541
Binary files /dev/null and b/tests/src/files/gold_phpzip/BasicTest1Gold.odt differ
diff --git a/tests/src/files/gold_phpzip/BasicTest2Gold.odt b/tests/src/files/gold_phpzip/BasicTest2Gold.odt
new file mode 100755
index 0000000..af50d9c
Binary files /dev/null and b/tests/src/files/gold_phpzip/BasicTest2Gold.odt differ
diff --git a/tests/src/files/gold_phpzip/ConfigTestGold.odt b/tests/src/files/gold_phpzip/ConfigTestGold.odt
new file mode 100755
index 0000000..5fac55e
Binary files /dev/null and b/tests/src/files/gold_phpzip/ConfigTestGold.odt differ
diff --git a/tests/src/files/gold_phpzip/EncodingTestGold.odt b/tests/src/files/gold_phpzip/EncodingTestGold.odt
new file mode 100755
index 0000000..5a7b254
Binary files /dev/null and b/tests/src/files/gold_phpzip/EncodingTestGold.odt differ
diff --git a/tests/src/files/gold_phpzip/EncodingTestPhpGold.odt b/tests/src/files/gold_phpzip/EncodingTestPhpGold.odt
new file mode 100755
index 0000000..7243f7a
Binary files /dev/null and b/tests/src/files/gold_phpzip/EncodingTestPhpGold.odt differ
diff --git a/tests/src/files/gold_phpzip/ImageTestGold.odt b/tests/src/files/gold_phpzip/ImageTestGold.odt
new file mode 100755
index 0000000..bbd94b6
Binary files /dev/null and b/tests/src/files/gold_phpzip/ImageTestGold.odt differ
diff --git a/tests/src/files/gold_phpzip/ImageTestResizedGold.odt b/tests/src/files/gold_phpzip/ImageTestResizedGold.odt
new file mode 100755
index 0000000..c91340a
Binary files /dev/null and b/tests/src/files/gold_phpzip/ImageTestResizedGold.odt differ
diff --git a/tests/src/files/gold_phpzip/LargeVariableTestGold.odt b/tests/src/files/gold_phpzip/LargeVariableTestGold.odt
new file mode 100755
index 0000000..86562d4
Binary files /dev/null and b/tests/src/files/gold_phpzip/LargeVariableTestGold.odt differ
diff --git a/tests/src/files/gold_phpzip/NestedSegmentTestGold.odt b/tests/src/files/gold_phpzip/NestedSegmentTestGold.odt
new file mode 100755
index 0000000..a87b007
Binary files /dev/null and b/tests/src/files/gold_phpzip/NestedSegmentTestGold.odt differ
diff --git a/tests/src/files/gold_phpzip/VariableTestGold.odt b/tests/src/files/gold_phpzip/VariableTestGold.odt
new file mode 100755
index 0000000..5100ff7
--- /dev/null
+++ b/tests/src/files/gold_phpzip/VariableTestGold.odt
@@ -0,0 +1,8 @@
+
+
+
+
+ <>&'"
+
+
+
diff --git a/tests/src/files/gold_phpzip/VariableTestMultilineGold.odt b/tests/src/files/gold_phpzip/VariableTestMultilineGold.odt
new file mode 100755
index 0000000..adabf5a
Binary files /dev/null and b/tests/src/files/gold_phpzip/VariableTestMultilineGold.odt differ
diff --git a/tests/src/files/gold_phpzip/VariableTestSpecialCharsGold.odt b/tests/src/files/gold_phpzip/VariableTestSpecialCharsGold.odt
new file mode 100755
index 0000000..0b65492
Binary files /dev/null and b/tests/src/files/gold_phpzip/VariableTestSpecialCharsGold.odt differ
diff --git a/tests/src/files/images/anaska.gif b/tests/src/files/images/anaska.gif
new file mode 100755
index 0000000..1ea3f0e
Binary files /dev/null and b/tests/src/files/images/anaska.gif differ
diff --git a/tests/src/files/images/anaska.jpg b/tests/src/files/images/anaska.jpg
new file mode 100755
index 0000000..b02b4c4
Binary files /dev/null and b/tests/src/files/images/anaska.jpg differ
diff --git a/tests/src/files/images/circle_transparent.gif b/tests/src/files/images/circle_transparent.gif
new file mode 100755
index 0000000..9a8eeed
Binary files /dev/null and b/tests/src/files/images/circle_transparent.gif differ
diff --git a/tests/src/files/images/mysql.gif b/tests/src/files/images/mysql.gif
new file mode 100755
index 0000000..6520883
Binary files /dev/null and b/tests/src/files/images/mysql.gif differ
diff --git a/tests/src/files/images/overschot.jpg b/tests/src/files/images/overschot.jpg
new file mode 100755
index 0000000..e5bb4ed
Binary files /dev/null and b/tests/src/files/images/overschot.jpg differ
diff --git a/tests/src/files/images/php.gif b/tests/src/files/images/php.gif
new file mode 100755
index 0000000..f352c73
Binary files /dev/null and b/tests/src/files/images/php.gif differ
diff --git a/tests/src/files/images/test.jpg b/tests/src/files/images/test.jpg
new file mode 100755
index 0000000..4e03043
Binary files /dev/null and b/tests/src/files/images/test.jpg differ
diff --git a/tests/src/files/images/voronoi_sphere.png b/tests/src/files/images/voronoi_sphere.png
new file mode 100755
index 0000000..1685f87
Binary files /dev/null and b/tests/src/files/images/voronoi_sphere.png differ
diff --git a/tests/src/files/input/BasicTest1.odt b/tests/src/files/input/BasicTest1.odt
new file mode 100755
index 0000000..f1af2af
Binary files /dev/null and b/tests/src/files/input/BasicTest1.odt differ
diff --git a/tests/src/files/input/BasicTest2.odt b/tests/src/files/input/BasicTest2.odt
new file mode 100755
index 0000000..68ae776
Binary files /dev/null and b/tests/src/files/input/BasicTest2.odt differ
diff --git a/tests/src/files/input/ConfigTest.odt b/tests/src/files/input/ConfigTest.odt
new file mode 100755
index 0000000..480ce57
Binary files /dev/null and b/tests/src/files/input/ConfigTest.odt differ
diff --git a/tests/src/files/input/EncodingTest.odt b/tests/src/files/input/EncodingTest.odt
new file mode 100755
index 0000000..985fcbc
Binary files /dev/null and b/tests/src/files/input/EncodingTest.odt differ
diff --git a/tests/src/files/input/ImageTest.odt b/tests/src/files/input/ImageTest.odt
new file mode 100755
index 0000000..376df50
Binary files /dev/null and b/tests/src/files/input/ImageTest.odt differ
diff --git a/tests/src/files/input/LargeVariableTest.odt b/tests/src/files/input/LargeVariableTest.odt
new file mode 100755
index 0000000..5196e2d
Binary files /dev/null and b/tests/src/files/input/LargeVariableTest.odt differ
diff --git a/tests/src/files/input/LargeVariableTest1.odt b/tests/src/files/input/LargeVariableTest1.odt
new file mode 100755
index 0000000..e87b3ca
--- /dev/null
+++ b/tests/src/files/input/LargeVariableTest1.odt
@@ -0,0 +1 @@
+{large_content}
diff --git a/tests/src/files/input/NestedSegmentTest.odt b/tests/src/files/input/NestedSegmentTest.odt
new file mode 100755
index 0000000..7f477e5
Binary files /dev/null and b/tests/src/files/input/NestedSegmentTest.odt differ
diff --git a/tests/src/files/input/VariableTest.odt b/tests/src/files/input/VariableTest.odt
new file mode 100755
index 0000000..d72bac6
Binary files /dev/null and b/tests/src/files/input/VariableTest.odt differ
diff --git a/tests/src/files/output/.gitkeep b/tests/src/files/output/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/tests/tutoriel1.php b/tests/tutoriel1.php
deleted file mode 100755
index a03db63..0000000
--- a/tests/tutoriel1.php
+++ /dev/null
@@ -1,35 +0,0 @@
-setVars('titre', 'PHP: Hypertext PreprocessorPHP: Hypertext Preprocessor');
-
-$message = "PHP (sigle de PHP: Hypertext Preprocessor), est un langage de scripts libre
-principalement utilisé pour produire des pages Web dynamiques via un serveur HTTP, mais
-pouvant également fonctionner comme n'importe quel langage interprété de façon locale,
-en exécutant les programmes en ligne de commande.";
-
-$odf->setVars('message', $message);
-
-// We export the file
-$odf->exportAsAttachedFile();
diff --git a/tests/tutoriel2.php b/tests/tutoriel2.php
deleted file mode 100755
index bf77aa3..0000000
--- a/tests/tutoriel2.php
+++ /dev/null
@@ -1,34 +0,0 @@
-setVars('titre','Anaska formation');
-
-$message = "Anaska, leader Français de la formation informatique sur les technologies
-Open Source, propose un catalogue de plus de 50 formations dont certaines préparent
-aux certifications Linux, MySQL, PHP et PostgreSQL.";
-
-$odf->setVars('message', $message);
-
-$odf->setImage('image', './images/anaska.jpg');
-
-// We export the file
-$odf->exportAsAttachedFile();
-
-?>
\ No newline at end of file
diff --git a/tests/tutoriel3.php b/tests/tutoriel3.php
deleted file mode 100755
index 3aaef67..0000000
--- a/tests/tutoriel3.php
+++ /dev/null
@@ -1,53 +0,0 @@
-setVars('titre', 'Quelques articles de l\'encyclopédie Wikipédia');
-
-$message = "La force de cette encyclopédie en ligne réside dans son nombre important de
- contributeurs. Ce sont en effet des millions d'articles qui sont disponibles dans la langue
- de Shakespeare et des centaines de milliers d'autres dans de nombreuses langues dont
- le français, l'espagnol, l'italien, le turc ou encore l'allemand.";
-
-$odf->setVars('message', $message);
-
-$listeArticles = array(
- array( 'titre' => 'PHP',
- 'texte' => 'PHP (sigle de PHP: Hypertext Preprocessor), est un langage de scripts (...)',
- ),
- array( 'titre' => 'MySQL',
- 'texte' => 'MySQL est un système de gestion de base de données (SGDB). Selon le (...)',
- ),
- array( 'titre' => 'Apache',
- 'texte' => 'Apache HTTP Server, souvent appelé Apache, est un logiciel de serveur (...)',
- ),
-);
-
-$article = $odf->setSegment('articles');
-foreach($listeArticles AS $element) {
- $article->titreArticle($element['titre']);
- $article->texteArticle($element['texte']);
- $article->merge();
-}
-$odf->mergeSegment($article);
-
-// We export the file
-$odf->exportAsAttachedFile();
-
-?>
\ No newline at end of file
diff --git a/tests/tutoriel5.odt b/tests/tutoriel5.odt
deleted file mode 100755
index b9079f2..0000000
Binary files a/tests/tutoriel5.odt and /dev/null differ
diff --git a/tests/tutoriel6.php b/tests/tutoriel6.php
deleted file mode 100755
index e957409..0000000
--- a/tests/tutoriel6.php
+++ /dev/null
@@ -1,53 +0,0 @@
-setVars('titre', 'Quelques articles de l\'encyclopédie Wikipédia');
-
-$message = "La force de cette encyclopédie en ligne réside dans son nombre important de
- contributeurs. Ce sont en effet des millions d'articles qui sont disponibles dans la langue
- de Shakespeare et des centaines de milliers d'autres dans de nombreuses langues dont
- le français, l'espagnol, l'italien, le turc ou encore l'allemand.";
-
-$odf->setVars('message', $message);
-
-$listeArticles = array(
- array( 'titre' => 'PHP',
- 'texte' => 'PHP (sigle de PHP: Hypertext Preprocessor), est un langage de scripts (...)',
- ),
- array( 'titre' => 'MySQL',
- 'texte' => 'MySQL est un système de gestion de base de données (SGDB). Selon le (...)',
- ),
- array( 'titre' => 'Apache',
- 'texte' => 'Apache HTTP Server, souvent appelé Apache, est un logiciel de serveur (...)',
- ),
-);
-
-$article = $odf->setSegment('articles');
-foreach($listeArticles AS $element) {
- $article->titreArticle($element['titre']);
- $article->texteArticle($element['texte']);
- $article->merge();
-}
-$odf->mergeSegment($article);
-
-// We export the file
-$odf->exportAsAttachedFile();
-
-?>
\ No newline at end of file
diff --git a/tests/tutoriel7.php b/tests/tutoriel7.php
deleted file mode 100755
index a37b2bb..0000000
--- a/tests/tutoriel7.php
+++ /dev/null
@@ -1,39 +0,0 @@
- 'PhpZipProxy', // Make sure you have Zip extension loaded
- 'DELIMITER_LEFT' => '#', // Yan can also change delimiters
- 'DELIMITER_RIGHT' => '#'
-);
-
-$odf = new Odf("tutoriel7.odt", $config);
-
-$odf->setVars('titre', 'PHP: Hypertext PreprocessorPHP: Hypertext Preprocessor');
-
-$message = "PHP (sigle de PHP: Hypertext Preprocessor), est un langage de scripts libre
-principalement utilisé pour produire des pages Web dynamiques via un serveur HTTP, mais
-pouvant également fonctionner comme n'importe quel langage interprété de façon locale,
-en exécutant les programmes en ligne de commande.";
-
-$odf->setVars('message', $message);
-
-// We export the file
-$odf->exportAsAttachedFile();
-
-?>
\ No newline at end of file