vendor/symfony/dependency-injection/Argument/TaggedIteratorArgument.php line 36

  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\DependencyInjection\Argument;
  14. /**
  15.  * Represents a collection of services found by tag name to lazily iterate over.
  16.  *
  17.  * @author Roland Franssen <franssen.roland@gmail.com>
  18.  */
  19. class TaggedIteratorArgument extends IteratorArgument
  20. {
  21.     private string $tag;
  22.     private mixed $indexAttribute;
  23.     private ?string $defaultIndexMethod;
  24.     private ?string $defaultPriorityMethod;
  25.     private bool $needsIndexes;
  26.     private array $exclude;
  28.     /**
  29.      * @param string      $tag                   The name of the tag identifying the target services
  30.      * @param string|null $indexAttribute        The name of the attribute that defines the key referencing each service in the tagged collection
  31.      * @param string|null $defaultIndexMethod    The static method that should be called to get each service's key when their tag doesn't define the previous attribute
  32.      * @param bool        $needsIndexes          Whether indexes are required and should be generated when computing the map
  33.      * @param string|null $defaultPriorityMethod The static method that should be called to get each service's priority when their tag doesn't define the "priority" attribute
  34.      * @param array       $exclude               Services to exclude from the iterator
  35.      */
  36.     public function __construct(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null, bool $needsIndexes = false, string $defaultPriorityMethod = null, array $exclude = [])
  37.     {
  38.         parent::__construct([]);
  40.         if (null === $indexAttribute && $needsIndexes) {
  41.             $indexAttribute = preg_match('/[^.]++$/', $tag, $m) ? $m[0] : $tag;
  42.         }
  44.         $this->tag = $tag;
  45.         $this->indexAttribute = $indexAttribute;
  46.         $this->defaultIndexMethod = $defaultIndexMethod ?: ($indexAttribute ? 'getDefault'.str_replace(' ', '', ucwords(preg_replace('/[^a-zA-Z0-9\x7f-\xff]++/', ' ', $indexAttribute))).'Name' : null);
  47.         $this->needsIndexes = $needsIndexes;
  48.         $this->defaultPriorityMethod = $defaultPriorityMethod ?: ($indexAttribute ? 'getDefault'.str_replace(' ', '', ucwords(preg_replace('/[^a-zA-Z0-9\x7f-\xff]++/', ' ', $indexAttribute))).'Priority' : null);
  49.         $this->exclude = $exclude;
  50.     }
  52.     public function getTag()
  53.     {
  54.         return $this->tag;
  55.     }
  57.     public function getIndexAttribute(): ?string
  58.     {
  59.         return $this->indexAttribute;
  60.     }
  62.     public function getDefaultIndexMethod(): ?string
  63.     {
  64.         return $this->defaultIndexMethod;
  65.     }
  67.     public function needsIndexes(): bool
  68.     {
  69.         return $this->needsIndexes;
  70.     }
  72.     public function getDefaultPriorityMethod(): ?string
  73.     {
  74.         return $this->defaultPriorityMethod;
  75.     }
  77.     public function getExclude(): array
  78.     {
  79.         return $this->exclude;
  80.     }
  81. }