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

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;
  17. class CmsPageEntity extends Entity
  18. {
  19.     use EntityIdTrait;
  20.     use EntityCustomFieldsTrait;
  22.     /**
  23.      * @var string|null
  24.      */
  25.     protected $name;
  27.     /**
  28.      * @var string
  29.      */
  30.     protected $type;
  32.     /**
  33.      * @var string|null
  34.      */
  35.     protected $entity;
  37.     /**
  38.      * @var CmsSectionCollection|null
  39.      */
  40.     protected $sections;
  42.     /**
  43.      * @var EntityCollection<CmsPageTranslationEntity>|null
  44.      */
  45.     protected $translations;
  47.     /**
  48.      * @var CategoryCollection|null
  49.      */
  50.     protected $categories;
  52.     /**
  53.      * @var ProductCollection|null
  54.      */
  55.     protected $products;
  57.     /**
  58.      * @var string|null
  59.      */
  60.     protected $cssClass;
  62.     /**
  63.      * @var array|null
  64.      */
  65.     protected $config;
  67.     /**
  68.      * @var string|null
  69.      */
  70.     protected $previewMediaId;
  72.     /**
  73.      * @var MediaEntity|null
  74.      */
  75.     protected $previewMedia;
  77.     /**
  78.      * @var bool
  79.      */
  80.     protected $locked;
  82.     /**
  83.      * @var LandingPageCollection|null
  84.      */
  85.     protected $landingPages;
  87.     /**
  88.      * @var CmsPageCollection|null
  89.      */
  90.     protected $homeSalesChannels;
  92.     public function getName(): ?string
  93.     {
  94.         return $this->name;
  95.     }
  97.     public function setName(?string $name): void
  98.     {
  99.         $this->name = $name;
  100.     }
  102.     public function getType(): string
  103.     {
  104.         return $this->type;
  105.     }
  107.     public function setType(string $type): void
  108.     {
  109.         $this->type = $type;
  110.     }
  112.     public function getEntity(): ?string
  113.     {
  114.         return $this->entity;
  115.     }
  117.     public function setEntity(?string $entity): void
  118.     {
  119.         $this->entity = $entity;
  120.     }
  122.     public function getSections(): ?CmsSectionCollection
  123.     {
  124.         return $this->sections;
  125.     }
  127.     public function setSections(CmsSectionCollection $sections): void
  128.     {
  129.         $this->sections = $sections;
  130.     }
  132.     /**
  133.      * @return EntityCollection<CmsPageTranslationEntity>|null
  134.      */
  135.     public function getTranslations(): ?EntityCollection
  136.     {
  137.         return $this->translations;
  138.     }
  140.     /**
  141.      * @param EntityCollection<CmsPageTranslationEntity> $translations
  142.      */
  143.     public function setTranslations(EntityCollection $translations): void
  144.     {
  145.         $this->translations = $translations;
  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.     public function getProducts(): ?ProductCollection
  159.     {
  160.         return $this->products;
  161.     }
  163.     public function setProducts(ProductCollection $products): void
  164.     {
  165.         $this->products = $products;
  166.     }
  168.     public function getCssClass(): ?string
  169.     {
  170.         return $this->cssClass;
  171.     }
  173.     public function setCssClass(?string $cssClass): void
  174.     {
  175.         $this->cssClass = $cssClass;
  176.     }
  178.     public function getConfig(): ?array
  179.     {
  180.         return $this->config;
  181.     }
  183.     public function setConfig(array $config): void
  184.     {
  185.         $this->config = $config;
  186.     }
  188.     public function getPreviewMediaId(): ?string
  189.     {
  190.         return $this->previewMediaId;
  191.     }
  193.     public function setPreviewMediaId(string $previewMediaId): void
  194.     {
  195.         $this->previewMediaId = $previewMediaId;
  196.     }
  198.     public function getPreviewMedia(): ?MediaEntity
  199.     {
  200.         return $this->previewMedia;
  201.     }
  203.     public function setPreviewMedia(MediaEntity $previewMedia): void
  204.     {
  205.         $this->previewMedia = $previewMedia;
  206.     }
  208.     public function getLocked(): bool
  209.     {
  210.         return $this->locked;
  211.     }
  213.     public function setLocked(bool $locked): void
  214.     {
  215.         $this->locked = $locked;
  216.     }
  218.     public function getFirstElementOfType(string $type): ?CmsSlotEntity
  219.     {
  220.         $elements = $this->getElementsOfType($type);
  222.         return array_shift($elements);
  223.     }
  225.     public function getLandingPages(): ?LandingPageCollection
  226.     {
  227.         return $this->landingPages;
  228.     }
  230.     public function setLandingPages(LandingPageCollection $landingPages): void
  231.     {
  232.         $this->landingPages = $landingPages;
  233.     }
  235.     public function getHomeSalesChannels(): ?CmsPageCollection
  236.     {
  237.         return $this->homeSalesChannels;
  238.     }
  240.     public function setHomeSalesChannels(CmsPageCollection $homeSalesChannels): void
  241.     {
  242.         $this->homeSalesChannels = $homeSalesChannels;
  243.     }
  245.     public function getElementsOfType(string $type): array
  246.     {
  247.         $elements = [];
  248.         if ($this->getSections() === null) {
  249.             return $elements;
  250.         }
  252.         foreach ($this->getSections()->getBlocks() as $block) {
  253.             if ($block->getSlots() === null) {
  254.                 continue;
  255.             }
  257.             foreach ($block->getSlots() as $slot) {
  258.                 if ($slot->getType() === $type) {
  259.                     $elements[] = $slot;
  260.                 }
  261.             }
  262.         }
  264.         return $elements;
  265.     }
  266. }