CategoryInterface

Extends

Interface CategoryInterface

category

System

package

Category

subpackage

Interfaces

Methods

Adds a KeyValueCollection of addon values.

addAddonValues(\KeyValueCollection $collection) : \CategoryInterface

Arguments

$collection

\KeyValueCollection

Key value collection.

Response

\CategoryInterface

Same instance for chained method calls.

Deletes an addon value with a given key from the KeyValueCollection.

deleteAddonValue(\StringType $key) : \CategoryInterface

Arguments

$key

\StringType

Identifier key.

Response

\CategoryInterface

Same instance for chained method calls.

Returns the date time when the category was added.

getAddedDateTime() : \DateTime

Response

\DateTime

The date time when the category was added.

Returns an addon value by a given key.

getAddonValue(\StringType $key) : string

Arguments

$key

\StringType

Identifier key.

Response

string

Addon value by a given key.

Returns a KeyValueCollection of addon values.

getAddonValues() : \KeyValueCollection

Response

\KeyValueCollection

A KeyValueCollection of addon values.

Returns the description of the category for the language with the provided language code.

getDescription(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

Description of the category from the given language code.

Returns the bottom description of the category for the language with the provided language code.

getDescriptionBottom(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

Description of the category from the given language code.

Returns the heading title of the category in the language with the provided language code.

getHeadingTitle(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

Heading title of the category from the given language code.

Returns the icon filename of the category.

getIcon() : string

Response

string

The icon filename of the category.

Returns the image filename of the category.

getImage() : string

Response

string

The image filename of the category.

Returns the alternative text of the image in the language with the provided language code.

getImageAltText(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

The alt text of the image.

Returns the date time when the category was modified last.

getLastModifiedDateTime() : \DateTime

Response

\DateTime

The date time when the category was modified last.

Returns the meta description of the category in the language with the provided language code.

getMetaDescription(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

Meta description of the category from the given language code.

Returns the meta keywords of the category in the language with the provided language code.

getMetaKeywords(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

Meta keywords of the category from the given language code.

Returns the meta title of the category for the language with the provided language code.

getMetaTitle(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

Meta title of the category from the given language code

Returns the name of the category in the language with the provided language code.

getName(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter Language code.

Response

string

Name of the category from the given language code.

Returns the OpenGraph image filename of the category.

getOpenGraphImage() : string

Response

string

The image filename of the category.

Returns the ID of the parent category.

getParentId() : integer

Response

integer

The ID of the parent category

Returns the settings of the category.

getSettings() : \CategorySettingsInterface

Response

\CategorySettingsInterface

Settings of the category.

Returns the sort order value.

getSortOrder() : integer

Response

integer

Sort order value.

Returns the url keywords of the category in the language with the provided language code.

getUrlKeywords(\LanguageCode $language) : string

Arguments

$language

\LanguageCode

Two letter language code.

Response

string

URL keywords of the category from the given language code.

Get URL rewrite

getUrlRewrite(\LanguageCode $language) : \UrlRewrite

Returns the URL rewrite of the category, depending on the provided language code.

Throws
\InvalidArgumentException

if the language code is not valid.

Arguments

$language

\LanguageCode

The language code of the URL rewrite to be return.

Response

\UrlRewrite

The URL rewrite of the category.

Get URL rewrites

getUrlRewrites() : \UrlRewriteCollection

Returns the URL rewrites of the category.

Response

\UrlRewriteCollection

The URL rewrites of the category.

Is tax of the OrderItem allowed?

isActive() : boolean

Response

boolean

Value if tax of the OrderItem allowed.

Sets whether category is active or not.

setActive(\BoolType $status) : \CategoryInterface

Arguments

$status

\BoolType

Category active or not?

Response

\CategoryInterface

Same instance for chained method calls.

Sets the date time when the category was added.

setAddedDateTime(\DateTime $added) : \CategoryInterface

Arguments

$added

\DateTime

DateTime when the category has been added.

Response

\CategoryInterface

Same instance for chained method calls.

Sets an addon key and value.

setAddonValue(\StringType $key, \StringType $value) : \CategoryInterface

Arguments

$key

\StringType

Identifier key.

$value

\StringType

The value to be saved.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the description of the category for the language with the provided language code.

setDescription(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

Description of the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the bottom description of the category for the language with the provided language code.

setDescriptionBottom(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

Description of the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the heading title of the category for the language with the provided language code.

setHeadingTitle(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

Heading title of the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the icon filename of the category.

setIcon(\StringType $iconFile) : \CategoryInterface

Arguments

$iconFile

\StringType

Icon filename.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the image filename of the category.

setImage(\StringType $imageFile) : \CategoryInterface

Arguments

$imageFile

\StringType

Image filename.

Response

\CategoryInterface

Same instance for chained method calls.

Set the alternative text of the image for the language with the provided language code.

setImageAltText(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

Alternative text for the image.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the date time when the category was modified last.

setLastModifiedDateTime(\DateTime $modified) : \CategoryInterface

Arguments

$modified

\DateTime

DateTime when the category has been lastly modified.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the meta description of the category for the language with the provided language code.

setMetaDescription(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

Meta description of the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the meta keywords of the category for the language with the provided language code.

setMetaKeywords(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

The meta keyword for the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the meta title of the category for the language with the provided language code.

setMetaTitle(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

Meta title of the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the name of the category for the language with the provided language code.

setName(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

Name of the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the OpenGraph image filename of the category.

setOpenGraphImage(\StringType $imageFile) : \CategoryInterface

Arguments

$imageFile

\StringType

Image filename.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the parent ID of the category.

setParentId(\IdType $categoryId) : \CategoryInterface

Arguments

$categoryId

\IdType

Category ID.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the settings of the category.

setSettings(\CategorySettingsInterface $categorySettings) : \CategoryInterface

Arguments

$categorySettings

\CategorySettingsInterface

The settings of the category.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the sort order to the given value.

setSortOrder(\IntType $sortOrder) : \CategoryInterface

Arguments

$sortOrder

\IntType

Sorting order.

Response

\CategoryInterface

Same instance for chained method calls.

Sets the url keywords of the category for the language with the provided language code.

setUrlKeywords(\StringType $text, \LanguageCode $language) : \CategoryInterface

Arguments

$text

\StringType

URL Keyword for the category.

$language

\LanguageCode

Two letter language code.

Response

\CategoryInterface

Same instance for chained method calls.

Set URL rewrite

setUrlRewrite(\UrlRewrite $urlRewrite, \LanguageCode $language) : \Category

Sets the URL rewrite of the category for the provided language code.

Arguments

$urlRewrite

\UrlRewrite

The URL rewrite instance.

$language

\LanguageCode

The language code for the URL keywords.

Response

\Category

Same instance for chained method calls.

Set URL rewrites

setUrlRewrites(\UrlRewriteCollection $urlRewrites) : \Category

Sets the URL rewrites of the category.

Arguments

$urlRewrites

\UrlRewriteCollection

The URL rewrites.

Response

\Category

Same instance for chained method calls.