vendor/shopware/core/Content/Category/CategoryEntity.php line 18

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category;
  5. use Shopware\Core\Content\Category\Aggregate\CategoryTranslation\CategoryTranslationCollection;
  6. use Shopware\Core\Content\Cms\CmsPageEntity;
  7. use Shopware\Core\Content\Media\MediaEntity;
  8. use Shopware\Core\Content\Product\ProductCollection;
  9. use Shopware\Core\Content\ProductStream\ProductStreamEntity;
  10. use Shopware\Core\Content\Seo\MainCategory\MainCategoryCollection;
  11. use Shopware\Core\Content\Seo\SeoUrl\SeoUrlCollection;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityCustomFieldsTrait;
  14. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  15. use Shopware\Core\System\SalesChannel\SalesChannelCollection;
  16. use Shopware\Core\System\Tag\TagCollection;
  18. class CategoryEntity extends Entity
  19. {
  20.     use EntityIdTrait;
  21.     use EntityCustomFieldsTrait;
  23.     /**
  24.      * @var string|null
  25.      */
  26.     public $afterCategoryId;
  28.     /**
  29.      * @var string|null
  30.      */
  31.     protected $parentId;
  33.     /**
  34.      * @var int
  35.      */
  36.     protected $autoIncrement;
  38.     /**
  39.      * @var string|null
  40.      */
  41.     protected $mediaId;
  43.     /**
  44.      * @var string|null
  45.      */
  46.     protected $name;
  48.     /**
  49.      * @var array<mixed>|null
  50.      */
  51.     protected $breadcrumb;
  53.     /**
  54.      * @var string|null
  55.      */
  56.     protected $path;
  58.     /**
  59.      * @var int
  60.      */
  61.     protected $level;
  63.     /**
  64.      * @var bool
  65.      */
  66.     protected $active;
  68.     /**
  69.      * @var int
  70.      */
  71.     protected $childCount;
  73.     /**
  74.      * @var int
  75.      */
  76.     protected $visibleChildCount = 0;
  78.     /**
  79.      * @var bool
  80.      */
  81.     protected $displayNestedProducts;
  83.     /**
  84.      * @var CategoryEntity|null
  85.      */
  86.     protected $parent;
  88.     /**
  89.      * @var CategoryCollection|null
  90.      */
  91.     protected $children;
  93.     /**
  94.      * @var CategoryTranslationCollection|null
  95.      */
  96.     protected $translations;
  98.     /**
  99.      * @var MediaEntity|null
  100.      */
  101.     protected $media;
  103.     /**
  104.      * @var ProductCollection|null
  105.      */
  106.     protected $products;
  108.     /**
  109.      * @var ProductCollection|null
  110.      */
  111.     protected $nestedProducts;
  113.     /**
  114.      * @var TagCollection|null
  115.      */
  116.     protected $tags;
  118.     /**
  119.      * @var string|null
  120.      */
  121.     protected $cmsPageId;
  123.     /**
  124.      * @var bool
  125.      */
  126.     protected $cmsPageIdSwitched = false;
  128.     /**
  129.      * @var CmsPageEntity|null
  130.      */
  131.     protected $cmsPage;
  133.     /**
  134.      * @var string|null
  135.      */
  136.     protected $productStreamId;
  138.     /**
  139.      * @var ProductStreamEntity|null
  140.      */
  141.     protected $productStream;
  143.     /**
  144.      * @var array<mixed>|null
  145.      */
  146.     protected $slotConfig;
  148.     /**
  149.      * @var SalesChannelCollection|null
  150.      */
  151.     protected $navigationSalesChannels;
  153.     /**
  154.      * @var SalesChannelCollection|null
  155.      */
  156.     protected $footerSalesChannels;
  158.     /**
  159.      * @var SalesChannelCollection|null
  160.      */
  161.     protected $serviceSalesChannels;
  163.     /**
  164.      * @var string|null
  165.      */
  166.     protected $linkType;
  168.     /**
  169.      * @var bool|null
  170.      */
  171.     protected $linkNewTab;
  173.     /**
  174.      * @var string|null
  175.      */
  176.     protected $internalLink;
  178.     /**
  179.      * @var string|null
  180.      */
  181.     protected $externalLink;
  183.     /**
  184.      * @var bool
  185.      */
  186.     protected $visible;
  188.     /**
  189.      * @var string
  190.      */
  191.     protected $type;
  193.     /**
  194.      * @var string
  195.      */
  196.     protected $productAssignmentType;
  198.     /**
  199.      * @var string|null
  200.      */
  201.     protected $description;
  203.     /**
  204.      * @var string|null
  205.      */
  206.     protected $metaTitle;
  208.     /**
  209.      * @var string|null
  210.      */
  211.     protected $metaDescription;
  213.     /**
  214.      * @var string|null
  215.      */
  216.     protected $keywords;
  218.     /**
  219.      * @var MainCategoryCollection|null
  220.      */
  221.     protected $mainCategories;
  223.     /**
  224.      * @var SeoUrlCollection|null
  225.      */
  226.     protected $seoUrls;
  228.     public function getParentId(): ?string
  229.     {
  230.         return $this->parentId;
  231.     }
  233.     public function setParentId(?string $parentId): void
  234.     {
  235.         $this->parentId = $parentId;
  236.     }
  238.     public function getMediaId(): ?string
  239.     {
  240.         return $this->mediaId;
  241.     }
  243.     public function setMediaId(?string $mediaId): void
  244.     {
  245.         $this->mediaId = $mediaId;
  246.     }
  248.     public function getName(): ?string
  249.     {
  250.         return $this->name;
  251.     }
  253.     public function setName(?string $name): void
  254.     {
  255.         $this->name = $name;
  256.     }
  258.     public function getPath(): ?string
  259.     {
  260.         return $this->path;
  261.     }
  263.     public function setPath(?string $path): void
  264.     {
  265.         $this->path = $path;
  266.     }
  268.     public function getLevel(): int
  269.     {
  270.         return $this->level;
  271.     }
  273.     public function setLevel(int $level): void
  274.     {
  275.         $this->level = $level;
  276.     }
  278.     public function getActive(): bool
  279.     {
  280.         return $this->active;
  281.     }
  283.     public function setActive(bool $active): void
  284.     {
  285.         $this->active = $active;
  286.     }
  288.     public function getChildCount(): int
  289.     {
  290.         return $this->childCount;
  291.     }
  293.     public function setChildCount(int $childCount): void
  294.     {
  295.         $this->childCount = $childCount;
  296.     }
  298.     public function getVisibleChildCount(): int
  299.     {
  300.         return $this->visibleChildCount;
  301.     }
  303.     public function setVisibleChildCount(int $visibleChildCount): void
  304.     {
  305.         $this->visibleChildCount = $visibleChildCount;
  306.     }
  308.     public function getParent(): ?CategoryEntity
  309.     {
  310.         return $this->parent;
  311.     }
  313.     public function setParent(CategoryEntity $parent): void
  314.     {
  315.         $this->parent = $parent;
  316.     }
  318.     public function getMedia(): ?MediaEntity
  319.     {
  320.         return $this->media;
  321.     }
  323.     public function setMedia(MediaEntity $media): void
  324.     {
  325.         $this->media = $media;
  326.     }
  328.     public function getChildren(): ?CategoryCollection
  329.     {
  330.         return $this->children;
  331.     }
  333.     public function setChildren(CategoryCollection $children): void
  334.     {
  335.         $this->children = $children;
  336.     }
  338.     public function getTranslations(): ?CategoryTranslationCollection
  339.     {
  340.         return $this->translations;
  341.     }
  343.     public function setTranslations(CategoryTranslationCollection $translations): void
  344.     {
  345.         $this->translations = $translations;
  346.     }
  348.     public function getProducts(): ?ProductCollection
  349.     {
  350.         return $this->products;
  351.     }
  353.     public function setProducts(ProductCollection $products): void
  354.     {
  355.         $this->products = $products;
  356.     }
  358.     public function getAutoIncrement(): int
  359.     {
  360.         return $this->autoIncrement;
  361.     }
  363.     public function setAutoIncrement(int $autoIncrement): void
  364.     {
  365.         $this->autoIncrement = $autoIncrement;
  366.     }
  368.     public function getNestedProducts(): ?ProductCollection
  369.     {
  370.         return $this->nestedProducts;
  371.     }
  373.     public function setNestedProducts(ProductCollection $nestedProducts): void
  374.     {
  375.         $this->nestedProducts = $nestedProducts;
  376.     }
  378.     public function getDisplayNestedProducts(): bool
  379.     {
  380.         return $this->displayNestedProducts;
  381.     }
  383.     public function setDisplayNestedProducts(bool $displayNestedProducts): void
  384.     {
  385.         $this->displayNestedProducts = $displayNestedProducts;
  386.     }
  388.     public function getAfterCategoryId(): ?string
  389.     {
  390.         return $this->afterCategoryId;
  391.     }
  393.     public function setAfterCategoryId(string $afterCategoryId): void
  394.     {
  395.         $this->afterCategoryId = $afterCategoryId;
  396.     }
  398.     public function getTags(): ?TagCollection
  399.     {
  400.         return $this->tags;
  401.     }
  403.     public function setTags(TagCollection $tags): void
  404.     {
  405.         $this->tags = $tags;
  406.     }
  408.     public function getCmsPage(): ?CmsPageEntity
  409.     {
  410.         return $this->cmsPage;
  411.     }
  413.     public function setCmsPage(CmsPageEntity $cmsPage): void
  414.     {
  415.         $this->cmsPage = $cmsPage;
  416.     }
  418.     public function getCmsPageId(): ?string
  419.     {
  420.         return $this->cmsPageId;
  421.     }
  423.     public function setCmsPageId(string $cmsPageId): void
  424.     {
  425.         $this->cmsPageId = $cmsPageId;
  426.     }
  428.     public function getCmsPageIdSwitched(): bool
  429.     {
  430.         return $this->cmsPageIdSwitched;
  431.     }
  433.     public function setCmsPageIdSwitched(bool $switched): void
  434.     {
  435.         $this->cmsPageIdSwitched = $switched;
  436.     }
  438.     public function getProductStream(): ?ProductStreamEntity
  439.     {
  440.         return $this->productStream;
  441.     }
  443.     public function setProductStream(ProductStreamEntity $productStream): void
  444.     {
  445.         $this->productStream = $productStream;
  446.     }
  448.     public function getProductStreamId(): ?string
  449.     {
  450.         return $this->productStreamId;
  451.     }
  453.     public function setProductStreamId(string $productStreamId): void
  454.     {
  455.         $this->productStreamId = $productStreamId;
  456.     }
  458.     /**
  459.      * @return array<mixed>|null
  460.      */
  461.     public function getSlotConfig(): ?array
  462.     {
  463.         return $this->slotConfig;
  464.     }
  466.     /**
  467.      * @param array<mixed> $slotConfig
  468.      */
  469.     public function setSlotConfig(array $slotConfig): void
  470.     {
  471.         $this->slotConfig = $slotConfig;
  472.     }
  474.     public function getNavigationSalesChannels(): ?SalesChannelCollection
  475.     {
  476.         return $this->navigationSalesChannels;
  477.     }
  479.     public function setNavigationSalesChannels(SalesChannelCollection $navigationSalesChannels): void
  480.     {
  481.         $this->navigationSalesChannels = $navigationSalesChannels;
  482.     }
  484.     public function getFooterSalesChannels(): ?SalesChannelCollection
  485.     {
  486.         return $this->footerSalesChannels;
  487.     }
  489.     public function setFooterSalesChannels(SalesChannelCollection $footerSalesChannels): void
  490.     {
  491.         $this->footerSalesChannels = $footerSalesChannels;
  492.     }
  494.     public function getServiceSalesChannels(): ?SalesChannelCollection
  495.     {
  496.         return $this->serviceSalesChannels;
  497.     }
  499.     public function setServiceSalesChannels(SalesChannelCollection $serviceSalesChannels): void
  500.     {
  501.         $this->serviceSalesChannels = $serviceSalesChannels;
  502.     }
  504.     public function getLinkType(): ?string
  505.     {
  506.         return $this->linkType;
  507.     }
  509.     public function setLinkType(?string $linkType): void
  510.     {
  511.         $this->linkType = $linkType;
  512.     }
  514.     public function getLinkNewTab(): ?bool
  515.     {
  516.         return $this->linkNewTab;
  517.     }
  519.     public function setLinkNewTab(?bool $linkNewTab): void
  520.     {
  521.         $this->linkNewTab = $linkNewTab;
  522.     }
  524.     public function getInternalLink(): ?string
  525.     {
  526.         return $this->internalLink;
  527.     }
  529.     public function setInternalLink(?string $internalLink): void
  530.     {
  531.         $this->internalLink = $internalLink;
  532.     }
  534.     public function getExternalLink(): ?string
  535.     {
  536.         return $this->externalLink;
  537.     }
  539.     public function setExternalLink(string $externalLink): void
  540.     {
  541.         $this->externalLink = $externalLink;
  542.     }
  544.     public function getVisible(): bool
  545.     {
  546.         return $this->visible;
  547.     }
  549.     public function setVisible(bool $visible): void
  550.     {
  551.         $this->visible = $visible;
  552.     }
  554.     public function getType(): string
  555.     {
  556.         return $this->type;
  557.     }
  559.     public function setType(string $type): void
  560.     {
  561.         $this->type = $type;
  562.     }
  564.     public function getDescription(): ?string
  565.     {
  566.         return $this->description;
  567.     }
  569.     public function setDescription(string $description): void
  570.     {
  571.         $this->description = $description;
  572.     }
  574.     /**
  575.      * @return array<mixed>
  576.      */
  577.     public function getBreadcrumb(): array
  578.     {
  579.         return array_values($this->getPlainBreadcrumb());
  580.     }
  582.     /**
  583.      * @return array<mixed>
  584.      */
  585.     public function getPlainBreadcrumb(): array
  586.     {
  587.         $breadcrumb = $this->getTranslation('breadcrumb');
  588.         if ($breadcrumb === null) {
  589.             return [];
  590.         }
  591.         if ($this->path === null) {
  592.             return $breadcrumb;
  593.         }
  595.         $parts = \array_slice(explode('|', $this->path), 1, -1);
  597.         $filtered = [];
  598.         foreach ($parts as $id) {
  599.             if (isset($breadcrumb[$id])) {
  600.                 $filtered[$id] = $breadcrumb[$id];
  601.             }
  602.         }
  604.         $filtered[$this->getId()] = $breadcrumb[$this->getId()];
  606.         return $filtered;
  607.     }
  609.     /**
  610.      * @param array<mixed>|null $breadcrumb
  611.      */
  612.     public function setBreadcrumb(?array $breadcrumb): void
  613.     {
  614.         $this->breadcrumb = $breadcrumb;
  615.     }
  617.     /**
  618.      * @return array<mixed>
  619.      */
  620.     public function jsonSerialize(): array
  621.     {
  622.         // Make sure that the sorted breadcrumb gets serialized
  623.         $data = parent::jsonSerialize();
  624.         $data['translated']['breadcrumb'] = $data['breadcrumb'] = $this->getBreadcrumb();
  626.         return $data;
  627.     }
  629.     public function getMainCategories(): ?MainCategoryCollection
  630.     {
  631.         return $this->mainCategories;
  632.     }
  634.     public function setMainCategories(MainCategoryCollection $mainCategories): void
  635.     {
  636.         $this->mainCategories = $mainCategories;
  637.     }
  639.     public function getMetaTitle(): ?string
  640.     {
  641.         return $this->metaTitle;
  642.     }
  644.     public function setMetaTitle(?string $metaTitle): void
  645.     {
  646.         $this->metaTitle = $metaTitle;
  647.     }
  649.     public function getMetaDescription(): ?string
  650.     {
  651.         return $this->metaDescription;
  652.     }
  654.     public function setMetaDescription(?string $metaDescription): void
  655.     {
  656.         $this->metaDescription = $metaDescription;
  657.     }
  659.     public function getKeywords(): ?string
  660.     {
  661.         return $this->keywords;
  662.     }
  664.     public function setKeywords(?string $keywords): void
  665.     {
  666.         $this->keywords = $keywords;
  667.     }
  669.     public function getSeoUrls(): ?SeoUrlCollection
  670.     {
  671.         return $this->seoUrls;
  672.     }
  674.     public function setSeoUrls(SeoUrlCollection $seoUrls): void
  675.     {
  676.         $this->seoUrls = $seoUrls;
  677.     }
  679.     public function getProductAssignmentType(): string
  680.     {
  681.         return $this->productAssignmentType;
  682.     }
  684.     public function setProductAssignmentType(string $productAssignmentType): void
  685.     {
  686.         $this->productAssignmentType = $productAssignmentType;
  687.     }
  688. }