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

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\CmsPageTranslation\CmsPageTranslationEntity;
  7. use Shopware\Core\Content\Cms\Aggregate\CmsSection\CmsSectionCollection;
  8. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  9. use Shopware\Core\Content\LandingPage\LandingPageCollection;
  10. use Shopware\Core\Content\Media\MediaEntity;
  11. use Shopware\Core\Content\Product\ProductCollection;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  14. use Shopware\Core\Framework\DataAbstractionLayer\EntityCustomFieldsTrait;
  15. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  16. use Shopware\Core\Framework\Log\Package;
  18. #[Package('content')]
  19. class CmsPageEntity extends Entity
  20. {
  21.     use EntityIdTrait;
  22.     use EntityCustomFieldsTrait;
  24.     /**
  25.      * @var string|null
  26.      */
  27.     protected $name;
  29.     /**
  30.      * @var string
  31.      */
  32.     protected $type;
  34.     /**
  35.      * @var string|null
  36.      */
  37.     protected $entity;
  39.     /**
  40.      * @var CmsSectionCollection|null
  41.      */
  42.     protected $sections;
  44.     /**
  45.      * @var EntityCollection<CmsPageTranslationEntity>|null
  46.      */
  47.     protected $translations;
  49.     /**
  50.      * @var CategoryCollection|null
  51.      */
  52.     protected $categories;
  54.     /**
  55.      * @var ProductCollection|null
  56.      */
  57.     protected $products;
  59.     /**
  60.      * @var string|null
  61.      */
  62.     protected $cssClass;
  64.     /**
  65.      * @var array|null
  66.      */
  67.     protected $config;
  69.     /**
  70.      * @var string|null
  71.      */
  72.     protected $previewMediaId;
  74.     /**
  75.      * @var MediaEntity|null
  76.      */
  77.     protected $previewMedia;
  79.     /**
  80.      * @var bool
  81.      */
  82.     protected $locked;
  84.     /**
  85.      * @var LandingPageCollection|null
  86.      */
  87.     protected $landingPages;
  89.     /**
  90.      * @var CmsPageCollection|null
  91.      */
  92.     protected $homeSalesChannels;
  94.     public function getName(): ?string
  95.     {
  96.         return $this->name;
  97.     }
  99.     public function setName(?string $name): void
  100.     {
  101.         $this->name = $name;
  102.     }
  104.     public function getType(): string
  105.     {
  106.         return $this->type;
  107.     }
  109.     public function setType(string $type): void
  110.     {
  111.         $this->type = $type;
  112.     }
  114.     public function getEntity(): ?string
  115.     {
  116.         return $this->entity;
  117.     }
  119.     public function setEntity(?string $entity): void
  120.     {
  121.         $this->entity = $entity;
  122.     }
  124.     public function getSections(): ?CmsSectionCollection
  125.     {
  126.         return $this->sections;
  127.     }
  129.     public function setSections(CmsSectionCollection $sections): void
  130.     {
  131.         $this->sections = $sections;
  132.     }
  134.     /**
  135.      * @return EntityCollection<CmsPageTranslationEntity>|null
  136.      */
  137.     public function getTranslations(): ?EntityCollection
  138.     {
  139.         return $this->translations;
  140.     }
  142.     /**
  143.      * @param EntityCollection<CmsPageTranslationEntity> $translations
  144.      */
  145.     public function setTranslations(EntityCollection $translations): void
  146.     {
  147.         $this->translations = $translations;
  148.     }
  150.     public function getCategories(): ?CategoryCollection
  151.     {
  152.         return $this->categories;
  153.     }
  155.     public function setCategories(CategoryCollection $categories): void
  156.     {
  157.         $this->categories = $categories;
  158.     }
  160.     public function getProducts(): ?ProductCollection
  161.     {
  162.         return $this->products;
  163.     }
  165.     public function setProducts(ProductCollection $products): void
  166.     {
  167.         $this->products = $products;
  168.     }
  170.     public function getCssClass(): ?string
  171.     {
  172.         return $this->cssClass;
  173.     }
  175.     public function setCssClass(?string $cssClass): void
  176.     {
  177.         $this->cssClass = $cssClass;
  178.     }
  180.     public function getConfig(): ?array
  181.     {
  182.         return $this->config;
  183.     }
  185.     public function setConfig(array $config): void
  186.     {
  187.         $this->config = $config;
  188.     }
  190.     public function getPreviewMediaId(): ?string
  191.     {
  192.         return $this->previewMediaId;
  193.     }
  195.     public function setPreviewMediaId(string $previewMediaId): void
  196.     {
  197.         $this->previewMediaId = $previewMediaId;
  198.     }
  200.     public function getPreviewMedia(): ?MediaEntity
  201.     {
  202.         return $this->previewMedia;
  203.     }
  205.     public function setPreviewMedia(MediaEntity $previewMedia): void
  206.     {
  207.         $this->previewMedia = $previewMedia;
  208.     }
  210.     public function getLocked(): bool
  211.     {
  212.         return $this->locked;
  213.     }
  215.     public function setLocked(bool $locked): void
  216.     {
  217.         $this->locked = $locked;
  218.     }
  220.     public function getFirstElementOfType(string $type): ?CmsSlotEntity
  221.     {
  222.         $elements = $this->getElementsOfType($type);
  224.         return array_shift($elements);
  225.     }
  227.     public function getLandingPages(): ?LandingPageCollection
  228.     {
  229.         return $this->landingPages;
  230.     }
  232.     public function setLandingPages(LandingPageCollection $landingPages): void
  233.     {
  234.         $this->landingPages = $landingPages;
  235.     }
  237.     public function getHomeSalesChannels(): ?CmsPageCollection
  238.     {
  239.         return $this->homeSalesChannels;
  240.     }
  242.     public function setHomeSalesChannels(CmsPageCollection $homeSalesChannels): void
  243.     {
  244.         $this->homeSalesChannels = $homeSalesChannels;
  245.     }
  247.     public function getElementsOfType(string $type): array
  248.     {
  249.         $elements = [];
  250.         if ($this->getSections() === null) {
  251.             return $elements;
  252.         }
  254.         foreach ($this->getSections()->getBlocks() as $block) {
  255.             if ($block->getSlots() === null) {
  256.                 continue;
  257.             }
  259.             foreach ($block->getSlots() as $slot) {
  260.                 if ($slot->getType() === $type) {
  261.                     $elements[] = $slot;
  262.                 }
  263.             }
  264.         }
  266.         return $elements;
  267.     }
  268. }