123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225 |
- <?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\DependencyInjection\Loader;
- use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;
- use Symfony\Component\Config\Exception\LoaderLoadException;
- use Symfony\Component\Config\FileLocatorInterface;
- use Symfony\Component\Config\Loader\FileLoader as BaseFileLoader;
- use Symfony\Component\Config\Loader\Loader;
- use Symfony\Component\Config\Resource\GlobResource;
- use Symfony\Component\DependencyInjection\ChildDefinition;
- use Symfony\Component\DependencyInjection\ContainerBuilder;
- use Symfony\Component\DependencyInjection\Definition;
- use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
- /**
- * FileLoader is the abstract class used by all built-in loaders that are file based.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- abstract class FileLoader extends BaseFileLoader
- {
- public const ANONYMOUS_ID_REGEXP = '/^\.\d+_[^~]*+~[._a-zA-Z\d]{7}$/';
- protected $container;
- protected $isLoadingInstanceof = false;
- protected $instanceof = [];
- protected $interfaces = [];
- protected $singlyImplemented = [];
- protected $autoRegisterAliasesForSinglyImplementedInterfaces = true;
- public function __construct(ContainerBuilder $container, FileLocatorInterface $locator)
- {
- $this->container = $container;
- parent::__construct($locator);
- }
- /**
- * {@inheritdoc}
- *
- * @param bool|string $ignoreErrors Whether errors should be ignored; pass "not_found" to ignore only when the loaded resource is not found
- */
- public function import($resource, $type = null, $ignoreErrors = false, $sourceResource = null, $exclude = null)
- {
- $args = \func_get_args();
- if ($ignoreNotFound = 'not_found' === $ignoreErrors) {
- $args[2] = false;
- } elseif (!\is_bool($ignoreErrors)) {
- throw new \TypeError(sprintf('Invalid argument $ignoreErrors provided to "%s::import()": boolean or "not_found" expected, "%s" given.', static::class, get_debug_type($ignoreErrors)));
- }
- try {
- parent::import(...$args);
- } catch (LoaderLoadException $e) {
- if (!$ignoreNotFound || !($prev = $e->getPrevious()) instanceof FileLocatorFileNotFoundException) {
- throw $e;
- }
- foreach ($prev->getTrace() as $frame) {
- if ('import' === ($frame['function'] ?? null) && is_a($frame['class'] ?? '', Loader::class, true)) {
- break;
- }
- }
- if (__FILE__ !== $frame['file']) {
- throw $e;
- }
- }
- }
- /**
- * Registers a set of classes as services using PSR-4 for discovery.
- *
- * @param Definition $prototype A definition to use as template
- * @param string $namespace The namespace prefix of classes in the scanned directory
- * @param string $resource The directory to look for classes, glob-patterns allowed
- * @param string|string[]|null $exclude A globbed path of files to exclude or an array of globbed paths of files to exclude
- */
- public function registerClasses(Definition $prototype, $namespace, $resource, $exclude = null)
- {
- if ('\\' !== substr($namespace, -1)) {
- throw new InvalidArgumentException(sprintf('Namespace prefix must end with a "\\": "%s".', $namespace));
- }
- if (!preg_match('/^(?:[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+\\\\)++$/', $namespace)) {
- throw new InvalidArgumentException(sprintf('Namespace is not a valid PSR-4 prefix: "%s".', $namespace));
- }
- $classes = $this->findClasses($namespace, $resource, (array) $exclude);
- // prepare for deep cloning
- $serializedPrototype = serialize($prototype);
- foreach ($classes as $class => $errorMessage) {
- if (interface_exists($class, false)) {
- $this->interfaces[] = $class;
- } else {
- $this->setDefinition($class, $definition = unserialize($serializedPrototype));
- if (null !== $errorMessage) {
- $definition->addError($errorMessage);
- continue;
- }
- foreach (class_implements($class, false) as $interface) {
- $this->singlyImplemented[$interface] = ($this->singlyImplemented[$interface] ?? $class) !== $class ? false : $class;
- }
- }
- }
- if ($this->autoRegisterAliasesForSinglyImplementedInterfaces) {
- $this->registerAliasesForSinglyImplementedInterfaces();
- }
- }
- public function registerAliasesForSinglyImplementedInterfaces()
- {
- foreach ($this->interfaces as $interface) {
- if (!empty($this->singlyImplemented[$interface]) && !$this->container->has($interface)) {
- $this->container->setAlias($interface, $this->singlyImplemented[$interface]);
- }
- }
- $this->interfaces = $this->singlyImplemented = [];
- }
- /**
- * Registers a definition in the container with its instanceof-conditionals.
- *
- * @param string $id
- */
- protected function setDefinition($id, Definition $definition)
- {
- $this->container->removeBindings($id);
- if ($this->isLoadingInstanceof) {
- if (!$definition instanceof ChildDefinition) {
- throw new InvalidArgumentException(sprintf('Invalid type definition "%s": ChildDefinition expected, "%s" given.', $id, get_debug_type($definition)));
- }
- $this->instanceof[$id] = $definition;
- } else {
- $this->container->setDefinition($id, $definition->setInstanceofConditionals($this->instanceof));
- }
- }
- private function findClasses(string $namespace, string $pattern, array $excludePatterns): array
- {
- $parameterBag = $this->container->getParameterBag();
- $excludePaths = [];
- $excludePrefix = null;
- $excludePatterns = $parameterBag->unescapeValue($parameterBag->resolveValue($excludePatterns));
- foreach ($excludePatterns as $excludePattern) {
- foreach ($this->glob($excludePattern, true, $resource, true, true) as $path => $info) {
- if (null === $excludePrefix) {
- $excludePrefix = $resource->getPrefix();
- }
- // normalize Windows slashes
- $excludePaths[str_replace('\\', '/', $path)] = true;
- }
- }
- $pattern = $parameterBag->unescapeValue($parameterBag->resolveValue($pattern));
- $classes = [];
- $extRegexp = '/\\.php$/';
- $prefixLen = null;
- foreach ($this->glob($pattern, true, $resource, false, false, $excludePaths) as $path => $info) {
- if (null === $prefixLen) {
- $prefixLen = \strlen($resource->getPrefix());
- if ($excludePrefix && 0 !== strpos($excludePrefix, $resource->getPrefix())) {
- throw new InvalidArgumentException(sprintf('Invalid "exclude" pattern when importing classes for "%s": make sure your "exclude" pattern (%s) is a subset of the "resource" pattern (%s).', $namespace, $excludePattern, $pattern));
- }
- }
- if (isset($excludePaths[str_replace('\\', '/', $path)])) {
- continue;
- }
- if (!preg_match($extRegexp, $path, $m) || !$info->isReadable()) {
- continue;
- }
- $class = $namespace.ltrim(str_replace('/', '\\', substr($path, $prefixLen, -\strlen($m[0]))), '\\');
- if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+(?:\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+)*+$/', $class)) {
- continue;
- }
- try {
- $r = $this->container->getReflectionClass($class);
- } catch (\ReflectionException $e) {
- $classes[$class] = $e->getMessage();
- continue;
- }
- // check to make sure the expected class exists
- if (!$r) {
- throw new InvalidArgumentException(sprintf('Expected to find class "%s" in file "%s" while importing services from resource "%s", but it was not found! Check the namespace prefix used with the resource.', $class, $path, $pattern));
- }
- if ($r->isInstantiable() || $r->isInterface()) {
- $classes[$class] = null;
- }
- }
- // track only for new & removed files
- if ($resource instanceof GlobResource) {
- $this->container->addResource($resource);
- } else {
- foreach ($resource as $path) {
- $this->container->fileExists($path, false);
- }
- }
- return $classes;
- }
- }
|