API Documentation » \ProductSettings

category	System
package	Product
subpackage	Entities

Returns the details template name.

getDetailsTemplate() : string

Response

string

Returns the graduated quantity.

getGraduatedQuantity() : float

Response

float

Returns the minimum order value.

getMinOrder() : float

Response

float

Returns the options details template.

getOptionsDetailsTemplate() : string

Response

string

Returns the options listing template.

getOptionsListingTemplate() : string

Response

string

Returns the price status.

getPriceStatus() : integer

Response

integer

Returns the mode which is used for the quantity check.

getPropertiesCombisQuantityCheckMode() : integer

0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check

Response

integer

Returns the properties dropdown mode.

getPropertiesDropdownMode() : string

Response

string

Returns the sitemap change frequency.

getSitemapChangeFreq() : string

Response

string

Returns the sitemap priority.

getSitemapPriority() : string

Response

string

Returns the Special offer id.

getSpecialOfferId() : integer

Response

integer

The special offer id.

Returns the sort position of the startpage.

getStartpageSortOrder() : integer

Response

integer

Returns true when the customer status is permitted, false otherwise.

isPermittedCustomerStatus(\IdType $customerStatusId) : boolean

Arguments

$customerStatusId

\IdType

Id of customer status.

Response

boolean

Returns true when the product is to be displayed in the sitemap, false otherwise.

isSitemapEntry() : boolean

Response

boolean

Sets the details listing template.

setDetailsTemplate(\StringType $template) : \ProductSettings|$this

Arguments

$template

\StringType

Name of the template

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the graduated quantity.

setGraduatedQuantity(\DecimalType $quantity) : \ProductSettings|$this

Arguments

$quantity

\DecimalType

New graduated quantity.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the min order value.

setMinOrder(\DecimalType $quantity) : \ProductSettings|$this

Arguments

$quantity

\DecimalType

New minimum order.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the options details template.

setOptionsDetailsTemplate(\StringType $template) : \ProductSettings|$this

Arguments

$template

\StringType

Name of the template.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the options listing template.

setOptionsListingTemplate(\StringType $template) : \ProductSettings|$this

Arguments

$template

\StringType

Name of the template.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets customer status permissions.

setPermittedCustomerStatus(\IdType $customerStatusId, \BoolType $permitted) : \ProductSettings|$this

Arguments

$customerStatusId

\IdType

Id of customer status.

$permitted

\BoolType

Is customer permitted or not.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the price status.

setPriceStatus(\IntType $status) : \ProductSettings|$this

Arguments

$status

\IntType

New price status.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Determine which mode for the quantity check should be used.

setPropertiesCombisQuantityCheckMode(\IntType $status) : \ProductSettings|$this

0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check

Arguments

$status

\IntType

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the properties dropdown mode.

setPropertiesDropdownMode(\StringType $mode) : \ProductSettings|$this

Arguments

$mode

\StringType

New properties dropdown mode.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Shows or hides the added date time of a product.

setShowAddedDateTime(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be displayed, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Determine whether the product is to be displayed on the startpage or not.

setShowOnStartpage(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be displayed, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Shows or hides the price offer of a product.

setShowPriceOffer(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be displayed, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Shows or hides the properties price of a product.

setShowPropertiesPrice(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be displayed, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Shows or hides the quantity info of a product.

setShowQuantityInfo(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be displayed, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Shows or hides the weight of a product.

setShowWeight(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be displayed, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the sitemap change frequency.

setSitemapChangeFreq(\StringType $freq) : \ProductSettings|$this

Arguments

$freq

\StringType

New sitemap change frequency.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Determine whether the product is to be displayed in the sitemap or not.

setSitemapEntry(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be displayed, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets the sitemap priority.

setSitemapPriority(\StringType $priority) : \ProductSettings|$this

Arguments

$priority

\StringType

New sitemap priority.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Sets Special offer id.

setSpecialOfferId(\IdType $id) : \ProductSettingsInterface|$this

Arguments

$id

\IdType

The special offer id.

Response

\ProductSettingsInterface|$this

Same ProductSettingsInterface instance for chained method calls.

Sets the start page sort order.

setStartpageSortOrder(\IntType $sortOrder) : \ProductSettings|$this

Arguments

$sortOrder

\IntType

Sort position.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Determine whether the properties combis shipping time is to be used or not.

setUsePropertiesCombisShippingTime(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be used, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Determine whether the properties combis weight is to be used or not.

setUsePropertiesCombisWeight(\BoolType $status) : \ProductSettings|$this

Arguments

$status

\BoolType

True when it is to be used, false otherwise.

Response

\ProductSettings|$this

Same ProductSettings instance for chained method calls.

Returns true when the added date time is to be displayed, false otherwise.

showAddedDateTime() : boolean

Response

boolean

Returns true when the product is displayed on the start page, false otherwise.

showOnStartpage() : boolean

Response

boolean

Returns true when the price offer is to be displayed, false otherwise.

showPriceOffer() : boolean

Response

boolean

Returns true when the properties price is to be displayed, false otherwise.

showPropertiesPrice() : boolean

Response

boolean

Returns true when the quantity info is to be displayed, false otherwise.

showQuantityInfo() : boolean

Response

boolean

Returns true when the weight is to be displayed, false otherwise.

showWeight() : boolean

Response

boolean

Returns true when the properties combis shipping time is to be used, false otherwise.

usePropertiesCombisShippingTime() : boolean

Response

boolean

Returns true when the properties combis weight is to be used, false otherwise.

usePropertiesCombisWeight() : boolean

Response

boolean

Details template.

detailsTemplate : string

var

Type(s)

string

Option detail template.

optionsDetailsTemplate : string

var

Type(s)

string

Options listing template.

optionsListingTemplate : string

var

Type(s)

string

Show on start page?

showOnStartpage : boolean

var

Type(s)

boolean

Start page sort order.

startpageSortOrder : integer

var

Type(s)

integer

Show added time?

showAddedDateTime : boolean

var

Type(s)

boolean

Show quantity info?

showQuantityInfo : boolean

var

Type(s)

boolean

Show weight?

showWeight : boolean

var

Type(s)

boolean

Show price offer?

showPriceOffer : boolean

var

Type(s)

boolean

Price status.

priceStatus : integer

var

Type(s)

integer

Minimal order value.

minOrder : float

var

Type(s)

float

Graduated quantity.

graduatedQuantity : float

var

Type(s)

float

Is listed as an entry in the sitemap?

sitemapEntry : boolean

var

Type(s)

boolean

Sitemap entry priority.

sitemapPriority : string

var

Type(s)

string

Sitemap change frequency.

sitemapChangeFreq : string

var

Type(s)

string

Show properties price?

showPropertiesPrice : boolean

var

Type(s)

boolean

Properties dropdown mode.

propertiesDropdownMode : string

var

Type(s)

string

Use properties combination weight?

propertiesCombisWeight : boolean

var

Type(s)

boolean

Use properties combination quantity?

propertiesCombisQuantityCheckMode : integer

var

Type(s)

integer

Use properties combination shipping time?

propertiesCombisShippingTime : boolean

var

Type(s)

boolean

Permitted customer status.

permittedCustomerStatus : array

var

Type(s)

array

Special offer id.

specialOfferId : integer

var

Type(s)

integer

ProductSettings

Methods

Returns the details template name.

Response

Returns the graduated quantity.

Response

Returns the minimum order value.

Response

Returns the options details template.

Response

Returns the options listing template.

Response

Returns the price status.

Response

Returns the mode which is used for the quantity check.

Response

Returns the properties dropdown mode.

Response

Returns the sitemap change frequency.

Response

Returns the sitemap priority.

Response

Returns the Special offer id.

Response

Returns the sort position of the startpage.

Response

Returns true when the customer status is permitted, false otherwise.

Arguments

$customerStatusId

Response

Returns true when the product is to be displayed in the sitemap, false otherwise.

Response

Sets the details listing template.

Arguments

$template

Response

Sets the graduated quantity.

Arguments

$quantity

Response

Sets the min order value.

Arguments

$quantity

Response

Sets the options details template.

Arguments

$template

Response

Sets the options listing template.

Arguments

$template

Response

Sets customer status permissions.

Arguments

$customerStatusId

$permitted

Response

Sets the price status.

Arguments

$status

Response

Determine which mode for the quantity check should be used.

Arguments

$status

Response

Sets the properties dropdown mode.

Arguments

$mode

Response

Shows or hides the added date time of a product.

Arguments

$status

Response

Determine whether the product is to be displayed on the startpage or not.

Arguments

$status

Response

Shows or hides the price offer of a product.

Arguments

$status