[ValueExporter] added support for formatters FQCN instead of instances

symfony · HeahDude · Apr 4, 2016 · Apr 5, 2016 · Apr 9, 2016 · Apr 9, 2016
commit 8f63b0786164a7f456d8b6ba5ffd10b9d69c8796
diff --git a/src/Symfony/Component/ValueExporter/Exporter/AbstractValueExporter.php b/src/Symfony/Component/ValueExporter/Exporter/AbstractValueExporter.php
@@ -39,19 +39,26 @@ abstract class AbstractValueExporter implements ValueExporterInterface
     protected $formatterInterface = FormatterInterface::class;
 
     /**
-     * An array of arrays of formatters by priority.
+     * An array of priorities by formatter class.
      *
      * @var array[]
      */
     private $formatters = array();
 
     /**
-     * A sorted array of formatters.
+     * An array of formatters instances sorted by priority or null.
      *
-     * @var FormatterInterface[]
+     * @var FormatterInterface[]|null
      */
     private $sortedFormatters;
 
+    /**
+     * An array of cached formatters instances by class.
+     *
+     * @var FormatterInterface[]
+     */
+    private $cachedFormatters = array();
+
     /**
      * Takes {@link FormatterInterface} as arguments.
      *
@@ -72,23 +79,19 @@ final public function addFormatters(array $formatters)
         foreach ($formatters as $formatter) {
             if (is_array($formatter)) {
                 $priority = (int) $formatter[1];
-                $formatter = $formatter[0];
+                $formatterClass = $formatter[0];
             } else {
                 $priority = 0;
+                $formatterClass = $formatter;
             }
 
-            $formatterClass = get_class($formatter);
-
-            if (!$formatter instanceof $this->formatterInterface) {
+            if (!in_array($this->formatterInterface, class_implements($formatterClass), true)) {
                 throw new InvalidFormatterException($formatterClass, stat
8000
ic::class, $this->formatterInterface);
             }
 
-            if (in_array(ExpandedFormatterTrait::class, class_uses($formatterClass), true)) {
-                $formatter->setExporter($this);
-            }
-
-            // Using the class as key prevents duplicate
-            $this->formatters[$priority][$formatterClass] = $formatter;
+            // Using the class as key prevents duplicate and allows to
+            // dynamically change the priority
+            $this->formatters[$formatterClass] = $priority;
         }
     }
 
@@ -98,8 +101,24 @@ final public function addFormatters(array $formatters)
     final protected function formatters()
     {
         if (null === $this->sortedFormatters) {
-            krsort($this->formatters);
-            $this->sortedFormatters = call_user_func_array('array_merge', $this->formatters);
+            arsort($this->formatters);
+
+            foreach (array_keys($this->formatters) as $formatterClass) {
+                if (isset($this->cachedFormatters[$formatterClass])) {
+                    $this->sortedFormatters[] = $this->cachedFormatters[$formatterClass];
+
+                    continue;
+                }
+
+                $formatter = new $formatterClass();
+
+                if (in_array(ExpandedFormatterTrait::class, class_uses($formatterClass), true)) {
+                    /* @var ExpandedFormatterTrait $formatter */
+                    $formatter->setExporter($this);
+                }
+
+                $this->sortedFormatters[] = $this->cachedFormatters[$formatterClass] = $formatter;
+            }
         }
 
         return $this->sortedFormatters;

diff --git a/src/Symfony/Component/ValueExporter/Tests/ValueExporterTest.php b/src/Symfony/Component/ValueExporter/Tests/ValueExporterTest.php
@@ -52,7 +52,7 @@ public function testExportValueExpanded()
 
     public function testExportTraversable()
     {
-        ValueExporter::addFormatters(array(new TraversableToStringFormatter()));
+        ValueExporter::addFormatters(array(TraversableToStringFormatter::class));
 
         $value = new TraversableInstance();
         $exportedValue = <<<EOT

diff --git a/src/Symfony/Component/ValueExporter/ValueExporter.php b/src/Symfony/Component/ValueExporter/ValueExporter.php
@@ -36,10 +36,10 @@ public static function export($value, $depth = 1, $expand = false)
     {
         if (null === self::$handler) {
             $exporter = self::$exporter ?: new ValueToStringExporter(
-                new CallableToStringFormatter(),
-                new DateTimeToStringFormatter(),
-                new EntityToStringFormatter(),
-                new PhpIncompleteClassToStringFormatter()
+                CallableToStringFormatter::class,
+                DateTimeToStringFormatter::class,
+                EntityToStringFormatter::class,
+                PhpIncompleteClassToStringFormatter::class
             );
             $exporter->addFormatters(self::$formatters);
             // Clear formatters