From bfd7420c312ff3eee546d61ffef3509dbd76424f Mon Sep 17 00:00:00 2001
From: Nathaniel Catchpole <catch@35733.no-reply.drupal.org>
Date: Mon, 9 Jun 2014 12:24:32 +0100
Subject: [PATCH] Issue #2269385 by sun: Fixed DependencyInjection
YamlFileLoader is out of date.
---
.../DependencyInjection/YamlFileLoader.php | 485 ++++++++++--------
1 file changed, 268 insertions(+), 217 deletions(-)
diff --git a/core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php b/core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php
index 59b0494f5a0c..75282d289d3a 100644
--- a/core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php
+++ b/core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php
@@ -13,258 +13,309 @@
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\DefinitionDecorator;
use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
/**
* YamlFileLoader loads YAML files service definitions.
*
- * Drupal does not use Symfony's Config component, so this is a partial copy
- * of \Symfony\Component\DependencyInjection\Loader\YamlFileLoader class not
- * depending on the Config component.
+ * Drupal does not use Symfony's Config component, and Symfony's dependency on
+ * it cannot be removed easily. Therefore, this is a partial but mostly literal
+ * copy of upstream, which does not depend on the Config component.
+ *
+ * @see \Symfony\Component\DependencyInjection\Loader\YamlFileLoader
+ * @see https://github.com/symfony/symfony/pull/10920
+ *
+ * NOTE: 98% of this code is a literal copy of Symfony's YamlFileLoader.
+ *
+ * This file does NOT follow Drupal coding standards, so as to simplify future
+ * synchronizations.
*/
-class YamlFileLoader {
-
- /**
- * Statically cached yaml files.
- *
- * Especially during tests, yaml files are re-parsed often.
- *
- * @var array
- */
- static protected $yaml = array();
-
- /**
- * @param \Drupal\Core\DependencyInjection\ContainerBuilder $container
- */
- protected $container;
-
- public function __construct(ContainerBuilder $container) {
- $this->container = $container;
- }
-
- /**
- * Load a YAML file containing service definitions and kernel parameters.
- *
- * string $filename
- * The name of the file to load.
- */
- public function load($filename) {
- if (!isset(static::$yaml[$filename])) {
- static::$yaml[$filename] = $this->loadFile($filename);
- }
- $content = static::$yaml[$filename];
- $content += array('parameters' => array(), 'services' => array());
- // parameters
- foreach ($content['parameters'] as $key => $value) {
- $this->container->setParameter($key, $this->resolveServices($value));
- }
- // services
- foreach ($content['services'] as $id => $service) {
- $this->parseDefinition($id, $service, $filename);
- }
- }
-
- /**
- * Parses a definition.
- *
- * Copied from \Symfony\Component\DependencyInjection\Loader\YamlFileLoader::parseDefinition().
- *
- * @param string $id
- * The id of the service.
- * @param string|array $service
- * Either a string starting with a @ meaning this service is an alias or
- * the array defining the service.
- * @param string $filename
- * The name of the file, only used in error messages.
- *
- * @throws \InvalidArgumentException When tags are invalid
- */
- protected function parseDefinition($id, $service, $filename) {
- if (is_string($service) && 0 === strpos($service, '@')) {
- $this->container->setAlias($id, substr($service, 1));
- return;
- }
- elseif (isset($service['alias'])) {
- $public = !array_key_exists('public', $service) || (Boolean) $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();
+class YamlFileLoader
+{
+
+ /**
+ * Statically cached yaml files.
+ *
+ * Especially during tests, YAML files are re-parsed often.
+ *
+ * @var array
+ */
+ static protected $yaml = array();
+
+ /**
+ * @param \Drupal\Core\DependencyInjection\ContainerBuilder $container
+ */
+ protected $container;
+
+ public function __construct(ContainerBuilder $container)
+ {
+ $this->container = $container;
}
- if (isset($service['class'])) {
- $definition->setClass($service['class']);
- }
+ /**
+ * Loads a Yaml file.
+ *
+ * @param mixed $file The resource
+ */
+ public function load($file)
+ {
+ if (!isset(static::$yaml[$file])) {
+ static::$yaml[$file] = $this->loadFile($file);
+ }
+ $content = static::$yaml[$file];
- if (isset($service['scope'])) {
- $definition->setScope($service['scope']);
- }
+ // Not supported.
+ //$this->container->addResource(new FileResource($path));
- if (isset($service['synthetic'])) {
- $definition->setSynthetic($service['synthetic']);
- }
+ // empty file
+ if (null === $content) {
+ return;
+ }
- if (isset($service['synchronized'])) {
- $definition->setSynchronized($service['synchronized']);
- }
+ // imports
+ // Not supported.
+ //$this->parseImports($content, $file);
- if (isset($service['public'])) {
- $definition->setPublic($service['public']);
- }
+ // parameters
+ if (isset($content['parameters'])) {
+ foreach ($content['parameters'] as $key => $value) {
+ $this->container->setParameter($key, $this->resolveServices($value));
+ }
+ }
- if (isset($service['abstract'])) {
- $definition->setAbstract($service['abstract']);
- }
+ // extensions
+ // Not supported.
+ //$this->loadFromExtensions($content);
- if (isset($service['factory_class'])) {
- $definition->setFactoryClass($service['factory_class']);
+ // services
+ $this->parseDefinitions($content, $file);
}
- if (isset($service['factory_method'])) {
- $definition->setFactoryMethod($service['factory_method']);
- }
+ /**
+ * Parses definitions
+ *
+ * @param array $content
+ * @param string $file
+ */
+ private function parseDefinitions($content, $file)
+ {
+ if (!isset($content['services'])) {
+ return;
+ }
- if (isset($service['factory_service'])) {
- $definition->setFactoryService($service['factory_service']);
+ foreach ($content['services'] as $id => $service) {
+ $this->parseDefinition($id, $service, $file);
+ }
}
- if (isset($service['file'])) {
- $definition->setFile($service['file']);
- }
+ /**
+ * Parses a definition.
+ *
+ * @param string $id
+ * @param array $service
+ * @param string $file
+ *
+ * @throws InvalidArgumentException When tags are invalid
+ */
+ private function parseDefinition($id, $service, $file)
+ {
+ if (is_string($service) && 0 === strpos($service, '@')) {
+ $this->container->setAlias($id, substr($service, 1));
+
+ return;
+ } elseif (isset($service['alias'])) {
+ $public = !array_key_exists('public', $service) || (Boolean) $service['public'];
+ $this->container->setAlias($id, new Alias($service['alias'], $public));
+
+ return;
+ }
- if (isset($service['arguments'])) {
- $definition->setArguments($this->resolveServices($service['arguments']));
- }
+ if (isset($service['parent'])) {
+ $definition = new DefinitionDecorator($service['parent']);
+ } else {
+ $definition = new Definition();
+ }
- if (isset($service['properties'])) {
- $definition->setProperties($this->resolveServices($service['properties']));
- }
+ if (isset($service['class'])) {
+ $definition->setClass($service['class']);
+ }
- 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['scope'])) {
+ $definition->setScope($service['scope']);
+ }
- if (isset($service['calls'])) {
- foreach ($service['calls'] as $call) {
- $args = isset($call[1]) ? $this->resolveServices($call[1]) : array();
- $definition->addMethodCall($call[0], $args);
- }
- }
+ if (isset($service['synthetic'])) {
+ $definition->setSynthetic($service['synthetic']);
+ }
- if (isset($service['tags'])) {
- if (!is_array($service['tags'])) {
- throw new \InvalidArgumentException(sprintf('Parameter "tags" must be an array for service "%s" in %s.', $id, $filename));
- }
+ if (isset($service['synchronized'])) {
+ $definition->setSynchronized($service['synchronized']);
+ }
- foreach ($service['tags'] as $tag) {
- if (!isset($tag['name'])) {
- throw new \InvalidArgumentException(sprintf('A "tags" entry is missing a "name" key for service "%s" in %s.', $id, $filename));
+ if (isset($service['lazy'])) {
+ $definition->setLazy($service['lazy']);
}
- $name = $tag['name'];
- unset($tag['name']);
+ if (isset($service['public'])) {
+ $definition->setPublic($service['public']);
+ }
- foreach ($tag as $value) {
- if (!is_scalar($value)) {
- throw new \InvalidArgumentException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s" in %s.', $id, $name, $filename));
- }
+ if (isset($service['abstract'])) {
+ $definition->setAbstract($service['abstract']);
}
- $definition->addTag($name, $tag);
- }
- }
+ if (isset($service['factory_class'])) {
+ $definition->setFactoryClass($service['factory_class']);
+ }
- $this->container->setDefinition($id, $definition);
- }
-
- /**
- * Loads a YAML file.
- *
- * @param string $filename
- *
- * @return array
- * The file content.
- */
- protected function loadFile($filename) {
- return $this->validate(Yaml::decode(file_get_contents($filename)), $filename);
- }
-
- /**
- * Validates a YAML file.
- *
- * @param mixed $content
- * The parsed YAML file.
- * @param string $filename
- * The name of the file, only used for error messages.
- *
- * @return array
- * The $content unchanged returned to allow for chaining this method.
- *
- * @throws \InvalidArgumentException When service file is not valid
- */
- protected function validate($content, $filename) {
- if (NULL === $content) {
- return $content;
- }
+ if (isset($service['factory_method'])) {
+ $definition->setFactoryMethod($service['factory_method']);
+ }
- if (!is_array($content)) {
- throw new \InvalidArgumentException(sprintf('The service file "%s" is not valid: it is not an array.', $filename));
- }
- if ($keys = array_diff_key($content, array('parameters' => TRUE, 'services' => TRUE))) {
- $invalid_keys = htmlspecialchars(implode(', ', $keys), ENT_QUOTES, 'UTF-8');
- throw new \InvalidArgumentException(sprintf('The service file "%s" is not valid: it contains invalid keys %s. Services have to be added under "services" and Parameters under "parameters".', $filename, $invalid_keys));
+ 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'])) {
+ foreach ($service['calls'] as $call) {
+ $args = isset($call[1]) ? $this->resolveServices($call[1]) : array();
+ $definition->addMethodCall($call[0], $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.', $id, $file));
+ }
+
+ foreach ($service['tags'] as $tag) {
+ 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.', $id, $name, $attribute, $file));
+ }
+ }
+
+ $definition->addTag($name, $tag);
+ }
+ }
+
+ $this->container->setDefinition($id, $definition);
}
- return $content;
- }
-
- /**
- * Resolves services.
- *
- * Copied from \Symfony\Component\DependencyInjection\Loader\YamlFileLoader::parseDefinition().
- *
- * @param mixed $value
- * If a string, then it is either a plain string (for example a class
- * name) or a reference to a service. If it's an array then it's a list of
- * such strings.
- *
- * @return string|\Symfony\Component\DependencyInjection\Reference
- * Either the string unchanged or the Reference object.
- */
- protected function resolveServices($value) {
- if (is_array($value)) {
- $value = array_map(array($this, 'resolveServices'), $value);
+ /**
+ * Loads a YAML file.
+ *
+ * @param string $file
+ *
+ * @return array The file content
+ */
+ protected function loadFile($file)
+ {
+ if (!stream_is_local($file)) {
+ throw new InvalidArgumentException(sprintf('This is not a local file "%s".', $file));
+ }
+
+ if (!file_exists($file)) {
+ throw new InvalidArgumentException(sprintf('The service file "%s" is not valid.', $file));
+ }
+
+ return $this->validate(Yaml::decode(file_get_contents($file)), $file);
}
- elseif (is_string($value) && 0 === strpos($value, '@')) {
- if (0 === strpos($value, '@?')) {
- $value = substr($value, 2);
- $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
- }
- else {
- $value = substr($value, 1);
- $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
- }
-
- if ('=' === substr($value, -1)) {
- $value = substr($value, 0, -1);
- $strict = FALSE;
- }
- else {
- $strict = TRUE;
- }
-
- $value = new Reference($value, $invalidBehavior, $strict);
+
+ /**
+ * Validates a YAML file.
+ *
+ * @param mixed $content
+ * @param string $file
+ *
+ * @return array
+ *
+ * @throws InvalidArgumentException When service file is not valid
+ */
+ private function validate($content, $file)
+ {
+ if (null === $content) {
+ return $content;
+ }
+
+ if (!is_array($content)) {
+ throw new InvalidArgumentException(sprintf('The service file "%s" is not valid: it is not an array.', $file));
+ }
+
+ if ($invalid_keys = array_diff_key($content, array('parameters' => 1, 'services' => 1))) {
+ throw new InvalidArgumentException(sprintf('The service file "%s" is not valid: it contains invalid keys %s. Services have to be added under "services" and Parameters under "parameters".', $file, $invalid_keys));
+ }
+
+ return $content;
}
- return $value;
- }
+ /**
+ * Resolves services.
+ *
+ * @param string $value
+ *
+ * @return Reference
+ */
+ private function resolveServices($value)
+ {
+ if (is_array($value)) {
+ $value = array_map(array($this, 'resolveServices'), $value);
+ } elseif (is_string($value) && 0 === strpos($value, '@=')) {
+ // Not supported.
+ //return new Expression(substr($value, 2));
+ throw new InvalidArgumentException(sprintf("'%s' is an Expression, but expressions are not supported.", $value));
+ } elseif (is_string($value) && 0 === strpos($value, '@')) {
+ if (0 === strpos($value, '@@')) {
+ $value = substr($value, 1);
+ $invalidBehavior = null;
+ } elseif (0 === strpos($value, '@?')) {
+ $value = substr($value, 2);
+ $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
+ } else {
+ $value = substr($value, 1);
+ $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
+ }
+
+ if ('=' === substr($value, -1)) {
+ $value = substr($value, 0, -1);
+ $strict = false;
+ } else {
+ $strict = true;
+ }
+
+ if (null !== $invalidBehavior) {
+ $value = new Reference($value, $invalidBehavior, $strict);
+ }
+ }
+
+ return $value;
+ }
}
--
GitLab