StoredCategoryInterface
extends
CategoryInterface, AddonValueContainerInterface
in
Interface StoredCategoryInterface
This interface extends the Category CategoryInterface and represents a persisted category with an unique ID.
Tags
Table of Contents
- addAddonValues() : mixed
- Merges the existing addon values with new ones.
- deleteAddonValue() : mixed
- Deletes a specific addon value entry by key.
- getAddedDateTime() : DateTime
- Returns the date time when the category was added.
- getAddonValue() : string
- Returns a specific addon value by providing its key.
- getAddonValueContainerId() : int
- Returns the addon value container ID.
- getAddonValues() : KeyValueCollection
- Returns all the addon values as a KeyValueCollection.
- getCategoryId() : int
- Gets the ID of the StoredCategory.
- getDescription() : string
- Returns the description of the category for the language with the provided language code.
- getDescriptionBottom() : string
- Returns the bottom description of the category for the language with the provided language code.
- getHeadingTitle() : string
- Returns the heading title of the category in the language with the provided language code.
- getIcon() : string
- Returns the icon filename of the category.
- getImage() : string
- Returns the image filename of the category.
- getImageAltText() : string
- Returns the alternative text of the image in the language with the provided language code.
- getLastModifiedDateTime() : DateTime
- Returns the date time when the category was modified last.
- getMetaDescription() : string
- Returns the meta description of the category in the language with the provided language code.
- getMetaKeywords() : string
- Returns the meta keywords of the category in the language with the provided language code.
- getMetaTitle() : string
- Returns the meta title of the category for the language with the provided language code.
- getName() : string
- Returns the name of the category in the language with the provided language code.
- getOpenGraphImage() : string
- Returns the OpenGraph image filename of the category.
- getParentId() : int
- Returns the ID of the parent category.
- getSettings() : CategorySettingsInterface
- Returns the settings of the category.
- getSortOrder() : int
- Returns the sort order value.
- getUrlKeywords() : string
- Returns the url keywords of the category in the language with the provided language code.
- getUrlRewrite() : UrlRewrite
- Get URL rewrite
- getUrlRewrites() : UrlRewriteCollection
- Get URL rewrites
- isActive() : bool
- Is tax of the OrderItem allowed?
- setActive() : CategoryInterface
- Sets whether category is active or not.
- setAddedDateTime() : CategoryInterface
- Sets the date time when the category was added.
- setAddonValue() : mixed
- Sets the value of a specific addon key.
- setDescription() : CategoryInterface
- Sets the description of the category for the language with the provided language code.
- setDescriptionBottom() : CategoryInterface
- Sets the bottom description of the category for the language with the provided language code.
- setHeadingTitle() : CategoryInterface
- Sets the heading title of the category for the language with the provided language code.
- setIcon() : CategoryInterface
- Sets the icon filename of the category.
- setImage() : CategoryInterface
- Sets the image filename of the category.
- setImageAltText() : CategoryInterface
- Set the alternative text of the image for the language with the provided language code.
- setLastModifiedDateTime() : CategoryInterface
- Sets the date time when the category was modified last.
- setMetaDescription() : CategoryInterface
- Sets the meta description of the category for the language with the provided language code.
- setMetaKeywords() : CategoryInterface
- Sets the meta keywords of the category for the language with the provided language code.
- setMetaTitle() : CategoryInterface
- Sets the meta title of the category for the language with the provided language code.
- setName() : CategoryInterface
- Sets the name of the category for the language with the provided language code.
- setOpenGraphImage() : CategoryInterface
- Sets the OpenGraph image filename of the category.
- setParentId() : CategoryInterface
- Sets the parent ID of the category.
- setSettings() : CategoryInterface
- Sets the settings of the category.
- setSortOrder() : CategoryInterface
- Sets the sort order to the given value.
- setUrlKeywords() : CategoryInterface
- Sets the url keywords of the category for the language with the provided language code.
- setUrlRewrite() : Category
- Set URL rewrite
- setUrlRewrites() : Category
- Set URL rewrites
Methods
addAddonValues()
Merges the existing addon values with new ones.
public
addAddonValues(KeyValueCollection $addonValues) : mixed
Parameters
- $addonValues : KeyValueCollection
-
Contains the new addon values to be merged with the existing ones.
Return values
mixed —deleteAddonValue()
Deletes a specific addon value entry by key.
public
deleteAddonValue(StringType $key) : mixed
Parameters
- $key : StringType
-
Addon key.
Return values
mixed —getAddedDateTime()
Returns the date time when the category was added.
public
getAddedDateTime() : DateTime
Return values
DateTime —The date time when the category was added.
getAddonValue()
Returns a specific addon value by providing its key.
public
getAddonValue(StringType $key) : string
Parameters
- $key : StringType
-
Addon key.
Return values
string —getAddonValueContainerId()
Returns the addon value container ID.
public
getAddonValueContainerId() : int
Return values
int —Addon value container ID.
getAddonValues()
Returns all the addon values as a KeyValueCollection.
public
getAddonValues() : KeyValueCollection
Return values
KeyValueCollection —Addons key value collection.
getCategoryId()
Gets the ID of the StoredCategory.
public
getCategoryId() : int
Return values
int —getDescription()
Returns the description of the category for the language with the provided language code.
public
getDescription(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —Description of the category from the given language code.
getDescriptionBottom()
Returns the bottom description of the category for the language with the provided language code.
public
getDescriptionBottom(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —Description of the category from the given language code.
getHeadingTitle()
Returns the heading title of the category in the language with the provided language code.
public
getHeadingTitle(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —Heading title of the category from the given language code.
getIcon()
Returns the icon filename of the category.
public
getIcon() : string
Return values
string —The icon filename of the category.
getImage()
Returns the image filename of the category.
public
getImage() : string
Return values
string —The image filename of the category.
getImageAltText()
Returns the alternative text of the image in the language with the provided language code.
public
getImageAltText(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —The alt text of the image.
getLastModifiedDateTime()
Returns the date time when the category was modified last.
public
getLastModifiedDateTime() : DateTime
Return values
DateTime —The date time when the category was modified last.
getMetaDescription()
Returns the meta description of the category in the language with the provided language code.
public
getMetaDescription(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —Meta description of the category from the given language code.
getMetaKeywords()
Returns the meta keywords of the category in the language with the provided language code.
public
getMetaKeywords(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —Meta keywords of the category from the given language code.
getMetaTitle()
Returns the meta title of the category for the language with the provided language code.
public
getMetaTitle(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —Meta title of the category from the given language code
getName()
Returns the name of the category in the language with the provided language code.
public
getName(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter Language code.
Return values
string —Name of the category from the given language code.
getOpenGraphImage()
Returns the OpenGraph image filename of the category.
public
getOpenGraphImage() : string
Return values
string —The image filename of the category.
getParentId()
Returns the ID of the parent category.
public
getParentId() : int
Return values
int —The ID of the parent category
getSettings()
Returns the settings of the category.
public
getSettings() : CategorySettingsInterface
Return values
CategorySettingsInterface —Settings of the category.
getSortOrder()
Returns the sort order value.
public
getSortOrder() : int
Return values
int —Sort order value.
getUrlKeywords()
Returns the url keywords of the category in the language with the provided language code.
public
getUrlKeywords(LanguageCode $language) : string
Parameters
- $language : LanguageCode
-
Two letter language code.
Return values
string —URL keywords of the category from the given language code.
getUrlRewrite()
Get URL rewrite
public
getUrlRewrite(LanguageCode $language) : UrlRewrite
Returns the URL rewrite of the category, depending on the provided language code.
Parameters
- $language : LanguageCode
-
The language code of the URL rewrite to be return.
Tags
Return values
UrlRewrite —The URL rewrite of the category.
getUrlRewrites()
Get URL rewrites
public
getUrlRewrites() : UrlRewriteCollection
Returns the URL rewrites of the category.
Return values
UrlRewriteCollection —The URL rewrites of the category.
isActive()
Is tax of the OrderItem allowed?
public
isActive() : bool
Return values
bool —Value if tax of the OrderItem allowed.
setActive()
Sets whether category is active or not.
public
setActive(BoolType $status) : CategoryInterface
Parameters
- $status : BoolType
-
Category active or not?
Return values
CategoryInterface —Same instance for chained method calls.
setAddedDateTime()
Sets the date time when the category was added.
public
setAddedDateTime(DateTime $added) : CategoryInterface
Parameters
- $added : DateTime
-
DateTime when the category has been added.
Return values
CategoryInterface —Same instance for chained method calls.
setAddonValue()
Sets the value of a specific addon key.
public
setAddonValue(StringType $key, StringType $value) : mixed
Parameters
- $key : StringType
-
The addon key to be processed.
- $value : StringType
-
The new value of the addon entry.
Return values
mixed —setDescription()
Sets the description of the category for the language with the provided language code.
public
setDescription(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
Description of the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setDescriptionBottom()
Sets the bottom description of the category for the language with the provided language code.
public
setDescriptionBottom(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
Description of the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setHeadingTitle()
Sets the heading title of the category for the language with the provided language code.
public
setHeadingTitle(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
Heading title of the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setIcon()
Sets the icon filename of the category.
public
setIcon(StringType $iconFile) : CategoryInterface
Parameters
- $iconFile : StringType
-
Icon filename.
Return values
CategoryInterface —Same instance for chained method calls.
setImage()
Sets the image filename of the category.
public
setImage(StringType $imageFile) : CategoryInterface
Parameters
- $imageFile : StringType
-
Image filename.
Return values
CategoryInterface —Same instance for chained method calls.
setImageAltText()
Set the alternative text of the image for the language with the provided language code.
public
setImageAltText(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
Alternative text for the image.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setLastModifiedDateTime()
Sets the date time when the category was modified last.
public
setLastModifiedDateTime(DateTime $modified) : CategoryInterface
Parameters
- $modified : DateTime
-
DateTime when the category has been lastly modified.
Return values
CategoryInterface —Same instance for chained method calls.
setMetaDescription()
Sets the meta description of the category for the language with the provided language code.
public
setMetaDescription(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
Meta description of the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setMetaKeywords()
Sets the meta keywords of the category for the language with the provided language code.
public
setMetaKeywords(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
The meta keyword for the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setMetaTitle()
Sets the meta title of the category for the language with the provided language code.
public
setMetaTitle(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
Meta title of the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setName()
Sets the name of the category for the language with the provided language code.
public
setName(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
Name of the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setOpenGraphImage()
Sets the OpenGraph image filename of the category.
public
setOpenGraphImage(StringType $imageFile) : CategoryInterface
Parameters
- $imageFile : StringType
-
Image filename.
Return values
CategoryInterface —Same instance for chained method calls.
setParentId()
Sets the parent ID of the category.
public
setParentId(IdType $categoryId) : CategoryInterface
Parameters
- $categoryId : IdType
-
Category ID.
Return values
CategoryInterface —Same instance for chained method calls.
setSettings()
Sets the settings of the category.
public
setSettings(CategorySettingsInterface $categorySettings) : CategoryInterface
Parameters
- $categorySettings : CategorySettingsInterface
-
The settings of the category.
Return values
CategoryInterface —Same instance for chained method calls.
setSortOrder()
Sets the sort order to the given value.
public
setSortOrder(IntType $sortOrder) : CategoryInterface
Parameters
- $sortOrder : IntType
-
Sorting order.
Return values
CategoryInterface —Same instance for chained method calls.
setUrlKeywords()
Sets the url keywords of the category for the language with the provided language code.
public
setUrlKeywords(StringType $text, LanguageCode $language) : CategoryInterface
Parameters
- $text : StringType
-
URL Keyword for the category.
- $language : LanguageCode
-
Two letter language code.
Return values
CategoryInterface —Same instance for chained method calls.
setUrlRewrite()
Set URL rewrite
public
setUrlRewrite(UrlRewrite $urlRewrite, LanguageCode $language) : Category
Sets the URL rewrite of the category for the provided language code.
Parameters
- $urlRewrite : UrlRewrite
-
The URL rewrite instance.
- $language : LanguageCode
-
The language code for the URL keywords.
Return values
Category —Same instance for chained method calls.
setUrlRewrites()
Set URL rewrites
public
setUrlRewrites(UrlRewriteCollection $urlRewrites) : Category
Sets the URL rewrites of the category.
Parameters
- $urlRewrites : UrlRewriteCollection
-
The URL rewrites.
Return values
Category —Same instance for chained method calls.