Category
class Category extends Category implements PrimaryKeyInterface, CSVEntityInterface, BlockEntity, CategoryTreeSlugInterface, RelationshipEntityInterface, BreadcrumbTreeInterface
Class Category
Traits
Trait UpdatedByTrait - contains properties to trace update history
Properties
| protected string | $name | Category name | from Category |
| protected string | $description | Category description | from Category |
| protected string | $icon | Category icon | from Category |
| protected DateTime | $createdAt | Category created at | from Category |
| protected DateTime | $updatedAt | Category updated at | from Category |
| protected bool | $display | Enable disable category visibility | from Category |
| protected bool | $hideFromMenu | Show/hide category from menu | from Category |
| protected string|null | $updatedBy | User which triggered update | from UpdatedByTrait |
| protected string|null | $hash | Filed for update validation | from UpdatedByTrait |
| protected int | $code | Category code | |
| protected string | $metaTitle | Category meta title | |
| protected string | $metaDescription | Category meta description | |
| protected int | $numberOfItems | Category number of children items | |
| protected string | $imagePath | Category image web path | |
| protected string | $imageId | Category image id | |
| protected array | $permissions | Array of category permissions |
Methods
string
getCategoryName()
No description
__construct()
Constructor
mixed
getSlug()
No description
$this
setSlug(string $slug)
No description
mixed
getCode()
No description
$this
setCode(mixed $code)
No description
getDeletedAt()
No description
boolean
getIsRootCategory()
No description
$this
setIsRootCategory(boolean $isRootCategory)
No description
$this
checkIfRootCategory()
Check isRootCategory property
$this
setId(mixed $id)
No description
integer
getId()
Get id
removeAllChild()
No description
Collection
getChildren()
Get children
$this
removeAllCategoryExternalLinks()
No description
mixed
getCategoryExternalLinks()
No description
array
getVisibleChildren()
Get visible children
Collection
getProducts()
Get products
mixed
getImage()
No description
setImage(mixed $image)
No description
boolean
hasNewImages()
No description
setHasNewImages(boolean $hasNewImages)
No description
$this
setCustomCSVHeader(array $customCSVHeader)
No description
array
getCSVHeader()
No description
array
getCSVValues()
No description
setCSVValues($csvRow, mixed $locale, array $csvHeaders, array $propertyMappings = array())
No description
String
getCategoryNameWithParents()
No description
mixed
getLft()
No description
setLft(mixed $lft)
No description
mixed
getLvl()
No description
setLvl(mixed $lvl)
No description
mixed
getRgt()
No description
setRgt(mixed $rgt)
No description
mixed
getRoot()
No description
setRoot(mixed $root)
No description
array
getMetaKeywords()
No description
setMetaKeywords(array $metaKeywords)
No description
string
getMetaTitle()
No description
setMetaTitle(string $metaTitle)
No description
string
getMetaDescription()
No description
setMetaDescription(string $metaDescription)
No description
int
getNumberOfItems()
No description
$this
setNumberOfItems(int $numberOfItems)
No description
array
getVisibleItems()
No description
int
getNumberOfVisibleItems()
No description
string
getImagePath()
No description
$this
setImagePath(string $imagePath)
No description
string
getImageId()
No description
$this
setImageId(string $imageId)
No description
mixed
getGalleryImages()
No description
$this
setGalleryImages(mixed $galleryImages)
No description
bool
hasActiveCategories()
No description
$this
setHasActiveCategories(bool $hasActiveCategories)
No description
array
getPermissions()
No description
$this
setPermissions(array $permissions)
No description
string
getProductsOrder()
No description
setProductsOrder(string $productsOrder)
No description
bool
checkIsRootCategory()
No description
array
getBrandPosition()
No description
setBrandPosition(array $brandPosition)
No description
array
getAttributesSort()
No description
setAttributesSort(array $attributesSort)
No description
array
getDisabledAttributes()
No description
setDisabledAttributes(array $disabledAttributes)
No description
array
getPriceRangePosition()
No description
$this
setPriceRangePosition(array $priceRangePosition)
No description
array
getSubcategoriesPosition()
No description
$this
setSubcategoriesPosition(array $subcategoriesPosition)
No description
array
getRegex()
No description
$this
setRegex(array $regex)
No description
mixed
getBreadcrumb()
No description
$this
setBreadcrumb(mixed $breadcrumb)
No description
string
getPermalink()
No description
setPermalink(string $permalink)
No description
Details
at line 818
string
getCategoryName()
in Category at line 164
mixed
getCreatedAt()
Get createdAt
in Category at line 188
mixed
getUpdatedAt()
Get updatedAt
in Category at line 196
mixed
getDescription()
in Category at line 216
string
getIcon()
in Category at line 236
string
getName()
in Category at line 256
boolean
isDisplay()
in Category at line 276
bool
isHideFromMenu()
in Category at line 284
setHideFromMenu(bool $hideFromMenu)
in UpdatedByTrait at line 46
null|string
getUpdatedBy()
in UpdatedByTrait at line 56
$this
setUpdatedBy(null|string $updatedBy)
in UpdatedByTrait at line 66
null|string
getHash()
in UpdatedByTrait at line 76
$this
setHash(null|string $hash)
at line 497
__construct()
Constructor
at line 510
mixed
getSlug()
at line 520
$this
setSlug(string $slug)
at line 530
mixed
getCode()
at line 540
$this
setCode(mixed $code)
at line 550
DateTime
getDeletedAt()
at line 558
setDeletedAt(DateTime $deletedAt)
at line 566
boolean
getIsRootCategory()
at line 576
$this
setIsRootCategory(boolean $isRootCategory)
at line 587
$this
checkIfRootCategory()
Check isRootCategory property
at line 599
$this
setId(mixed $id)
at line 609
Category
getParent()
at line 631
integer
getId()
Get id
at line 655
removeGalleryImage(Image $image)
at line 681
removeChild(Category $children)
Remove child
at line 690
removeAllChild()
at line 700
Collection
getChildren()
Get children
at line 710
$this
addCategoryExternalLink(CategoryExternalLink $categoryExternalLink)
at line 721
removeCategoryExternalLink(CategoryExternalLink $categoryExternalLink)
at line 730
removeAllCategoryExternalLinks()
at line 738
mixed
getCategoryExternalLinks()
at line 748
array
getVisibleChildren()
Get visible children
at line 783
removeProduct(Product $product)
Remove products
at line 794
Collection
getProducts()
Get products