private function YamlFileLoader::parseDefinition

private YamlFileLoader::parseDefinition($id, $service, $file)

Parses a definition.

Parameters

string $id:

array $service:

string $file:

Throws

InvalidArgumentException When tags are invalid.

File

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

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 (!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'])) {
    $public = !array_key_exists('public', $service) || (bool) $service['public'];
    $this->container->setAlias($id, new Alias($service['alias'], $public));

    return;
  }

  if (isset($service['parent'])) {
    $definition = new DefinitionDecorator($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['scope'])) {
    if ('request' !== $id) {
      @trigger_error(sprintf('The "scope" key of service "%s" in file "%s" is deprecated since version 2.8 and will be removed in 3.0.', $id, $file), E_USER_DEPRECATED);
    }
    $definition->setScope($service['scope'], false);
  }

  if (isset($service['synthetic'])) {
    $definition->setSynthetic($service['synthetic']);
  }

  if (isset($service['synchronized'])) {
    $definition->setSynchronized($service['synchronized'], 'request' !== $id);
  }

  if (isset($service['lazy'])) {
    $definition->setLazy($service['lazy']);
  }

  if (isset($service['public'])) {
    $definition->setPublic($service['public']);
  }

  if (isset($service['abstract'])) {
    $definition->setAbstract($service['abstract']);
  }

  if (array_key_exists('deprecated', $service)) {
    $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->setFactoryClass($service['factory_class']);
  }

  if (isset($service['factory_method'])) {
    $definition->setFactoryMethod($service['factory_method']);
  }

  if (isset($service['factory_service'])) {
    $definition->setFactoryService($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']);
  }

  if (isset($service['autowiring_types'])) {
    if (is_string($service['autowiring_types'])) {
      $definition->addAutowiringType($service['autowiring_types']);
    }
    else {
      if (!is_array($service['autowiring_types'])) {
        throw new InvalidArgumentException(sprintf('Parameter "autowiring_types" must be a string or an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
      }

      foreach ($service['autowiring_types'] as $autowiringType) {
        if (!is_string($autowiringType)) {
          throw new InvalidArgumentException(sprintf('A "autowiring_types" attribute must be of type string for service "%s" in %s. Check your YAML syntax.', $id, $file));
        }

        $definition->addAutowiringType($autowiringType);
      }
    }
  }

  $this->container->setDefinition($id, $definition);
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!DependencyInjection!YamlFileLoader.php/function/YamlFileLoader::parseDefinition/8.1.x