Merge pull request zendframework/zendframework#5880 from spiffyjr/fea…

…ture/php-array-fix-dir

Updated PhpArray to expand paths using __DIR__

src/Writer/PhpArray.php

@@ -9,6 +9,8 @@
 
 namespace Zend\Config\Writer;
 
+use Zend\Config\Exception;
+
 class PhpArray extends AbstractWriter
 {
     /**
@@ -51,6 +53,53 @@ public function setUseBracketArraySyntax($value)
         return $this;
     }
 
+    /**
+     * toFile(): defined by Writer interface.
+     *
+     * @see    WriterInterface::toFile()
+     * @param  string  $filename
+     * @param  mixed   $config
+     * @param  bool $exclusiveLock
+     * @return void
+     * @throws Exception\InvalidArgumentException
+     * @throws Exception\RuntimeException
+     */
+    public function toFile($filename, $config, $exclusiveLock = true)
+    {
+        if (empty($filename)) {
+            throw new Exception\InvalidArgumentException('No file name specified');
+        }
+
+        $flags = 0;
+        if ($exclusiveLock) {
+            $flags |= LOCK_EX;
+        }
+
+        set_error_handler(
+            function ($error, $message = '', $file = '', $line = 0) use ($filename) {
+                throw new Exception\RuntimeException(sprintf(
+                    'Error writing to "%s": %s',
+                    $filename, $message
+                ), $error);
+            }, E_WARNING
+        );
+
+        try {
+            // for Windows, paths are escaped.
+            $dirname = str_replace('\\', '\\\\', dirname($filename));
+
+            $string  = $this->toString($config);
+            $string  = str_replace("'" . $dirname, "__DIR__ . '", $string);
+
+            file_put_contents($filename, $string, $flags);
+        } catch (\Exception $e) {
+            restore_error_handler();
+            throw $e;
+        }
+
+        restore_error_handler();
+    }
+
     /**
      * Recursively processes a PHP config array structure into a readable format.
      *

test/Writer/PhpArrayTest.php

@@ -99,6 +99,23 @@ public function testRenderWithQuotesInString()
         $this->assertEquals($expected, $configString);
     }
 
+    public function testWriteConvertsPathToDirWhenWritingBackToFile()
+    {
+        $filename = $this->getTestAssetFileName();
+        file_put_contents($filename, file_get_contents(__DIR__ . '/_files/array.php'));
+
+        $this->writer->toFile($filename, include $filename);
+
+        // Ensure file endings are same
+        $expected = trim(file_get_contents(__DIR__ . '/_files/array.php'));
+        $expected = preg_replace("~\r\n|\n|\r~", PHP_EOL, $expected);
+
+        $result = trim(file_get_contents($filename));
+        $result = preg_replace("~\r\n|\n|\r~", PHP_EOL, $result);
+
+        $this->assertSame($expected, $result);
+    }
+
     public function testSetUseBracketArraySyntaxReturnsFluentInterface()
     {
         $this->assertSame($this->writer, $this->writer->setUseBracketArraySyntax(true));

test/Writer/_files/array.php

@@ -0,0 +1,4 @@
+<?php
+return array(
+    'dir' => __DIR__ . '/foobar.php',
+);