Interface CategoryInterface

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 isActive( void ) : boolean

Is tax of the OrderItem allowed?

public setActive( BoolType $status ) : CategoryInterface

Sets whether category is active or not.

public getParentId( void ) : integer

Returns the ID of the parent category.

public setParentId( IdType $categoryId ) : CategoryInterface

Sets the parent ID of the category.

public getSortOrder( void ) : integer

Returns the sort order value.

public setSortOrder( IntType $sortOrder ) : CategoryInterface

Sets the sort order to the given value.

public getAddedDateTime( void ) : DateTime

Returns the date time when the category was added.

public setAddedDateTime( DateTime $added ) : CategoryInterface

Sets the date time when the category was added.

public getLastModifiedDateTime( void ) : DateTime

Returns the date time when the category was modified last.

public setLastModifiedDateTime( DateTime $modified ) : CategoryInterface

Sets the date time when the category was modified last.

public getSettings( void ) : CategorySettingsInterface

Returns the settings of the category.

public setSettings( CategorySettingsInterface $categorySettings ) : CategoryInterface

Sets the settings of the category.

public getName( LanguageCode $language ) : string

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

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

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

public getHeadingTitle( LanguageCode $language ) : string

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

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

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

public getDescription( LanguageCode $language ) : string

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

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

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

public getMetaTitle( LanguageCode $language ) : string

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

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

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

public getMetaDescription( LanguageCode $language ) : string

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

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

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

public getMetaKeywords( LanguageCode $language ) : string

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

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

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

public getUrlKeywords( LanguageCode $language ) : string

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

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

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

public getUrlRewrite( LanguageCode $language ) : UrlRewrite

Get URL rewrite

public getUrlRewrites( void ) : UrlRewriteCollection

Get URL rewrites

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

Set URL rewrite

public setUrlRewrites( UrlRewriteCollection $urlRewrites ) : Category

Set URL rewrites

public getImage( void ) : string

Returns the image filename of the category.

public setImage( StringType $imageFile ) : CategoryInterface

Sets the image filename of the category.

public getImageAltText( LanguageCode $language ) : string

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

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

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

public getIcon( void ) : string

Returns the icon filename of the category.

public setIcon( StringType $iconFile ) : CategoryInterface

Sets the icon filename of the category.

public getAddonValue( StringType $key ) : string

Returns an addon value by a given key.

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

Sets an addon key and value.

public getAddonValues( void ) : KeyValueCollection

Returns a KeyValueCollection of addon values.

public addAddonValues( KeyValueCollection $collection ) : CategoryInterface

Adds a KeyValueCollection of addon values.

public deleteAddonValue( StringType $key ) : CategoryInterface

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