private function YamlFileLoader::parseDefinition in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php \Drupal\Core\DependencyInjection\YamlFileLoader::parseDefinition()

Parses a definition.

Parameters

string $id:

array $service:

string $file:

Throws

InvalidArgumentException When tags are invalid.

1 call to YamlFileLoader::parseDefinition()

YamlFileLoader::parseDefinitions in core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php

Parses definitions

File

core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php, line 142

Class

YamlFileLoader

YamlFileLoader loads YAML files service definitions.

Namespace

Drupal\Core\DependencyInjection

Code

private function parseDefinition($id, $service, $file) {
  if (is_string($service) && 0 === strpos($service, '@')) {
    $this->container
      ->setAlias($id, substr($service, 1));
    return;
  }
  if (null === $service) {
    $service = [];
  }
  if (!is_array($service)) {
    throw new InvalidArgumentException(sprintf('A service definition must be an array or a string starting with "@" but %s found for service "%s" in %s. Check your YAML syntax.', gettype($service), $id, $file));
  }
  if (isset($service['alias'])) {
    $alias = $this->container
      ->setAlias($id, new Alias($service['alias']));
    if (array_key_exists('public', $service)) {
      $alias
        ->setPublic($service['public']);
    }
    if (array_key_exists('deprecated', $service)) {
      if (method_exists($alias, 'getDeprecation')) {
        $deprecation = \is_array($service['deprecated']) ? $service['deprecated'] : [
          'message' => $service['deprecated'],
        ];
        $alias
          ->setDeprecated($deprecation['package'] ?? '', $deprecation['version'] ?? '', $deprecation['message']);
      }
      else {

        // @todo Remove when we no longer support Symfony 4 in
        // https://www.drupal.org/project/drupal/issues/3197729
        $alias
          ->setDeprecated(true, $service['deprecated']);
      }
    }
    return;
  }
  if (isset($service['parent'])) {
    $definition = new ChildDefinition($service['parent']);
  }
  else {
    $definition = new Definition();
  }
  if (isset($service['class'])) {
    $definition
      ->setClass($service['class']);
  }
  if (isset($service['shared'])) {
    $definition
      ->setShared($service['shared']);
  }
  if (isset($service['synthetic'])) {
    $definition
      ->setSynthetic($service['synthetic']);
  }
  if (isset($service['lazy'])) {
    $definition
      ->setLazy($service['lazy']);
  }
  if (isset($service['public'])) {
    $definition
      ->setPublic($service['public']);
  }
  else {
    $definition
      ->setPublic(true);
  }
  if (isset($service['abstract'])) {
    $definition
      ->setAbstract($service['abstract']);
  }
  if (array_key_exists('deprecated', $service)) {
    if (method_exists($definition, 'getDeprecation')) {
      $deprecation = \is_array($service['deprecated']) ? $service['deprecated'] : [
        'message' => $service['deprecated'],
      ];
      $definition
        ->setDeprecated($deprecation['package'] ?? '', $deprecation['version'] ?? '', $deprecation['message']);
    }
    else {

      // @todo Remove when we no longer support Symfony 4 in
      // https://www.drupal.org/project/drupal/issues/3197729
      $definition
        ->setDeprecated(true, $service['deprecated']);
    }
  }
  if (isset($service['factory'])) {
    if (is_string($service['factory'])) {
      if (strpos($service['factory'], ':') !== false && strpos($service['factory'], '::') === false) {
        $parts = explode(':', $service['factory']);
        $definition
          ->setFactory(array(
          $this
            ->resolveServices('@' . $parts[0]),
          $parts[1],
        ));
      }
      else {
        $definition
          ->setFactory($service['factory']);
      }
    }
    else {
      $definition
        ->setFactory(array(
        $this
          ->resolveServices($service['factory'][0]),
        $service['factory'][1],
      ));
    }
  }
  if (isset($service['factory_class'])) {
    $definition
      ->setFactory($service['factory_class']);
  }
  if (isset($service['factory_method'])) {
    $definition
      ->setFactory($service['factory_method']);
  }
  if (isset($service['factory_service'])) {
    $definition
      ->setFactory($service['factory_service']);
  }
  if (isset($service['file'])) {
    $definition
      ->setFile($service['file']);
  }
  if (isset($service['arguments'])) {
    $definition
      ->setArguments($this
      ->resolveServices($service['arguments']));
  }
  if (isset($service['properties'])) {
    $definition
      ->setProperties($this
      ->resolveServices($service['properties']));
  }
  if (isset($service['configurator'])) {
    if (is_string($service['configurator'])) {
      $definition
        ->setConfigurator($service['configurator']);
    }
    else {
      $definition
        ->setConfigurator(array(
        $this
          ->resolveServices($service['configurator'][0]),
        $service['configurator'][1],
      ));
    }
  }
  if (isset($service['calls'])) {
    if (!is_array($service['calls'])) {
      throw new InvalidArgumentException(sprintf('Parameter "calls" must be an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
    }
    foreach ($service['calls'] as $call) {
      if (isset($call['method'])) {
        $method = $call['method'];
        $args = isset($call['arguments']) ? $this
          ->resolveServices($call['arguments']) : array();
      }
      else {
        $method = $call[0];
        $args = isset($call[1]) ? $this
          ->resolveServices($call[1]) : array();
      }
      $definition
        ->addMethodCall($method, $args);
    }
  }
  if (isset($service['tags'])) {
    if (!is_array($service['tags'])) {
      throw new InvalidArgumentException(sprintf('Parameter "tags" must be an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
    }
    foreach ($service['tags'] as $tag) {
      if (!is_array($tag)) {
        throw new InvalidArgumentException(sprintf('A "tags" entry must be an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
      }
      if (!isset($tag['name'])) {
        throw new InvalidArgumentException(sprintf('A "tags" entry is missing a "name" key for service "%s" in %s.', $id, $file));
      }
      $name = $tag['name'];
      unset($tag['name']);
      foreach ($tag as $attribute => $value) {
        if (!is_scalar($value) && null !== $value) {
          throw new InvalidArgumentException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s", attribute "%s" in %s. Check your YAML syntax.', $id, $name, $attribute, $file));
        }
      }
      $definition
        ->addTag($name, $tag);
    }
  }
  if (isset($service['decorates'])) {
    $renameId = isset($service['decoration_inner_name']) ? $service['decoration_inner_name'] : null;
    $priority = isset($service['decoration_priority']) ? $service['decoration_priority'] : 0;
    $definition
      ->setDecoratedService($service['decorates'], $renameId, $priority);
  }
  if (isset($service['autowire'])) {
    $definition
      ->setAutowired($service['autowire']);
  }
  $this->container
    ->setDefinition($id, $definition);
}