Merge c1223c7 into 73f5866

CHANGELOG.md

@@ -6,7 +6,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#15](https://github.com/laminas/laminas-modulemanager/pull/15) adds support for caching closures when caching configuration.
 
 ### Changed
 

composer.json

@@ -26,6 +26,7 @@
     },
     "require": {
         "php": "^7.3",
+        "brick/varexporter": "^0.3.2",
         "laminas/laminas-config": "^3.1 || ^2.6",
         "laminas/laminas-eventmanager": "^3.2 || ^2.6.3",
         "laminas/laminas-stdlib": "^3.1 || ^2.7",

src/Listener/AbstractListener.php

@@ -8,6 +8,9 @@
 
 namespace Laminas\ModuleManager\Listener;
 
+use Brick\VarExporter\ExportException;
+use Brick\VarExporter\VarExporter;
+use Laminas\ModuleManager\Listener\Exception\ConfigCannotBeCachedException;
 use Webimpress\SafeWriter\FileWriter;
 
 /**
@@ -62,7 +65,15 @@ public function setOptions(ListenerOptions $options)
      */
     protected function writeArrayToFile($filePath, $array)
     {
-        $content = "<?php\nreturn " . var_export($array, true) . ';';
+        try {
+            $content = "<?php\n" . VarExporter::export(
+                $array,
+                VarExporter::ADD_RETURN | VarExporter::CLOSURE_SNAPSHOT_USES
+            ) . ';';
+        } catch (ExportException $e) {
+            throw ConfigCannotBeCachedException::fromExporterException($e);
+        }
+
         FileWriter::writeFile($filePath, $content);
 
         return $this;

src/Listener/Exception/ConfigCannotBeCachedException.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * @see       https://github.com/laminas/laminas-modulemanager for the canonical source repository
+ * @copyright https://github.com/laminas/laminas-modulemanager/blob/master/COPYRIGHT.md
+ * @license   https://github.com/laminas/laminas-modulemanager/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Laminas\ModuleManager\Listener\Exception;
+
+use Brick\VarExporter\ExportException;
+use RuntimeException;
+use Throwable;
+
+use function sprintf;
+
+final class ConfigCannotBeCachedException extends RuntimeException
+{
+    private function __construct($message = "", $code = 0, ?Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+
+    /**
+     * @internal
+     *
+     * @return self
+     */
+    public static function fromExporterException(ExportException $exportException): self
+    {
+        return new self(
+            sprintf(
+                'Cannot export config into a cache file. Config contains uncacheable entries: %s',
+                $exportException->getMessage()
+            ),
+            $exportException->getCode(),
+            $exportException
+        );
+    }
+}

test/Listener/_files/good/merge3.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @see       https://github.com/laminas/laminas-modulemanager for the canonical source repository
+ * @copyright https://github.com/laminas/laminas-modulemanager/blob/master/COPYRIGHT.md
+ * @license   https://github.com/laminas/laminas-modulemanager/blob/master/LICENSE.md New BSD License
+ */
+
+return [
+    'toUpper' => function ($input) {
+        return strtoupper($input);
+    },
+];