feature #28622 [VarDumper] add caster for Memcached (jschaedl)

This PR was squashed before being merged into the 4.2-dev branch (closes #28622).

Discussion
----------

[VarDumper] add caster for Memcached

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #28597
| License       | MIT
| Doc PR        | -

Commits
-------

f95d943 [VarDumper] add caster for Memcached

src/Symfony/Component/VarDumper/Caster/MemcachedCaster.php

@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Caster;
+
+use Symfony\Component\VarDumper\Cloner\Stub;
+
+/**
+ * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
+ */
+class MemcachedCaster
+{
+    private static $optionConstants;
+    private static $defaultOptions;
+
+    public static function castMemcached(\Memcached $c, array $a, Stub $stub, $isNested)
+    {
+        $a += array(
+            Caster::PREFIX_VIRTUAL.'servers' => $c->getServerList(),
+            Caster::PREFIX_VIRTUAL.'options' => new EnumStub(
+                self::getNonDefaultOptions($c)
+            ),
+        );
+
+        return $a;
+    }
+
+    private static function getNonDefaultOptions(\Memcached $c)
+    {
+        self::$defaultOptions = self::$defaultOptions ?? self::discoverDefaultOptions();
+        self::$optionConstants = self::$optionConstants ?? self::getOptionConstants();
+
+        $nonDefaultOptions = array();
+        foreach (self::$optionConstants as $constantKey => $value) {
+            if (self::$defaultOptions[$constantKey] !== $option = $c->getOption($value)) {
+                $nonDefaultOptions[$constantKey] = $option;
+            }
+        }
+
+        return $nonDefaultOptions;
+    }
+
+    private static function discoverDefaultOptions()
+    {
+        $defaultMemcached = new \Memcached();
+        $defaultMemcached->addServer('127.0.0.1', 11211);
+
+        $defaultOptions = array();
+        self::$optionConstants = self::$optionConstants ?? self::getOptionConstants();
+
+        foreach (self::$optionConstants as $constantKey => $value) {
+            $defaultOptions[$constantKey] = $defaultMemcached->getOption($value);
+        }
+
+        return $defaultOptions;
+    }
+
+    private static function getOptionConstants()
+    {
+        $reflectedMemcached = new \ReflectionClass(\Memcached::class);
+
+        $optionConstants = array();
+        foreach ($reflectedMemcached->getConstants() as $constantKey => $value) {
+            if (0 === strpos($constantKey, 'OPT_')) {
+                $optionConstants[$constantKey] = $value;
+            }
+        }
+
+        return $optionConstants;
+    }
+}

src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php

@@ -123,6 +123,8 @@ abstract class AbstractCloner implements ClonerInterface
         'IntlCalendar' => array('Symfony\Component\VarDumper\Caster\IntlCaster', 'castIntlCalendar'),
         'IntlDateFormatter' => array('Symfony\Component\VarDumper\Caster\IntlCaster', 'castIntlDateFormatter'),
 
+        'Memcached' => array('Symfony\Component\VarDumper\Caster\MemcachedCaster', 'castMemcached'),
+
         ':curl' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castCurl'),
         ':dba' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'),
         ':dba persistent' => array('Symfony\Component\VarDumper\Caster\ResourceCaster', 'castDba'),

src/Symfony/Component/VarDumper/Tests/Caster/MemcachedCasterTest.php

@@ -0,0 +1,93 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Tests\Caster;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\VarDumper\Test\VarDumperTestTrait;
+
+/**
+ * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
+ */
+class MemcachedCasterTest extends TestCase
+{
+    use VarDumperTestTrait;
+
+    public function testCastMemcachedWithDefaultOptions()
+    {
+        if (!class_exists('Memcached')) {
+            $this->markTestSkipped('Memcached not available');
+        }
+
+        $var = new \Memcached();
+        $var->addServer('127.0.0.1', 11211);
+        $var->addServer('127.0.0.2', 11212);
+
+        $expected = <<<EOTXT
+Memcached {
+  servers: array:2 [
+    0 => array:3 [
+      "host" => "127.0.0.1"
+      "port" => 11211
+      "type" => "TCP"
+    ]
+    1 => array:3 [
+      "host" => "127.0.0.2"
+      "port" => 11212
+      "type" => "TCP"
+    ]
+  ]
+  options: {}
+}
+EOTXT;
+        $this->assertDumpEquals($expected, $var);
+    }
+
+    public function testCastMemcachedWithCustomOptions()
+    {
+        if (!class_exists('Memcached')) {
+            $this->markTestSkipped('Memcached not available');
+        }
+
+        $var = new \Memcached();
+        $var->addServer('127.0.0.1', 11211);
+        $var->addServer('127.0.0.2', 11212);
+
+        // set a subset of non default options to test boolean, string and integer output
+        $var->setOption(\Memcached::OPT_COMPRESSION, false);
+        $var->setOption(\Memcached::OPT_PREFIX_KEY, 'pre');
+        $var->setOption(\Memcached::OPT_DISTRIBUTION, \Memcached::DISTRIBUTION_CONSISTENT);
+
+        $expected = <<<'EOTXT'
+Memcached {
+  servers: array:2 [
+    0 => array:3 [
+      "host" => "127.0.0.1"
+      "port" => 11211
+      "type" => "TCP"
+    ]
+    1 => array:3 [
+      "host" => "127.0.0.2"
+      "port" => 11212
+      "type" => "TCP"
+    ]
+  ]
+  options: {
+    OPT_COMPRESSION: false
+    OPT_PREFIX_KEY: "pre"
+    OPT_DISTRIBUTION: 1
+  }
+}
+EOTXT;
+
+        $this->assertDumpEquals($expected, $var);
+    }
+}