vendor/shopware/core/Framework/Struct/ExtendableTrait.php line 24

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Struct;
  5. use Shopware\Core\Framework\Feature;
  6. use Shopware\Core\Framework\Log\Package;
  8. #[Package('core')]
  9. trait ExtendableTrait
  10. {
  11.     /**
  12.      * Contains an array of extension structs.
  13.      *
  14.      * @var Struct[]
  15.      */
  16.     protected $extensions = [];
  18.     /**
  19.      * Adds a new extension struct into the class storage.
  20.      * The passed name is used as unique identifier and has to be stored too.
  21.      *
  22.      * @deprecated tag:v6.5.0 - second param $extension will not allow null anymore
  23.      */
  24.     public function addExtension(string $name, ?Struct $extension): void
  25.     {
  26.         if ($extension === null) {
  27.             Feature::triggerDeprecationOrThrow(
  28.                 'v6.5.0.0',
  29.                 'Second parameter `$extension` of method `addExtension()` in `ExtendableTrait` will no accept null anymore in v6.5.0.0.'
  30.             );
  32.             return;
  33.         }
  35.         $this->extensions[$name] = $extension;
  36.     }
  38.     /**
  39.      * Adds a new array struct as extension into the class storage.
  40.      * The passed name is used as unique identifier and has to be stored too.
  41.      */
  42.     public function addArrayExtension(string $name, array $extension): void
  43.     {
  44.         $this->extensions[$name] = new ArrayStruct($extension);
  45.     }
  47.     /**
  48.      * @param Struct[] $extensions
  49.      */
  50.     public function addExtensions(array $extensions): void
  51.     {
  52.         foreach ($extensions as $key => $extension) {
  53.             $this->addExtension($key, $extension);
  54.         }
  55.     }
  57.     /**
  58.      * Returns a single extension struct element of this class.
  59.      * The passed name is used as unique identifier.
  60.      */
  61.     public function getExtension(string $name): ?Struct
  62.     {
  63.         return $this->extensions[$name] ?? null;
  64.     }
  66.     public function getExtensionOfType(string $name, string $type): ?Struct
  67.     {
  68.         if ($this->hasExtensionOfType($name, $type)) {
  69.             return $this->getExtension($name);
  70.         }
  72.         return null;
  73.     }
  75.     /**
  76.      * Helper function which checks if an associated
  77.      * extension exists.
  78.      */
  79.     public function hasExtension(string $name): bool
  80.     {
  81.         return isset($this->extensions[$name]);
  82.     }
  84.     public function hasExtensionOfType(string $name, string $type): bool
  85.     {
  86.         return $this->hasExtension($name) && \get_class($this->getExtension($name)) === $type;
  87.     }
  89.     /**
  90.      * Returns all stored extension structures of this class.
  91.      * The array has to be an associated array with name and extension instance.
  92.      *
  93.      * @return Struct[]
  94.      */
  95.     public function getExtensions(): array
  96.     {
  97.         return $this->extensions;
  98.     }
  100.     public function setExtensions(array $extensions): void
  101.     {
  102.         $this->extensions = $extensions;
  103.     }
  105.     public function removeExtension(string $name): void
  106.     {
  107.         if (isset($this->extensions[$name])) {
  108.             unset($this->extensions[$name]);
  109.         }
  110.     }
  111. }