vendor/shopware/core/Content/Cms/CmsPageEntity.php line 14

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Cms;
  5. use Shopware\Core\Content\Category\CategoryCollection;
  6. use Shopware\Core\Content\Cms\Aggregate\CmsSection\CmsSectionCollection;
  7. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  8. use Shopware\Core\Content\Media\MediaEntity;
  9. use Shopware\Core\Content\Product\ProductCollection;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  11. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  12. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  14. class CmsPageEntity extends Entity
  15. {
  16.     use EntityIdTrait;
  18.     /**
  19.      * @var string|null
  20.      */
  21.     protected $name;
  23.     /**
  24.      * @var string
  25.      */
  26.     protected $type;
  28.     /**
  29.      * @var string|null
  30.      */
  31.     protected $entity;
  33.     /**
  34.      * @var CmsSectionCollection|null
  35.      */
  36.     protected $sections;
  38.     /**
  39.      * @var EntityCollection|null
  40.      */
  41.     protected $translations;
  43.     /**
  44.      * @var CategoryCollection|null
  45.      */
  46.     protected $categories;
  48.     /**
  49.      * @internal (flag:FEATURE_NEXT_10078)
  50.      *
  51.      * @var ProductCollection|null
  52.      */
  53.     protected $products;
  55.     /**
  56.      * @var array|null
  57.      */
  58.     protected $config;
  60.     /**
  61.      * @var string|null
  62.      */
  63.     protected $previewMediaId;
  65.     /**
  66.      * @var MediaEntity|null
  67.      */
  68.     protected $previewMedia;
  70.     /**
  71.      * @var array|null
  72.      */
  73.     protected $customFields;
  75.     /**
  76.      * @var bool
  77.      */
  78.     protected $locked;
  80.     public function getName(): string
  81.     {
  82.         return $this->name;
  83.     }
  85.     public function setName(string $name): void
  86.     {
  87.         $this->name = $name;
  88.     }
  90.     public function getType(): string
  91.     {
  92.         return $this->type;
  93.     }
  95.     public function setType(string $type): void
  96.     {
  97.         $this->type = $type;
  98.     }
  100.     public function getEntity(): ?string
  101.     {
  102.         return $this->entity;
  103.     }
  105.     public function setEntity(?string $entity): void
  106.     {
  107.         $this->entity = $entity;
  108.     }
  110.     public function getSections(): ?CmsSectionCollection
  111.     {
  112.         return $this->sections;
  113.     }
  115.     public function setSections(CmsSectionCollection $sections): void
  116.     {
  117.         $this->sections = $sections;
  118.     }
  120.     public function getTranslations(): ?EntityCollection
  121.     {
  122.         return $this->translations;
  123.     }
  125.     public function setTranslations(EntityCollection $translations): void
  126.     {
  127.         $this->translations = $translations;
  128.     }
  130.     public function getCustomFields(): ?array
  131.     {
  132.         return $this->customFields;
  133.     }
  135.     public function setCustomFields(?array $customFields): void
  136.     {
  137.         $this->customFields = $customFields;
  138.     }
  140.     public function getCategories(): ?CategoryCollection
  141.     {
  142.         return $this->categories;
  143.     }
  145.     public function setCategories(CategoryCollection $categories): void
  146.     {
  147.         $this->categories = $categories;
  148.     }
  150.     /**
  151.      *@internal (flag:FEATURE_NEXT_10078)
  152.      */
  153.     public function getProducts(): ?ProductCollection
  154.     {
  155.         return $this->products;
  156.     }
  158.     /**
  159.      *@internal (flag:FEATURE_NEXT_10078)
  160.      */
  161.     public function setProducts(ProductCollection $products): void
  162.     {
  163.         $this->products = $products;
  164.     }
  166.     public function getConfig(): ?array
  167.     {
  168.         return $this->config;
  169.     }
  171.     public function setConfig(array $config): void
  172.     {
  173.         $this->config = $config;
  174.     }
  176.     public function getPreviewMediaId(): ?string
  177.     {
  178.         return $this->previewMediaId;
  179.     }
  181.     public function setPreviewMediaId(string $previewMediaId): void
  182.     {
  183.         $this->previewMediaId = $previewMediaId;
  184.     }
  186.     public function getPreviewMedia(): ?MediaEntity
  187.     {
  188.         return $this->previewMedia;
  189.     }
  191.     public function setPreviewMedia(MediaEntity $previewMedia): void
  192.     {
  193.         $this->previewMedia = $previewMedia;
  194.     }
  196.     public function getLocked(): bool
  197.     {
  198.         return $this->locked;
  199.     }
  201.     public function setLocked(bool $locked): void
  202.     {
  203.         $this->locked = $locked;
  204.     }
  206.     public function getFirstElementOfType(string $type): ?CmsSlotEntity
  207.     {
  208.         $elements = $this->getElementsOfType($type);
  210.         return array_shift($elements);
  211.     }
  213.     public function getElementsOfType(string $type): array
  214.     {
  215.         $elements = [];
  216.         if (!$this->getSections()) {
  217.             return $elements;
  218.         }
  220.         foreach ($this->getSections()->getBlocks() as $block) {
  221.             if (!$block->getSlots()) {
  222.                 continue;
  223.             }
  225.             foreach ($block->getSlots() as $slot) {
  226.                 if ($slot->getType() === $type) {
  227.                     $elements[] = $slot;
  228.                 }
  229.             }
  230.         }
  232.         return $elements;
  233.     }
  234. }