CeresItemConfig

PluginConfig class, including all plugin settings for the single item view.

Namespace

Ceres\Config

Extends
Properties
Type Name Description

string

$displayName

Name of an item to display. Possible values are 'itemName', 'variationName' and 'itemNameVariationName'.

int

$itemName

Item name.

array

$itemData

Show item information.

Deprecated: will be removed in 6.0.0.

int

$storeSpecial

Number of decimal places for discounts.

bool

$showVariationOverDropdown

Defines if the selection of variations without stock in the variation dropdown is enabled.

Deprecated: will be removed in 6.0.0.

string

$variationShowType

Show variations by type. Possible values are 'all', 'main', 'child' and 'combined'.

Deprecated: will be removed in 6.0.0.

bool

$showPleaseSelect

Defines if the "Please select" option is displayed.

bool

$enableImageCarousel

Defines if the image carousel for category item list is enabled.

bool

$categoryShowDots

Show image carousel dots in category item list and item lists.

Deprecated: will be removed in 6.0.0.

bool

$categoryShowNav

Show image carousel navigation in category item list and item lists.

Deprecated: will be removed in 6.0.0.

bool

$showCategoryImage

Show category image in category view.

Deprecated: will be removed in 6.0.0.

bool

$showCategoryDescription

Show category description in category view.

Deprecated: will be removed in 6.0.0.

string

$showCategoryDescriptionTop

Show category description above item list. Possible values are 'none', 'description1', 'description2' and 'both'.

Deprecated: will be removed in 6.0.0.

string

$showCategoryDescriptionBottom

Show category description below item list. Possible values are 'none', 'description1', 'description2' and 'both'.

Deprecated: will be removed in 6.0.0.

bool

$requireOrderProperties

Defines if all order properties are required before adding an item to shopping cart.

string

$loadingAnimationType

Loading animation. Possible values are 'bars' and 'spinner'.

Deprecated: will be removed in 6.0.0.

bool

$showCategoryFilter

Show categories as filter options for search results.

Deprecated: will be removed in 6.0.0.

Methods
public getPluginName():string

Return the name of the plugin to get the configuration values for.

public load()

Initially load configuration values into member variables.