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

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\LandingPage\LandingPageCollection;
  9. use Shopware\Core\Content\Media\MediaEntity;
  10. use Shopware\Core\Content\Product\ProductCollection;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  12. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  15. class CmsPageEntity extends Entity
  16. {
  17.     use EntityIdTrait;
  19.     /**
  20.      * @var string|null
  21.      */
  22.     protected $name;
  24.     /**
  25.      * @var string
  26.      */
  27.     protected $type;
  29.     /**
  30.      * @var string|null
  31.      */
  32.     protected $entity;
  34.     /**
  35.      * @var CmsSectionCollection|null
  36.      */
  37.     protected $sections;
  39.     /**
  40.      * @var EntityCollection|null
  41.      */
  42.     protected $translations;
  44.     /**
  45.      * @var CategoryCollection|null
  46.      */
  47.     protected $categories;
  49.     /**
  50.      * @internal (flag:FEATURE_NEXT_10078)
  51.      *
  52.      * @var ProductCollection|null
  53.      */
  54.     protected $products;
  56.     /**
  57.      * @var array|null
  58.      */
  59.     protected $config;
  61.     /**
  62.      * @var string|null
  63.      */
  64.     protected $previewMediaId;
  66.     /**
  67.      * @var MediaEntity|null
  68.      */
  69.     protected $previewMedia;
  71.     /**
  72.      * @var array|null
  73.      */
  74.     protected $customFields;
  76.     /**
  77.      * @var bool
  78.      */
  79.     protected $locked;
  81.     /**
  82.      * @internal (flag:FEATURE_NEXT_12032)
  83.      *
  84.      * @var LandingPageCollection|null
  85.      */
  86.     protected $landingPages;
  88.     public function getName(): string
  89.     {
  90.         return $this->name;
  91.     }
  93.     public function setName(string $name): void
  94.     {
  95.         $this->name = $name;
  96.     }
  98.     public function getType(): string
  99.     {
  100.         return $this->type;
  101.     }
  103.     public function setType(string $type): void
  104.     {
  105.         $this->type = $type;
  106.     }
  108.     public function getEntity(): ?string
  109.     {
  110.         return $this->entity;
  111.     }
  113.     public function setEntity(?string $entity): void
  114.     {
  115.         $this->entity = $entity;
  116.     }
  118.     public function getSections(): ?CmsSectionCollection
  119.     {
  120.         return $this->sections;
  121.     }
  123.     public function setSections(CmsSectionCollection $sections): void
  124.     {
  125.         $this->sections = $sections;
  126.     }
  128.     public function getTranslations(): ?EntityCollection
  129.     {
  130.         return $this->translations;
  131.     }
  133.     public function setTranslations(EntityCollection $translations): void
  134.     {
  135.         $this->translations = $translations;
  136.     }
  138.     public function getCustomFields(): ?array
  139.     {
  140.         return $this->customFields;
  141.     }
  143.     public function setCustomFields(?array $customFields): void
  144.     {
  145.         $this->customFields = $customFields;
  146.     }
  148.     public function getCategories(): ?CategoryCollection
  149.     {
  150.         return $this->categories;
  151.     }
  153.     public function setCategories(CategoryCollection $categories): void
  154.     {
  155.         $this->categories = $categories;
  156.     }
  158.     /**
  159.      *@internal (flag:FEATURE_NEXT_10078)
  160.      */
  161.     public function getProducts(): ?ProductCollection
  162.     {
  163.         return $this->products;
  164.     }
  166.     /**
  167.      *@internal (flag:FEATURE_NEXT_10078)
  168.      */
  169.     public function setProducts(ProductCollection $products): void
  170.     {
  171.         $this->products = $products;
  172.     }
  174.     public function getConfig(): ?array
  175.     {
  176.         return $this->config;
  177.     }
  179.     public function setConfig(array $config): void
  180.     {
  181.         $this->config = $config;
  182.     }
  184.     public function getPreviewMediaId(): ?string
  185.     {
  186.         return $this->previewMediaId;
  187.     }
  189.     public function setPreviewMediaId(string $previewMediaId): void
  190.     {
  191.         $this->previewMediaId = $previewMediaId;
  192.     }
  194.     public function getPreviewMedia(): ?MediaEntity
  195.     {
  196.         return $this->previewMedia;
  197.     }
  199.     public function setPreviewMedia(MediaEntity $previewMedia): void
  200.     {
  201.         $this->previewMedia = $previewMedia;
  202.     }
  204.     public function getLocked(): bool
  205.     {
  206.         return $this->locked;
  207.     }
  209.     public function setLocked(bool $locked): void
  210.     {
  211.         $this->locked = $locked;
  212.     }
  214.     public function getFirstElementOfType(string $type): ?CmsSlotEntity
  215.     {
  216.         $elements = $this->getElementsOfType($type);
  218.         return array_shift($elements);
  219.     }
  221.     /**
  222.      * @internal (flag:FEATURE_NEXT_12032)
  223.      */
  224.     public function getLandingPages(): ?LandingPageCollection
  225.     {
  226.         return $this->landingPages;
  227.     }
  229.     /**
  230.      * @internal (flag:FEATURE_NEXT_12032)
  231.      */
  232.     public function setLandingPages(LandingPageCollection $landingPages): void
  233.     {
  234.         $this->landingPages = $landingPages;
  235.     }
  237.     public function getElementsOfType(string $type): array
  238.     {
  239.         $elements = [];
  240.         if (!$this->getSections()) {
  241.             return $elements;
  242.         }
  244.         foreach ($this->getSections()->getBlocks() as $block) {
  245.             if (!$block->getSlots()) {
  246.                 continue;
  247.             }
  249.             foreach ($block->getSlots() as $slot) {
  250.                 if ($slot->getType() === $type) {
  251.                     $elements[] = $slot;
  252.                 }
  253.             }
  254.         }
  256.         return $elements;
  257.     }
  258. }