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

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