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

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