[Config][DependencyInjection] Add configuration builder for writing P…

…HP config
symfony · nicolas-grekas · Apr 13, 2021 · Mar 27, 2021 · Apr 13, 2021 · 460b46f7302ec7319b8334a43809523363bfef39
commit 460b46f7302ec7319b8334a43809523363bfef39
diff --git a/src/Symfony/Component/Config/Builder/ClassBuilder.php b/src/Symfony/Component/Config/Builder/ClassBuilder.php
@@ -0,0 +1,155 @@
+<?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\Config\Builder;
+
+/**
+ * Build PHP classes to generate config.
+ *
+ * @internal
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class ClassBuilder
+{
+    /** @var string */
+    private $namespace;
+
+    /** @var string */
+    private $name;
+
+    /** @var Property[] */
+    private $properties = [];
+
+    /** @var Method[] */
+    private $methods = [];
+    private $require = [];
+    private $implements = [];
+
+    public function __construct(string $namespace, string $name)
+    {
+        $this->namespace = $namespace;
+        $this->name = ucfirst($this->camelCase($name)).'Config';
+    }
+
+    public function getDirectory(): string
+    {
+        return str_replace('\\', \DIRECTORY_SEPARATOR, $this->namespace);
+    }
+
+    public function getFilename(): string
+    {
+        return $this->name.'.php';
+
+    public function build(): string
+    {
+        $rootPath = explode(\DIRECTORY_SEPARATOR, $this->getDirectory());
+        $require = '';
+        foreach ($this->require as $class) {
+            // figure out relative path.
+            $path = explode(\DIRECTORY_SEPARATOR, $class->getDirectory());
+            $path[] = $class->getFilename();
+            foreach ($rootPath as $key => $value) {
+                if ($path[$key] !== $value) {
+                    break;
+                }
+                unset($path[$key]);
+            }
+            $require .= sprintf('require_once __DIR__.\'%s\';', \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $path))."\n";
+        }
+
+        $implements = [] === $this->implements ? '' : 'implements '.implode(', ', $this->implements);
+        $body = '';
+        foreach ($this->properties as $property) {
+            $body .= '    '.$property->getContent()."\n";
+        }
+        foreach ($this->methods as $method) {
+            $lines = explode("\n", $method->getContent());
+            foreach ($lines as $i => $line) {
+                $body .= '    '.$line."\n";
+            }
+        }
+
+        $content = strtr('<?php
+
+namespace NAMESPACE;
+
+REQUIRE
+
+/**
+ * This class is automatically generated to help creating config.
+ *
+ * @experimental in 5.3
+ */
+class CLASS IMPLEMENTS
+{
+BODY
+}
+', ['NAMESPACE' => $this->namespace, 'REQUIRE' => $require, 'CLASS' => $this->getName(), 'IMPLEMENTS' => $implements, 'BODY' => $body]);
+
+        return $content;
+    }
+
+    public function addRequire(self $class)
+    {
+        $this->require[] = $class;
+    }
+
+    public function addImplements(string $interface)
+    {
+        $this->implements[] = '\\'.ltrim($interface, '\\');
+    }
+
+    public function addMethod(string $name, string $body, array $params = []): void
+    {
+        $this->methods[] = new Method(strtr($body, ['NAME' => $this->camelCase($name)] + $params));
+    }
+
+    public function addProperty(string $name, string $classType = null): Property
+    {
+        $property = new Property($name, $this->camelCase($name));
+        if (null !== $classType) {
+            $property->setType($classType);
+        }
+        $this->properties[] = $property;
+        $property->setContent(sprintf('private $%s;', $property->getName()));
+
+        return $property;
+    }
+
+    public function getProperties(): array
+    {
+        return $this->properties;
+    }
+
+    private function camelCase(string $input): string
+    {
+        $output = lcfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', $input))));
+
+        return preg_replace('#\W#', '', $output);
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getNamespace(): string
+    {
+        return $this->namespace;
+    }
+
+    public function getFqcn()
+    {
+        return '\\'.$this->namespace.'\\'.$this->name;
+    }
+}