Issue #55 Make nested values work in XfdfFile

Author: mikehaertl

src/Command.php

@@ -10,7 +10,7 @@
  * and adds pdftk specific features to add options and operations.
  *
  * @author Michael Härtl <haertl.mike@gmail.com>
- * @version 0.2.2
+ * @version 0.2.3-dev
  * @license http://www.opensource.org/licenses/MIT
  */
 class Command extends BaseCommand

src/FdfFile.php

@@ -10,7 +10,7 @@
  * with valid unicode characters.
  *
  * @author Michael Härtl <haertl.mike@gmail.com>
- * @version 0.2.2
+ * @version 0.2.3-dev
  * @license http://www.opensource.org/licenses/MIT
  */
 class FdfFile extends File
@@ -52,6 +52,10 @@ public function __construct($data, $suffix = null, $prefix = null, $directory =
         rename($this->_fileName, $newName);
         $this->_fileName = $newName;
 
+        if (!function_exists('mb_convert_encoding')) {
+            throw new \Exception('MB extension required.');
+        }
+
         $fields = '';
         foreach ($data as $key=>$value) {
             // Create UTF-16BE string encode as ASCII hex

src/Pdf.php

@@ -12,7 +12,7 @@
  * but you may have to use slightly different page rotation options (e.g 'E' instead 'east').
  *
  * @author Michael Härtl <haertl.mike@gmail.com>
- * @version 0.2.2
+ * @version 0.2.3-dev
  * @license http://www.opensource.org/licenses/MIT
  */
 class Pdf

src/XfdfFile.php

@@ -11,7 +11,7 @@
  *
  * @author Tomas Holy <holy@interconnect.cz>
  * @author Michael Härtl <haertl.mike@gmail.com>
- * @version 0.2.2
+ * @version 0.2.3-dev
  * @license http://www.opensource.org/licenses/MIT
  */
 class XfdfFile extends File
@@ -54,7 +54,7 @@ public function __construct($data, $suffix = null, $prefix = null, $directory =
         $fields = array();
         foreach ($data as $key=>$value) {
             // Always convert to UTF-8
-            if ($encoding!=='UTF-8') {
+            if ($encoding!=='UTF-8' && function_exists('mb_convert_encoding')) {
                 $value = mb_convert_encoding($value,'UTF-8', $encoding);
                 $key = mb_convert_encoding($key,'UTF-8', $encoding);
             }
@@ -63,14 +63,48 @@ public function __construct($data, $suffix = null, $prefix = null, $directory =
             $sanitizedKey = defined('ENT_XML1') ? htmlspecialchars($key, ENT_XML1, 'UTF-8') : htmlspecialchars($key);
             $sanitizedValue = defined('ENT_XML1') ? htmlspecialchars($value, ENT_XML1, 'UTF-8') : htmlspecialchars($value);
 
-            $fields[] = "<field name=\"$sanitizedKey\">\n<value>$sanitizedValue</value>\n</field>\n";
+            // Key can be in dot notation like 'Address.name'
+            $keys = explode('.', $sanitizedKey);
+            $final = array_pop($keys);
+            if (count($keys)===0) {
+                $fields[$final] = $sanitizedValue;
+            } else {
+                $target =& $fields;
+                foreach ($keys as $part) {
+                    if (!isset($target[$part])) {
+                        $target[$part] = array();
+                    }
+                    $target =& $target[$part];
+                }
+                $target[$final] = $sanitizedValue;
+            }
         }
 
         // Use fwrite, since file_put_contents() messes around with character encoding
         $fp = fopen($this->_fileName, 'w');
         fwrite($fp, self::XFDF_HEADER);
-        fwrite($fp, implode("\n", $fields));
+        $this->writeFields($fp, $fields);
         fwrite($fp, self::XFDF_FOOTER);
         fclose($fp);
     }
+
+    /**
+     * Write the fields to the given filepointer
+     *
+     * @param int $fp
+     * @param mixed[] $fields an array of field values. A value can also be another array
+     * in which case a nested field is written.
+     */
+    protected function writeFields($fp, $fields)
+    {
+        foreach ($fields as $key => $value) {
+            if (is_array($value)) {
+                fwrite($fp, "<field name=\"$key\">\n");
+                $this->writeFields($fp, $value);
+                fwrite($fp, "</field>\n");
+            } else {
+                fwrite($fp, "<field name=\"$key\">\n<value>$value</value>\n</field>\n");
+            }
+        }
+    }
 }

tests/FdfFileTest.php

@@ -20,6 +20,6 @@ public function testFdfFileCreation() {
         $sFdfFilename = $oFdfFile->getFileName();
 
         $this->assertFileExists($sFdfFilename);
-        $this->assertFileEquals($sFdfFilename, __DIR__."/files/FdfFileTest.fdf");
+        $this->assertFileEquals(__DIR__."/files/FdfFileTest.fdf", $sFdfFilename);
     }
 }

tests/XfdfFileTest.php

@@ -8,8 +8,10 @@ public function testXfdfFileCreation() {
             'name' => 'Jürgen čárka čČćĆđĐ мирано',
             'email' => 'test@email.com',
             'checkbox 1' => 'Yes',
+            'address.name' => 'some name',
             'checkbox 2' => 0,
             'radio 1' => 2,
+            'address.street' => 'some street',
             "umlauts-in-value" => "öäüÖÄÜ",
             "öäüÖÄÜ" => "umlauts in key",
             "special-in-value" => "ۧ&()",
@@ -20,6 +22,6 @@ public function testXfdfFileCreation() {
         $sXfdfFilename = $oXfdfFile->getFileName();
 
         $this->assertFileExists($sXfdfFilename);
-        $this->assertFileEquals($sXfdfFilename, __DIR__."/files/XfdfFileTest.xfdf");
+        $this->assertFileEquals(__DIR__."/files/XfdfFileTest.xfdf", $sXfdfFilename);
     }
 }

tests/files/XfdfFileTest.xfdf

@@ -3,35 +3,35 @@
 <fields><field name="name">
 <value>Jürgen čárka čČćĆđĐ мирано</value>
 </field>
-
 <field name="email">
 <value>test@email.com</value>
 </field>
-
 <field name="checkbox 1">
 <value>Yes</value>
 </field>
-
+<field name="address">
+<field name="name">
+<value>some name</value>
+</field>
+<field name="street">
+<value>some street</value>
+</field>
+</field>
 <field name="checkbox 2">
 <value>0</value>
 </field>
-
 <field name="radio 1">
 <value>2</value>
 </field>
-
 <field name="umlauts-in-value">
 <value>öäüÖÄÜ</value>
 </field>
-
 <field name="öäüÖÄÜ">
 <value>umlauts in key</value>
 </field>
-
 <field name="special-in-value">
 <value>ۧ&amp;()</value>
 </field>
-
 <field name="€ key">
 <value>special in key</value>
 </field>