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|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 CmsPageEntity|null
  125.      */
  126.     protected $cmsPage;
  128.     /**
  129.      * @var string|null
  130.      */
  131.     protected $productStreamId;
  133.     /**
  134.      * @var ProductStreamEntity|null
  135.      */
  136.     protected $productStream;
  138.     /**
  139.      * @var array|null
  140.      */
  141.     protected $slotConfig;
  143.     /**
  144.      * @var SalesChannelCollection|null
  145.      */
  146.     protected $navigationSalesChannels;
  148.     /**
  149.      * @var SalesChannelCollection|null
  150.      */
  151.     protected $footerSalesChannels;
  153.     /**
  154.      * @var SalesChannelCollection|null
  155.      */
  156.     protected $serviceSalesChannels;
  158.     /**
  159.      * @var string|null
  160.      */
  161.     protected $linkType;
  163.     /**
  164.      * @var bool|null
  165.      */
  166.     protected $linkNewTab;
  168.     /**
  169.      * @var string|null
  170.      */
  171.     protected $internalLink;
  173.     /**
  174.      * @var string|null
  175.      */
  176.     protected $externalLink;
  178.     /**
  179.      * @var bool
  180.      */
  181.     protected $visible;
  183.     /**
  184.      * @var string
  185.      */
  186.     protected $type;
  188.     /**
  189.      * @var string
  190.      */
  191.     protected $productAssignmentType;
  193.     /**
  194.      * @var string|null
  195.      */
  196.     protected $description;
  198.     /**
  199.      * @var string|null
  200.      */
  201.     protected $metaTitle;
  203.     /**
  204.      * @var string|null
  205.      */
  206.     protected $metaDescription;
  208.     /**
  209.      * @var string|null
  210.      */
  211.     protected $keywords;
  213.     /**
  214.      * @var MainCategoryCollection|null
  215.      */
  216.     protected $mainCategories;
  218.     /**
  219.      * @var SeoUrlCollection|null
  220.      */
  221.     protected $seoUrls;
  223.     public function getParentId(): ?string
  224.     {
  225.         return $this->parentId;
  226.     }
  228.     public function setParentId(?string $parentId): void
  229.     {
  230.         $this->parentId = $parentId;
  231.     }
  233.     public function getMediaId(): ?string
  234.     {
  235.         return $this->mediaId;
  236.     }
  238.     public function setMediaId(?string $mediaId): void
  239.     {
  240.         $this->mediaId = $mediaId;
  241.     }
  243.     public function getName(): ?string
  244.     {
  245.         return $this->name;
  246.     }
  248.     public function setName(?string $name): void
  249.     {
  250.         $this->name = $name;
  251.     }
  253.     public function getPath(): ?string
  254.     {
  255.         return $this->path;
  256.     }
  258.     public function setPath(?string $path): void
  259.     {
  260.         $this->path = $path;
  261.     }
  263.     public function getLevel(): int
  264.     {
  265.         return $this->level;
  266.     }
  268.     public function setLevel(int $level): void
  269.     {
  270.         $this->level = $level;
  271.     }
  273.     public function getActive(): bool
  274.     {
  275.         return $this->active;
  276.     }
  278.     public function setActive(bool $active): void
  279.     {
  280.         $this->active = $active;
  281.     }
  283.     public function getChildCount(): int
  284.     {
  285.         return $this->childCount;
  286.     }
  288.     public function setChildCount(int $childCount): void
  289.     {
  290.         $this->childCount = $childCount;
  291.     }
  293.     public function getVisibleChildCount(): int
  294.     {
  295.         return $this->visibleChildCount;
  296.     }
  298.     public function setVisibleChildCount(int $visibleChildCount): void
  299.     {
  300.         $this->visibleChildCount = $visibleChildCount;
  301.     }
  303.     public function getParent(): ?CategoryEntity
  304.     {
  305.         return $this->parent;
  306.     }
  308.     public function setParent(CategoryEntity $parent): void
  309.     {
  310.         $this->parent = $parent;
  311.     }
  313.     public function getMedia(): ?MediaEntity
  314.     {
  315.         return $this->media;
  316.     }
  318.     public function setMedia(MediaEntity $media): void
  319.     {
  320.         $this->media = $media;
  321.     }
  323.     public function getChildren(): ?CategoryCollection
  324.     {
  325.         return $this->children;
  326.     }
  328.     public function setChildren(CategoryCollection $children): void
  329.     {
  330.         $this->children = $children;
  331.     }
  333.     public function getTranslations(): ?CategoryTranslationCollection
  334.     {
  335.         return $this->translations;
  336.     }
  338.     public function setTranslations(CategoryTranslationCollection $translations): void
  339.     {
  340.         $this->translations = $translations;
  341.     }
  343.     public function getProducts(): ?ProductCollection
  344.     {
  345.         return $this->products;
  346.     }
  348.     public function setProducts(ProductCollection $products): void
  349.     {
  350.         $this->products = $products;
  351.     }
  353.     public function getAutoIncrement(): int
  354.     {
  355.         return $this->autoIncrement;
  356.     }
  358.     public function setAutoIncrement(int $autoIncrement): void
  359.     {
  360.         $this->autoIncrement = $autoIncrement;
  361.     }
  363.     public function getNestedProducts(): ?ProductCollection
  364.     {
  365.         return $this->nestedProducts;
  366.     }
  368.     public function setNestedProducts(ProductCollection $nestedProducts): void
  369.     {
  370.         $this->nestedProducts = $nestedProducts;
  371.     }
  373.     public function getDisplayNestedProducts(): bool
  374.     {
  375.         return $this->displayNestedProducts;
  376.     }
  378.     public function setDisplayNestedProducts(bool $displayNestedProducts): void
  379.     {
  380.         $this->displayNestedProducts = $displayNestedProducts;
  381.     }
  383.     public function getAfterCategoryId(): ?string
  384.     {
  385.         return $this->afterCategoryId;
  386.     }
  388.     public function setAfterCategoryId(string $afterCategoryId): void
  389.     {
  390.         $this->afterCategoryId = $afterCategoryId;
  391.     }
  393.     public function getTags(): ?TagCollection
  394.     {
  395.         return $this->tags;
  396.     }
  398.     public function setTags(TagCollection $tags): void
  399.     {
  400.         $this->tags = $tags;
  401.     }
  403.     public function getCmsPage(): ?CmsPageEntity
  404.     {
  405.         return $this->cmsPage;
  406.     }
  408.     public function setCmsPage(CmsPageEntity $cmsPage): void
  409.     {
  410.         $this->cmsPage = $cmsPage;
  411.     }
  413.     public function getCmsPageId(): ?string
  414.     {
  415.         return $this->cmsPageId;
  416.     }
  418.     public function setCmsPageId(string $cmsPageId): void
  419.     {
  420.         $this->cmsPageId = $cmsPageId;
  421.     }
  423.     public function getProductStream(): ?ProductStreamEntity
  424.     {
  425.         return $this->productStream;
  426.     }
  428.     public function setProductStream(ProductStreamEntity $productStream): void
  429.     {
  430.         $this->productStream = $productStream;
  431.     }
  433.     public function getProductStreamId(): ?string
  434.     {
  435.         return $this->productStreamId;
  436.     }
  438.     public function setProductStreamId(string $productStreamId): void
  439.     {
  440.         $this->productStreamId = $productStreamId;
  441.     }
  443.     public function getSlotConfig(): ?array
  444.     {
  445.         return $this->slotConfig;
  446.     }
  448.     public function setSlotConfig(array $slotConfig): void
  449.     {
  450.         $this->slotConfig = $slotConfig;
  451.     }
  453.     public function getNavigationSalesChannels(): ?SalesChannelCollection
  454.     {
  455.         return $this->navigationSalesChannels;
  456.     }
  458.     public function setNavigationSalesChannels(SalesChannelCollection $navigationSalesChannels): void
  459.     {
  460.         $this->navigationSalesChannels = $navigationSalesChannels;
  461.     }
  463.     public function getFooterSalesChannels(): ?SalesChannelCollection
  464.     {
  465.         return $this->footerSalesChannels;
  466.     }
  468.     public function setFooterSalesChannels(SalesChannelCollection $footerSalesChannels): void
  469.     {
  470.         $this->footerSalesChannels = $footerSalesChannels;
  471.     }
  473.     public function getServiceSalesChannels(): ?SalesChannelCollection
  474.     {
  475.         return $this->serviceSalesChannels;
  476.     }
  478.     public function setServiceSalesChannels(SalesChannelCollection $serviceSalesChannels): void
  479.     {
  480.         $this->serviceSalesChannels = $serviceSalesChannels;
  481.     }
  483.     public function getLinkType(): ?string
  484.     {
  485.         return $this->linkType;
  486.     }
  488.     public function setLinkType(?string $linkType): void
  489.     {
  490.         $this->linkType = $linkType;
  491.     }
  493.     public function getLinkNewTab(): ?bool
  494.     {
  495.         return $this->linkNewTab;
  496.     }
  498.     public function setLinkNewTab(?bool $linkNewTab): void
  499.     {
  500.         $this->linkNewTab = $linkNewTab;
  501.     }
  503.     public function getInternalLink(): ?string
  504.     {
  505.         return $this->internalLink;
  506.     }
  508.     public function setInternalLink(?string $internalLink): void
  509.     {
  510.         $this->internalLink = $internalLink;
  511.     }
  513.     public function getExternalLink(): ?string
  514.     {
  515.         return $this->externalLink;
  516.     }
  518.     public function setExternalLink(string $externalLink): void
  519.     {
  520.         $this->externalLink = $externalLink;
  521.     }
  523.     public function getVisible(): bool
  524.     {
  525.         return $this->visible;
  526.     }
  528.     public function setVisible(bool $visible): void
  529.     {
  530.         $this->visible = $visible;
  531.     }
  533.     public function getType(): string
  534.     {
  535.         return $this->type;
  536.     }
  538.     public function setType(string $type): void
  539.     {
  540.         $this->type = $type;
  541.     }
  543.     public function getDescription(): ?string
  544.     {
  545.         return $this->description;
  546.     }
  548.     public function setDescription(string $description): void
  549.     {
  550.         $this->description = $description;
  551.     }
  553.     public function getBreadcrumb(): array
  554.     {
  555.         return array_values($this->getPlainBreadcrumb());
  556.     }
  558.     public function getPlainBreadcrumb(): array
  559.     {
  560.         $breadcrumb = $this->getTranslation('breadcrumb');
  561.         if ($breadcrumb === null) {
  562.             return [];
  563.         }
  564.         if ($this->path === null) {
  565.             return $breadcrumb;
  566.         }
  568.         $parts = \array_slice(explode('|', $this->path), 1, -1);
  570.         $filtered = [];
  571.         foreach ($parts as $id) {
  572.             if (isset($breadcrumb[$id])) {
  573.                 $filtered[$id] = $breadcrumb[$id];
  574.             }
  575.         }
  577.         $filtered[$this->getId()] = $breadcrumb[$this->getId()];
  579.         return $filtered;
  580.     }
  582.     public function setBreadcrumb(?array $breadcrumb): void
  583.     {
  584.         $this->breadcrumb = $breadcrumb;
  585.     }
  587.     public function jsonSerialize(): array
  588.     {
  589.         // Make sure that the sorted breadcrumb gets serialized
  590.         $data = parent::jsonSerialize();
  591.         $data['translated']['breadcrumb'] = $data['breadcrumb'] = $this->getBreadcrumb();
  593.         return $data;
  594.     }
  596.     public function getMainCategories(): ?MainCategoryCollection
  597.     {
  598.         return $this->mainCategories;
  599.     }
  601.     public function setMainCategories(MainCategoryCollection $mainCategories): void
  602.     {
  603.         $this->mainCategories = $mainCategories;
  604.     }
  606.     public function getMetaTitle(): ?string
  607.     {
  608.         return $this->metaTitle;
  609.     }
  611.     public function setMetaTitle(?string $metaTitle): void
  612.     {
  613.         $this->metaTitle = $metaTitle;
  614.     }
  616.     public function getMetaDescription(): ?string
  617.     {
  618.         return $this->metaDescription;
  619.     }
  621.     public function setMetaDescription(?string $metaDescription): void
  622.     {
  623.         $this->metaDescription = $metaDescription;
  624.     }
  626.     public function getKeywords(): ?string
  627.     {
  628.         return $this->keywords;
  629.     }
  631.     public function setKeywords(?string $keywords): void
  632.     {
  633.         $this->keywords = $keywords;
  634.     }
  636.     public function getSeoUrls(): ?SeoUrlCollection
  637.     {
  638.         return $this->seoUrls;
  639.     }
  641.     public function setSeoUrls(SeoUrlCollection $seoUrls): void
  642.     {
  643.         $this->seoUrls = $seoUrls;
  644.     }
  646.     public function getProductAssignmentType(): string
  647.     {
  648.         return $this->productAssignmentType;
  649.     }
  651.     public function setProductAssignmentType(string $productAssignmentType): void
  652.     {
  653.         $this->productAssignmentType = $productAssignmentType;
  654.     }
  655. }