Interface StoredCategoryInterface
This interface extends the Category CategoryInterface and represents a persisted category with an unique ID.
| category |
System |
|---|---|
| package |
Category |
| subpackage |
Interfaces |
addAddonValues(\KeyValueCollection $addonValues)
deleteAddonValue(\StringType $key)
getAddedDateTime() : \DateTime
\DateTimeThe date time when the category was added.
getAddonValue(\StringType $key) : string
getAddonValueContainerId() : integer
integerAddon value container ID.
getAddonValues() : \KeyValueCollection
getCategoryId() : integer
integer
getDescription(\LanguageCode $language) : string
stringDescription of the category from the given language code.
getDescriptionBottom(\LanguageCode $language) : string
stringDescription of the category from the given language code.
getHeadingTitle(\LanguageCode $language) : string
stringHeading title of the category from the given language code.
getIcon() : string
stringThe icon filename of the category.
getImage() : string
stringThe image filename of the category.
getImageAltText(\LanguageCode $language) : string
stringThe alt text of the image.
getLastModifiedDateTime() : \DateTime
\DateTimeThe date time when the category was modified last.
getMetaDescription(\LanguageCode $language) : string
stringMeta description of the category from the given language code.
getMetaKeywords(\LanguageCode $language) : string
stringMeta keywords of the category from the given language code.
getMetaTitle(\LanguageCode $language) : string
stringMeta title of the category from the given language code
getName(\LanguageCode $language) : string
stringName of the category from the given language code.
getOpenGraphImage() : string
stringThe image filename of the category.
getParentId() : integer
integerThe ID of the parent category
getSettings() : \CategorySettingsInterface
getSortOrder() : integer
integerSort order value.
getUrlKeywords(\LanguageCode $language) : string
stringURL keywords of the category from the given language code.
getUrlRewrite(\LanguageCode $language) : \UrlRewrite
Returns the URL rewrite of the category, depending on the provided language code.
| Throws |
|
|---|
\UrlRewriteThe URL rewrite of the category.
getUrlRewrites() : \UrlRewriteCollection
Returns the URL rewrites of the category.
\UrlRewriteCollectionThe URL rewrites of the category.
isActive() : boolean
booleanValue if tax of the OrderItem allowed.
setActive(\BoolType $status) : \CategoryInterface
setAddedDateTime(\DateTime $added) : \CategoryInterface
\DateTimeDateTime when the category has been added.
\CategoryInterfaceSame instance for chained method calls.
setAddonValue(\StringType $key, \StringType $value)
setDescription(\StringType $text, \LanguageCode $language) : \CategoryInterface
setDescriptionBottom(\StringType $text, \LanguageCode $language) : \CategoryInterface
setHeadingTitle(\StringType $text, \LanguageCode $language) : \CategoryInterface
setIcon(\StringType $iconFile) : \CategoryInterface
setImage(\StringType $imageFile) : \CategoryInterface
setImageAltText(\StringType $text, \LanguageCode $language) : \CategoryInterface
setLastModifiedDateTime(\DateTime $modified) : \CategoryInterface
\DateTimeDateTime when the category has been lastly modified.
\CategoryInterfaceSame instance for chained method calls.
setMetaDescription(\StringType $text, \LanguageCode $language) : \CategoryInterface
setMetaKeywords(\StringType $text, \LanguageCode $language) : \CategoryInterface
setMetaTitle(\StringType $text, \LanguageCode $language) : \CategoryInterface
setName(\StringType $text, \LanguageCode $language) : \CategoryInterface
setOpenGraphImage(\StringType $imageFile) : \CategoryInterface
setParentId(\IdType $categoryId) : \CategoryInterface
setSettings(\CategorySettingsInterface $categorySettings) : \CategoryInterface
setSortOrder(\IntType $sortOrder) : \CategoryInterface
setUrlKeywords(\StringType $text, \LanguageCode $language) : \CategoryInterface
setUrlRewrite(\UrlRewrite $urlRewrite, \LanguageCode $language) : \Category
Sets the URL rewrite of the category for the provided language code.
\CategorySame instance for chained method calls.
setUrlRewrites(\UrlRewriteCollection $urlRewrites) : \Category
Sets the URL rewrites of the category.
\CategorySame instance for chained method calls.