vendor/gedmo/doctrine-extensions/src/Mapping/Driver/Chain.php line 78

  1. <?php
  3. /*
  4.  * This file is part of the Doctrine Behavioral Extensions package.
  5.  * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
  6.  * For the full copyright and license information, please view the LICENSE
  7.  * file that was distributed with this source code.
  8.  */
  10. namespace Gedmo\Mapping\Driver;
  12. use Gedmo\Mapping\Driver;
  14. /**
  15.  * The chain mapping driver enables chained
  16.  * extension mapping driver support
  17.  *
  18.  * @author Gediminas Morkevicius <gediminas.morkevicius@gmail.com>
  19.  *
  20.  * @final since gedmo/doctrine-extensions 3.11
  21.  */
  22. class Chain implements Driver
  23. {
  24.     /**
  25.      * The default driver
  26.      */
  27.     private ?Driver $defaultDriver = null;
  29.     /**
  30.      * List of drivers nested
  31.      *
  32.      * @var array<string, Driver>
  33.      */
  34.     private array $_drivers = [];
  36.     /**
  37.      * Add a nested driver.
  38.      *
  39.      * @param string $namespace
  40.      *
  41.      * @return void
  42.      */
  43.     public function addDriver(Driver $nestedDriver, $namespace)
  44.     {
  45.         $this->_drivers[$namespace] = $nestedDriver;
  46.     }
  48.     /**
  49.      * Get the array of nested drivers.
  50.      *
  51.      * @return array<string, Driver>
  52.      */
  53.     public function getDrivers()
  54.     {
  55.         return $this->_drivers;
  56.     }
  58.     /**
  59.      * Get the default driver.
  60.      *
  61.      * @return Driver|null
  62.      */
  63.     public function getDefaultDriver()
  64.     {
  65.         return $this->defaultDriver;
  66.     }
  68.     /**
  69.      * Set the default driver.
  70.      *
  71.      * @return void
  72.      */
  73.     public function setDefaultDriver(Driver $driver)
  74.     {
  75.         $this->defaultDriver = $driver;
  76.     }
  78.     public function readExtendedMetadata($meta, array &$config)
  79.     {
  80.         foreach ($this->_drivers as $namespace => $driver) {
  81.             if (0 === strpos($meta->getName(), $namespace)) {
  82.                 $extendedMetadata = $driver->readExtendedMetadata($meta, $config);
  84.                 if (\is_array($extendedMetadata)) {
  85.                     $config = $extendedMetadata;
  86.                 }
  88.                 // @todo: In the next major release remove the assignment to `$extendedMetadata`, the previous conditional
  89.                 // block, uncomment the following line and replace the following return statement.
  90.                 // return $driver->readExtendedMetadata($meta, $config);
  91.                 return $config;
  92.             }
  93.         }
  95.         if (null !== $this->defaultDriver) {
  96.             $extendedMetadata = $this->defaultDriver->readExtendedMetadata($meta, $config);
  98.             if (\is_array($extendedMetadata)) {
  99.                 $config = $extendedMetadata;
  100.             }
  102.             // @todo: In the next major release remove the assignment to `$extendedMetadata`, the previous conditional
  103.             // block, uncomment the following line and replace the following return statement.
  104.             // return $this->defaultDriver->readExtendedMetadata($meta, $config);
  105.             return $config;
  106.         }
  108.         // commenting it for customized mapping support, debugging of such cases might get harder
  109.         // throw new \Gedmo\Exception\UnexpectedValueException('Class ' . $meta->getName() . ' is not a valid entity or mapped super class.');
  110.     }
  112.     /**
  113.      * Passes in the mapping read by original driver
  114.      */
  115.     public function setOriginalDriver($driver)
  116.     {
  117.         // not needed here
  118.     }
  119. }