vendor/symfony/config/Builder/ClassBuilder.php line 122

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Config\Builder;
  14. /**
  15.  * Build PHP classes to generate config.
  16.  *
  17.  * @internal
  18.  *
  19.  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  20.  */
  21. class ClassBuilder
  22. {
  23.     private string $namespace;
  24.     private string $name;
  26.     /** @var Property[] */
  27.     private array $properties = [];
  29.     /** @var Method[] */
  30.     private array $methods = [];
  31.     private array $require = [];
  32.     private array $use = [];
  33.     private array $implements = [];
  34.     private bool $allowExtraKeys = false;
  36.     public function __construct(string $namespace, string $name)
  37.     {
  38.         $this->namespace = $namespace;
  39.         $this->name = ucfirst($this->camelCase($name)).'Config';
  40.     }
  42.     public function getDirectory(): string
  43.     {
  44.         return str_replace('\\', \DIRECTORY_SEPARATOR, $this->namespace);
  45.     }
  47.     public function getFilename(): string
  48.     {
  49.         return $this->name.'.php';
  50.     }
  52.     public function build(): string
  53.     {
  54.         $rootPath = explode(\DIRECTORY_SEPARATOR, $this->getDirectory());
  55.         $require = '';
  56.         foreach ($this->require as $class) {
  57.             // figure out relative path.
  58.             $path = explode(\DIRECTORY_SEPARATOR, $class->getDirectory());
  59.             $path[] = $class->getFilename();
  60.             foreach ($rootPath as $key => $value) {
  61.                 if ($path[$key] !== $value) {
  62.                     break;
  63.                 }
  64.                 unset($path[$key]);
  65.             }
  66.             $require .= sprintf('require_once __DIR__.\DIRECTORY_SEPARATOR.\'%s\';', implode('\'.\DIRECTORY_SEPARATOR.\'', $path))."\n";
  67.         }
  68.         $use = $require ? "\n" : '';
  69.         foreach (array_keys($this->use) as $statement) {
  70.             $use .= sprintf('use %s;', $statement)."\n";
  71.         }
  73.         $implements = [] === $this->implements ? '' : 'implements '.implode(', ', $this->implements);
  74.         $body = '';
  75.         foreach ($this->properties as $property) {
  76.             $body .= '    '.$property->getContent()."\n";
  77.         }
  78.         foreach ($this->methods as $method) {
  79.             $lines = explode("\n", $method->getContent());
  80.             foreach ($lines as $line) {
  81.                 $body .= ($line ? '    '.$line : '')."\n";
  82.             }
  83.         }
  85.         $content = strtr('<?php
  87. namespace NAMESPACE;
  89. REQUIREUSE
  90. /**
  91.  * This class is automatically generated to help in creating a config.
  92.  */
  93. class CLASS IMPLEMENTS
  94. {
  95. BODY
  96. }
  97. ', ['NAMESPACE' => $this->namespace, 'REQUIRE' => $require, 'USE' => $use, 'CLASS' => $this->getName(), 'IMPLEMENTS' => $implements, 'BODY' => $body]);
  99.         return $content;
  100.     }
  102.     public function addRequire(self $class): void
  103.     {
  104.         $this->require[] = $class;
  105.     }
  107.     public function addUse(string $class): void
  108.     {
  109.         $this->use[$class] = true;
  110.     }
  112.     public function addImplements(string $interface): void
  113.     {
  114.         $this->implements[] = '\\'.ltrim($interface, '\\');
  115.     }
  117.     public function addMethod(string $name, string $body, array $params = []): void
  118.     {
  119.         $this->methods[] = new Method(strtr($body, ['NAME' => $this->camelCase($name)] + $params));
  120.     }
  122.     public function addProperty(string $name, string $classType = null, string $defaultValue = null): Property
  123.     {
  124.         $property = new Property($name, '_' !== $name[0] ? $this->camelCase($name) : $name);
  125.         if (null !== $classType) {
  126.             $property->setType($classType);
  127.         }
  128.         $this->properties[] = $property;
  129.         $defaultValue = null !== $defaultValue ? sprintf(' = %s', $defaultValue) : '';
  130.         $property->setContent(sprintf('private $%s%s;', $property->getName(), $defaultValue));
  132.         return $property;
  133.     }
  135.     public function getProperties(): array
  136.     {
  137.         return $this->properties;
  138.     }
  140.     private function camelCase(string $input): string
  141.     {
  142.         $output = lcfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', $input))));
  144.         return preg_replace('#\W#', '', $output);
  145.     }
  147.     public function getName(): string
  148.     {
  149.         return $this->name;
  150.     }
  152.     public function getNamespace(): string
  153.     {
  154.         return $this->namespace;
  155.     }
  157.     public function getFqcn(): string
  158.     {
  159.         return '\\'.$this->namespace.'\\'.$this->name;
  160.     }
  162.     public function setAllowExtraKeys(bool $allowExtraKeys): void
  163.     {
  164.         $this->allowExtraKeys = $allowExtraKeys;
  165.     }
  167.     public function shouldAllowExtraKeys(): bool
  168.     {
  169.         return $this->allowExtraKeys;
  170.     }
  171. }