Interface CategoryInterface

Direct known implementers

Category, StoredCategoryInterface

Indirect known implementers

StoredCategory

Package: Category\Interfaces
Category: System
Located at Services/Core/Category/Entities/Interfaces/CategoryInterface.inc.php

Methods summary

`public boolean`	# `isActive( )` Is tax of the OrderItem allowed? Is tax of the OrderItem allowed? Returns boolean Value if tax of the OrderItem allowed.
`public CategoryInterface`	# `setActive( BoolType $status )` Sets whether category is active or not. Sets whether category is active or not. Parameters `$status` Category active or not? Returns `CategoryInterface` Same instance for chained method calls.
`public integer`	# `getParentId( )` Returns the ID of the parent category. Returns the ID of the parent category. Returns integer The ID of the parent category
`public CategoryInterface`	# `setParentId( IdType $categoryId )` Sets the parent ID of the category. Sets the parent ID of the category. Parameters `$categoryId` Category ID. Returns `CategoryInterface` Same instance for chained method calls.
`public integer`	# `getSortOrder( )` Returns the sort order value. Returns the sort order value. Returns integer Sort order value.
`public CategoryInterface`	# `setSortOrder( IntType $sortOrder )` Sets the sort order to the given value. Sets the sort order to the given value. Parameters `$sortOrder` Sorting order. Returns `CategoryInterface` Same instance for chained method calls.
`public DateTime`	# `getAddedDateTime( )` Returns the date time when the category was added. Returns the date time when the category was added. Returns DateTime The date time when the category was added.
`public CategoryInterface`	# `setAddedDateTime( DateTime $added )` Sets the date time when the category was added. Sets the date time when the category was added. Parameters `$added` DateTime when the category has been added. Returns `CategoryInterface` Same instance for chained method calls.
`public DateTime`	# `getLastModifiedDateTime( )` Returns the date time when the category was modified last. Returns the date time when the category was modified last. Returns DateTime The date time when the category was modified last.
`public CategoryInterface`	# `setLastModifiedDateTime( DateTime $modified )` Sets the date time when the category was modified last. Sets the date time when the category was modified last. Parameters `$modified` DateTime when the category has been lastly modified. Returns `CategoryInterface` Same instance for chained method calls.
`public CategorySettingsInterface`	# `getSettings( )` Returns the settings of the category. Returns the settings of the category. Returns `CategorySettingsInterface` Settings of the category.
`public CategoryInterface`	# `setSettings( CategorySettingsInterface $categorySettings )` Sets the settings of the category. Sets the settings of the category. Parameters `$categorySettings` The settings of the category. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getName( LanguageCode $language )` Returns the name of the category in the language with the provided language code. Returns the name of the category in the language with the provided language code. Parameters `$language` Two letter Language code. Returns string Name of the category from the given language code.
`public CategoryInterface`	# `setName( StringType $text, LanguageCode $language )` Sets the name of the category for the language with the provided language code. Sets the name of the category for the language with the provided language code. Parameters `$text` Name of the category. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getHeadingTitle( LanguageCode $language )` Returns the heading title of the category in the language with the provided language code. Returns the heading title of the category in the language with the provided language code. Parameters `$language` Two letter language code. Returns string Heading title of the category from the given language code.
`public CategoryInterface`	# `setHeadingTitle( StringType $text, LanguageCode $language )` Sets the heading title of the category for the language with the provided language code. Sets the heading title of the category for the language with the provided language code. Parameters `$text` Heading title of the category. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getDescription( LanguageCode $language )` Returns the description of the category for the language with the provided language code. Returns the description of the category for the language with the provided language code. Parameters `$language` Two letter language code. Returns string Description of the category from the given language code.
`public CategoryInterface`	# `setDescription( StringType $text, LanguageCode $language )` Sets the description of the category for the language with the provided language code. Sets the description of the category for the language with the provided language code. Parameters `$text` Description of the category. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getMetaTitle( LanguageCode $language )` Returns the meta title of the category for the language with the provided language code. Returns the meta title of the category for the language with the provided language code. Parameters `$language` Two letter language code. Returns string Meta title of the category from the given language code
`public CategoryInterface`	# `setMetaTitle( StringType $text, LanguageCode $language )` Sets the meta title of the category for the language with the provided language code. Sets the meta title of the category for the language with the provided language code. Parameters `$text` Meta title of the category. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getMetaDescription( LanguageCode $language )` Returns the meta description of the category in the language with the provided language code. Returns the meta description of the category in the language with the provided language code. Parameters `$language` Two letter language code. Returns string Meta description of the category from the given language code.
`public CategoryInterface`	# `setMetaDescription( StringType $text, LanguageCode $language )` Sets the meta description of the category for the language with the provided language code. Sets the meta description of the category for the language with the provided language code. Parameters `$text` Meta description of the category. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getMetaKeywords( LanguageCode $language )` Returns the meta keywords of the category in the language with the provided language code. Returns the meta keywords of the category in the language with the provided language code. Parameters `$language` Two letter language code. Returns string Meta keywords of the category from the given language code.
`public CategoryInterface`	# `setMetaKeywords( StringType $text, LanguageCode $language )` Sets the meta keywords of the category for the language with the provided language code. Sets the meta keywords of the category for the language with the provided language code. Parameters `$text` The meta keyword for the category. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getUrlKeywords( LanguageCode $language )` Returns the url keywords of the category in the language with the provided language code. Returns the url keywords of the category in the language with the provided language code. Parameters `$language` Two letter language code. Returns string URL keywords of the category from the given language code.
`public CategoryInterface`	# `setUrlKeywords( StringType $text, LanguageCode $language )` Sets the url keywords of the category for the language with the provided language code. Sets the url keywords of the category for the language with the provided language code. Parameters `$text` URL Keyword for the category. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public UrlRewrite`	# `getUrlRewrite( LanguageCode $language )` Get URL rewrite Get URL rewrite Returns the URL rewrite of the category, depending on the provided language code. Parameters `$language` The language code of the URL rewrite to be return. Returns `UrlRewrite` The URL rewrite of the category. Throws InvalidArgumentException if the language code is not valid.
`public UrlRewriteCollection`	# `getUrlRewrites( )` Get URL rewrites Get URL rewrites Returns the URL rewrites of the category. Returns `UrlRewriteCollection` The URL rewrites of the category.
`public Category`	# `setUrlRewrite( UrlRewrite $urlRewrite, LanguageCode $language )` Set URL rewrite Set URL rewrite Sets the URL rewrite of the category for the provided language code. Parameters `$urlRewrite` The URL rewrite instance. `$language` The language code for the URL keywords. Returns `Category` Same instance for chained method calls.
`public Category`	# `setUrlRewrites( UrlRewriteCollection $urlRewrites )` Set URL rewrites Set URL rewrites Sets the URL rewrites of the category. Parameters `$urlRewrites` The URL rewrites. Returns `Category` Same instance for chained method calls.
`public string`	# `getImage( )` Returns the image filename of the category. Returns the image filename of the category. Returns string The image filename of the category.
`public CategoryInterface`	# `setImage( StringType $imageFile )` Sets the image filename of the category. Sets the image filename of the category. Parameters `$imageFile` Image filename. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getImageAltText( LanguageCode $language )` Returns the alternative text of the image in the language with the provided language code. Returns the alternative text of the image in the language with the provided language code. Parameters `$language` Two letter language code. Returns string The alt text of the image.
`public CategoryInterface`	# `setImageAltText( StringType $text, LanguageCode $language )` Set the alternative text of the image for the language with the provided language code. Set the alternative text of the image for the language with the provided language code. Parameters `$text` Alternative text for the image. `$language` Two letter language code. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getIcon( )` Returns the icon filename of the category. Returns the icon filename of the category. Returns string The icon filename of the category.
`public CategoryInterface`	# `setIcon( StringType $iconFile )` Sets the icon filename of the category. Sets the icon filename of the category. Parameters `$iconFile` Icon filename. Returns `CategoryInterface` Same instance for chained method calls.
`public string`	# `getAddonValue( StringType $key )` Returns an addon value by a given key. Returns an addon value by a given key. Parameters `$key` Identifier key. Returns string Addon value by a given key.
`public CategoryInterface`	# `setAddonValue( StringType $key, StringType $value )` Sets an addon key and value. Sets an addon key and value. Parameters `$key` Identifier key. `$value` The value to be saved. Returns `CategoryInterface` Same instance for chained method calls.
`public KeyValueCollection`	# `getAddonValues( )` Returns a KeyValueCollection of addon values. Returns a KeyValueCollection of addon values. Returns `KeyValueCollection` A KeyValueCollection of addon values.
`public CategoryInterface`	# `addAddonValues( KeyValueCollection $collection )` Adds a KeyValueCollection of addon values. Adds a KeyValueCollection of addon values. Parameters `$collection` Key value collection. Returns `CategoryInterface` Same instance for chained method calls.
`public CategoryInterface`	# `deleteAddonValue( StringType $key )` Deletes an addon value with a given key from the KeyValueCollection. Deletes an addon value with a given key from the KeyValueCollection. Parameters `$key` Identifier key. Returns `CategoryInterface` Same instance for chained method calls.

Packages

Interfaces

Interface CategoryInterface

Direct known implementers

Indirect known implementers

Methods summary

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns