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

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\Framework\Log\Package;
  16. use Shopware\Core\System\SalesChannel\SalesChannelCollection;
  17. use Shopware\Core\System\Tag\TagCollection;
  19. #[Package('content')]
  20. class CategoryEntity extends Entity
  21. {
  22.     use EntityIdTrait;
  23.     use EntityCustomFieldsTrait;
  25.     /**
  26.      * @var string|null
  27.      */
  28.     public $afterCategoryId;
  30.     /**
  31.      * @var string|null
  32.      */
  33.     protected $parentId;
  35.     /**
  36.      * @var int
  37.      */
  38.     protected $autoIncrement;
  40.     /**
  41.      * @var string|null
  42.      */
  43.     protected $mediaId;
  45.     /**
  46.      * @var string|null
  47.      */
  48.     protected $name;
  50.     /**
  51.      * @var array<mixed>|null
  52.      */
  53.     protected $breadcrumb;
  55.     /**
  56.      * @var string|null
  57.      */
  58.     protected $path;
  60.     /**
  61.      * @var int
  62.      */
  63.     protected $level;
  65.     /**
  66.      * @var bool
  67.      */
  68.     protected $active;
  70.     /**
  71.      * @var int
  72.      */
  73.     protected $childCount;
  75.     /**
  76.      * @var int
  77.      */
  78.     protected $visibleChildCount = 0;
  80.     /**
  81.      * @var bool
  82.      */
  83.     protected $displayNestedProducts;
  85.     /**
  86.      * @var CategoryEntity|null
  87.      */
  88.     protected $parent;
  90.     /**
  91.      * @var CategoryCollection|null
  92.      */
  93.     protected $children;
  95.     /**
  96.      * @var CategoryTranslationCollection|null
  97.      */
  98.     protected $translations;
  100.     /**
  101.      * @var MediaEntity|null
  102.      */
  103.     protected $media;
  105.     /**
  106.      * @var ProductCollection|null
  107.      */
  108.     protected $products;
  110.     /**
  111.      * @var ProductCollection|null
  112.      */
  113.     protected $nestedProducts;
  115.     /**
  116.      * @var TagCollection|null
  117.      */
  118.     protected $tags;
  120.     /**
  121.      * @var string|null
  122.      */
  123.     protected $cmsPageId;
  125.     /**
  126.      * @var bool
  127.      */
  128.     protected $cmsPageIdSwitched = false;
  130.     /**
  131.      * @var CmsPageEntity|null
  132.      */
  133.     protected $cmsPage;
  135.     /**
  136.      * @var string|null
  137.      */
  138.     protected $productStreamId;
  140.     /**
  141.      * @var ProductStreamEntity|null
  142.      */
  143.     protected $productStream;
  145.     /**
  146.      * @var array<mixed>|null
  147.      */
  148.     protected $slotConfig;
  150.     /**
  151.      * @var SalesChannelCollection|null
  152.      */
  153.     protected $navigationSalesChannels;
  155.     /**
  156.      * @var SalesChannelCollection|null
  157.      */
  158.     protected $footerSalesChannels;
  160.     /**
  161.      * @var SalesChannelCollection|null
  162.      */
  163.     protected $serviceSalesChannels;
  165.     /**
  166.      * @var string|null
  167.      */
  168.     protected $linkType;
  170.     /**
  171.      * @var bool|null
  172.      */
  173.     protected $linkNewTab;
  175.     /**
  176.      * @var string|null
  177.      */
  178.     protected $internalLink;
  180.     /**
  181.      * @var string|null
  182.      */
  183.     protected $externalLink;
  185.     /**
  186.      * @var bool
  187.      */
  188.     protected $visible;
  190.     /**
  191.      * @var string
  192.      */
  193.     protected $type;
  195.     /**
  196.      * @var string
  197.      */
  198.     protected $productAssignmentType;
  200.     /**
  201.      * @var string|null
  202.      */
  203.     protected $description;
  205.     /**
  206.      * @var string|null
  207.      */
  208.     protected $metaTitle;
  210.     /**
  211.      * @var string|null
  212.      */
  213.     protected $metaDescription;
  215.     /**
  216.      * @var string|null
  217.      */
  218.     protected $keywords;
  220.     /**
  221.      * @var MainCategoryCollection|null
  222.      */
  223.     protected $mainCategories;
  225.     /**
  226.      * @var SeoUrlCollection|null
  227.      */
  228.     protected $seoUrls;
  230.     public function getParentId(): ?string
  231.     {
  232.         return $this->parentId;
  233.     }
  235.     public function setParentId(?string $parentId): void
  236.     {
  237.         $this->parentId = $parentId;
  238.     }
  240.     public function getMediaId(): ?string
  241.     {
  242.         return $this->mediaId;
  243.     }
  245.     public function setMediaId(?string $mediaId): void
  246.     {
  247.         $this->mediaId = $mediaId;
  248.     }
  250.     public function getName(): ?string
  251.     {
  252.         return $this->name;
  253.     }
  255.     public function setName(?string $name): void
  256.     {
  257.         $this->name = $name;
  258.     }
  260.     public function getPath(): ?string
  261.     {
  262.         return $this->path;
  263.     }
  265.     public function setPath(?string $path): void
  266.     {
  267.         $this->path = $path;
  268.     }
  270.     public function getLevel(): int
  271.     {
  272.         return $this->level;
  273.     }
  275.     public function setLevel(int $level): void
  276.     {
  277.         $this->level = $level;
  278.     }
  280.     public function getActive(): bool
  281.     {
  282.         return $this->active;
  283.     }
  285.     public function setActive(bool $active): void
  286.     {
  287.         $this->active = $active;
  288.     }
  290.     public function getChildCount(): int
  291.     {
  292.         return $this->childCount;
  293.     }
  295.     public function setChildCount(int $childCount): void
  296.     {
  297.         $this->childCount = $childCount;
  298.     }
  300.     public function getVisibleChildCount(): int
  301.     {
  302.         return $this->visibleChildCount;
  303.     }
  305.     public function setVisibleChildCount(int $visibleChildCount): void
  306.     {
  307.         $this->visibleChildCount = $visibleChildCount;
  308.     }
  310.     public function getParent(): ?CategoryEntity
  311.     {
  312.         return $this->parent;
  313.     }
  315.     public function setParent(CategoryEntity $parent): void
  316.     {
  317.         $this->parent = $parent;
  318.     }
  320.     public function getMedia(): ?MediaEntity
  321.     {
  322.         return $this->media;
  323.     }
  325.     public function setMedia(MediaEntity $media): void
  326.     {
  327.         $this->media = $media;
  328.     }
  330.     public function getChildren(): ?CategoryCollection
  331.     {
  332.         return $this->children;
  333.     }
  335.     public function setChildren(CategoryCollection $children): void
  336.     {
  337.         $this->children = $children;
  338.     }
  340.     public function getTranslations(): ?CategoryTranslationCollection
  341.     {
  342.         return $this->translations;
  343.     }
  345.     public function setTranslations(CategoryTranslationCollection $translations): void
  346.     {
  347.         $this->translations = $translations;
  348.     }
  350.     public function getProducts(): ?ProductCollection
  351.     {
  352.         return $this->products;
  353.     }
  355.     public function setProducts(ProductCollection $products): void
  356.     {
  357.         $this->products = $products;
  358.     }
  360.     public function getAutoIncrement(): int
  361.     {
  362.         return $this->autoIncrement;
  363.     }
  365.     public function setAutoIncrement(int $autoIncrement): void
  366.     {
  367.         $this->autoIncrement = $autoIncrement;
  368.     }
  370.     public function getNestedProducts(): ?ProductCollection
  371.     {
  372.         return $this->nestedProducts;
  373.     }
  375.     public function setNestedProducts(ProductCollection $nestedProducts): void
  376.     {
  377.         $this->nestedProducts = $nestedProducts;
  378.     }
  380.     public function getDisplayNestedProducts(): bool
  381.     {
  382.         return $this->displayNestedProducts;
  383.     }
  385.     public function setDisplayNestedProducts(bool $displayNestedProducts): void
  386.     {
  387.         $this->displayNestedProducts = $displayNestedProducts;
  388.     }
  390.     public function getAfterCategoryId(): ?string
  391.     {
  392.         return $this->afterCategoryId;
  393.     }
  395.     public function setAfterCategoryId(string $afterCategoryId): void
  396.     {
  397.         $this->afterCategoryId = $afterCategoryId;
  398.     }
  400.     public function getTags(): ?TagCollection
  401.     {
  402.         return $this->tags;
  403.     }
  405.     public function setTags(TagCollection $tags): void
  406.     {
  407.         $this->tags = $tags;
  408.     }
  410.     public function getCmsPage(): ?CmsPageEntity
  411.     {
  412.         return $this->cmsPage;
  413.     }
  415.     public function setCmsPage(CmsPageEntity $cmsPage): void
  416.     {
  417.         $this->cmsPage = $cmsPage;
  418.     }
  420.     public function getCmsPageId(): ?string
  421.     {
  422.         return $this->cmsPageId;
  423.     }
  425.     public function setCmsPageId(string $cmsPageId): void
  426.     {
  427.         $this->cmsPageId = $cmsPageId;
  428.     }
  430.     public function getCmsPageIdSwitched(): bool
  431.     {
  432.         return $this->cmsPageIdSwitched;
  433.     }
  435.     public function setCmsPageIdSwitched(bool $switched): void
  436.     {
  437.         $this->cmsPageIdSwitched = $switched;
  438.     }
  440.     public function getProductStream(): ?ProductStreamEntity
  441.     {
  442.         return $this->productStream;
  443.     }
  445.     public function setProductStream(ProductStreamEntity $productStream): void
  446.     {
  447.         $this->productStream = $productStream;
  448.     }
  450.     public function getProductStreamId(): ?string
  451.     {
  452.         return $this->productStreamId;
  453.     }
  455.     public function setProductStreamId(string $productStreamId): void
  456.     {
  457.         $this->productStreamId = $productStreamId;
  458.     }
  460.     /**
  461.      * @return array<mixed>|null
  462.      */
  463.     public function getSlotConfig(): ?array
  464.     {
  465.         return $this->slotConfig;
  466.     }
  468.     /**
  469.      * @param array<mixed> $slotConfig
  470.      */
  471.     public function setSlotConfig(array $slotConfig): void
  472.     {
  473.         $this->slotConfig = $slotConfig;
  474.     }
  476.     public function getNavigationSalesChannels(): ?SalesChannelCollection
  477.     {
  478.         return $this->navigationSalesChannels;
  479.     }
  481.     public function setNavigationSalesChannels(SalesChannelCollection $navigationSalesChannels): void
  482.     {
  483.         $this->navigationSalesChannels = $navigationSalesChannels;
  484.     }
  486.     public function getFooterSalesChannels(): ?SalesChannelCollection
  487.     {
  488.         return $this->footerSalesChannels;
  489.     }
  491.     public function setFooterSalesChannels(SalesChannelCollection $footerSalesChannels): void
  492.     {
  493.         $this->footerSalesChannels = $footerSalesChannels;
  494.     }
  496.     public function getServiceSalesChannels(): ?SalesChannelCollection
  497.     {
  498.         return $this->serviceSalesChannels;
  499.     }
  501.     public function setServiceSalesChannels(SalesChannelCollection $serviceSalesChannels): void
  502.     {
  503.         $this->serviceSalesChannels = $serviceSalesChannels;
  504.     }
  506.     public function getLinkType(): ?string
  507.     {
  508.         return $this->linkType;
  509.     }
  511.     public function setLinkType(?string $linkType): void
  512.     {
  513.         $this->linkType = $linkType;
  514.     }
  516.     public function getLinkNewTab(): ?bool
  517.     {
  518.         return $this->linkNewTab;
  519.     }
  521.     public function setLinkNewTab(?bool $linkNewTab): void
  522.     {
  523.         $this->linkNewTab = $linkNewTab;
  524.     }
  526.     public function getInternalLink(): ?string
  527.     {
  528.         return $this->internalLink;
  529.     }
  531.     public function setInternalLink(?string $internalLink): void
  532.     {
  533.         $this->internalLink = $internalLink;
  534.     }
  536.     public function getExternalLink(): ?string
  537.     {
  538.         return $this->externalLink;
  539.     }
  541.     public function setExternalLink(string $externalLink): void
  542.     {
  543.         $this->externalLink = $externalLink;
  544.     }
  546.     public function getVisible(): bool
  547.     {
  548.         return $this->visible;
  549.     }
  551.     public function setVisible(bool $visible): void
  552.     {
  553.         $this->visible = $visible;
  554.     }
  556.     public function getType(): string
  557.     {
  558.         return $this->type;
  559.     }
  561.     public function setType(string $type): void
  562.     {
  563.         $this->type = $type;
  564.     }
  566.     public function getDescription(): ?string
  567.     {
  568.         return $this->description;
  569.     }
  571.     public function setDescription(string $description): void
  572.     {
  573.         $this->description = $description;
  574.     }
  576.     /**
  577.      * @return array<mixed>
  578.      */
  579.     public function getBreadcrumb(): array
  580.     {
  581.         return array_values($this->getPlainBreadcrumb());
  582.     }
  584.     /**
  585.      * @return array<mixed>
  586.      */
  587.     public function getPlainBreadcrumb(): array
  588.     {
  589.         $breadcrumb = $this->getTranslation('breadcrumb');
  590.         if ($breadcrumb === null) {
  591.             return [];
  592.         }
  593.         if ($this->path === null) {
  594.             return $breadcrumb;
  595.         }
  597.         $parts = \array_slice(explode('|', $this->path), 1, -1);
  599.         $filtered = [];
  600.         foreach ($parts as $id) {
  601.             if (isset($breadcrumb[$id])) {
  602.                 $filtered[$id] = $breadcrumb[$id];
  603.             }
  604.         }
  606.         $filtered[$this->getId()] = $breadcrumb[$this->getId()];
  608.         return $filtered;
  609.     }
  611.     /**
  612.      * @param array<mixed>|null $breadcrumb
  613.      */
  614.     public function setBreadcrumb(?array $breadcrumb): void
  615.     {
  616.         $this->breadcrumb = $breadcrumb;
  617.     }
  619.     /**
  620.      * @return array<mixed>
  621.      */
  622.     public function jsonSerialize(): array
  623.     {
  624.         // Make sure that the sorted breadcrumb gets serialized
  625.         $data = parent::jsonSerialize();
  626.         $data['translated']['breadcrumb'] = $data['breadcrumb'] = $this->getBreadcrumb();
  628.         return $data;
  629.     }
  631.     public function getMainCategories(): ?MainCategoryCollection
  632.     {
  633.         return $this->mainCategories;
  634.     }
  636.     public function setMainCategories(MainCategoryCollection $mainCategories): void
  637.     {
  638.         $this->mainCategories = $mainCategories;
  639.     }
  641.     public function getMetaTitle(): ?string
  642.     {
  643.         return $this->metaTitle;
  644.     }
  646.     public function setMetaTitle(?string $metaTitle): void
  647.     {
  648.         $this->metaTitle = $metaTitle;
  649.     }
  651.     public function getMetaDescription(): ?string
  652.     {
  653.         return $this->metaDescription;
  654.     }
  656.     public function setMetaDescription(?string $metaDescription): void
  657.     {
  658.         $this->metaDescription = $metaDescription;
  659.     }
  661.     public function getKeywords(): ?string
  662.     {
  663.         return $this->keywords;
  664.     }
  666.     public function setKeywords(?string $keywords): void
  667.     {
  668.         $this->keywords = $keywords;
  669.     }
  671.     public function getSeoUrls(): ?SeoUrlCollection
  672.     {
  673.         return $this->seoUrls;
  674.     }
  676.     public function setSeoUrls(SeoUrlCollection $seoUrls): void
  677.     {
  678.         $this->seoUrls = $seoUrls;
  679.     }
  681.     public function getProductAssignmentType(): string
  682.     {
  683.         return $this->productAssignmentType;
  684.     }
  686.     public function setProductAssignmentType(string $productAssignmentType): void
  687.     {
  688.         $this->productAssignmentType = $productAssignmentType;
  689.     }
  690. }