ProductSettings
in package
implements
ProductSettingsInterface
Class ProductSettings
Tags
Interfaces, Classes and Traits
- ProductSettingsInterface
- Interface ProductSettingsInterface
Table of Contents
- $detailsTemplate : string
- Details template.
- $graduatedQuantity : float
- Graduated quantity.
- $minOrder : float
- Minimal order value.
- $optionsDetailsTemplate : string
- Option detail template.
- $optionsListingTemplate : string
- Options listing template.
- $permittedCustomerStatus : array<string|int, mixed>
- Permitted customer status.
- $priceStatus : int
- Price status.
- $propertiesCombisQuantityCheckMode : int
- Use properties combination quantity?
- $propertiesCombisShippingTime : bool
- Use properties combination shipping time?
- $propertiesCombisWeight : bool
- Use properties combination weight?
- $propertiesDropdownMode : string
- Properties dropdown mode.
- $showAddedDateTime : bool
- Show added time?
- $showOnStartpage : bool
- Show on start page?
- $showPriceOffer : bool
- Show price offer?
- $showPropertiesPrice : bool
- Show properties price?
- $showQuantityInfo : bool
- Show quantity info?
- $showWeight : bool
- Show weight?
- $sitemapChangeFreq : string
- Sitemap change frequency.
- $sitemapEntry : bool
- Is listed as an entry in the sitemap?
- $sitemapPriority : string
- Sitemap entry priority.
- $specialOfferId : int
- Special offer id.
- $startpageSortOrder : int
- Start page sort order.
- getDetailsTemplate() : string
- Returns the details template name.
- getGraduatedQuantity() : float
- Returns the graduated quantity.
- getMinOrder() : float
- Returns the minimum order value.
- getOptionsDetailsTemplate() : string
- Returns the options details template.
- getOptionsListingTemplate() : string
- Returns the options listing template.
- getPriceStatus() : int
- Returns the price status.
- getPropertiesCombisQuantityCheckMode() : int
- Returns the mode which is used for the quantity check.
- getPropertiesDropdownMode() : string
- Returns the properties dropdown mode.
- getSitemapChangeFreq() : string
- Returns the sitemap change frequency.
- getSitemapPriority() : string
- Returns the sitemap priority.
- getSpecialOfferId() : int
- Returns the Special offer id.
- getStartpageSortOrder() : int
- Returns the sort position of the startpage.
- isPermittedCustomerStatus() : bool
- Returns true when the customer status is permitted, false otherwise.
- isSitemapEntry() : bool
- Returns true when the product is to be displayed in the sitemap, false otherwise.
- setDetailsTemplate() : ProductSettings|$this
- Sets the details listing template.
- setGraduatedQuantity() : ProductSettings|$this
- Sets the graduated quantity.
- setMinOrder() : ProductSettings|$this
- Sets the min order value.
- setOptionsDetailsTemplate() : ProductSettings|$this
- Sets the options details template.
- setOptionsListingTemplate() : ProductSettings|$this
- Sets the options listing template.
- setPermittedCustomerStatus() : ProductSettings|$this
- Sets customer status permissions.
- setPriceStatus() : ProductSettings|$this
- Sets the price status.
- setPropertiesCombisQuantityCheckMode() : ProductSettings|$this
- Determine which mode for the quantity check should be used.
- setPropertiesDropdownMode() : ProductSettings|$this
- Sets the properties dropdown mode.
- setShowAddedDateTime() : ProductSettings|$this
- Shows or hides the added date time of a product.
- setShowOnStartpage() : ProductSettings|$this
- Determine whether the product is to be displayed on the startpage or not.
- setShowPriceOffer() : ProductSettings|$this
- Shows or hides the price offer of a product.
- setShowPropertiesPrice() : ProductSettings|$this
- Shows or hides the properties price of a product.
- setShowQuantityInfo() : ProductSettings|$this
- Shows or hides the quantity info of a product.
- setShowWeight() : ProductSettings|$this
- Shows or hides the weight of a product.
- setSitemapChangeFreq() : ProductSettings|$this
- Sets the sitemap change frequency.
- setSitemapEntry() : ProductSettings|$this
- Determine whether the product is to be displayed in the sitemap or not.
- setSitemapPriority() : ProductSettings|$this
- Sets the sitemap priority.
- setSpecialOfferId() : ProductSettingsInterface|$this
- Sets Special offer id.
- setStartpageSortOrder() : ProductSettings|$this
- Sets the start page sort order.
- setUsePropertiesCombisShippingTime() : ProductSettings|$this
- Determine whether the properties combis shipping time is to be used or not.
- setUsePropertiesCombisWeight() : ProductSettings|$this
- Determine whether the properties combis weight is to be used or not.
- showAddedDateTime() : bool
- Returns true when the added date time is to be displayed, false otherwise.
- showOnStartpage() : bool
- Returns true when the product is displayed on the start page, false otherwise.
- showPriceOffer() : bool
- Returns true when the price offer is to be displayed, false otherwise.
- showPropertiesPrice() : bool
- Returns true when the properties price is to be displayed, false otherwise.
- showQuantityInfo() : bool
- Returns true when the quantity info is to be displayed, false otherwise.
- showWeight() : bool
- Returns true when the weight is to be displayed, false otherwise.
- usePropertiesCombisShippingTime() : bool
- Returns true when the properties combis shipping time is to be used, false otherwise.
- usePropertiesCombisWeight() : bool
- Returns true when the properties combis weight is to be used, false otherwise.
Properties
$detailsTemplate
Details template.
protected
string
$detailsTemplate
= ''
$graduatedQuantity
Graduated quantity.
protected
float
$graduatedQuantity
= 0.0
$minOrder
Minimal order value.
protected
float
$minOrder
= 0.0
$optionsDetailsTemplate
Option detail template.
protected
string
$optionsDetailsTemplate
= ''
$optionsListingTemplate
Options listing template.
protected
string
$optionsListingTemplate
= ''
$permittedCustomerStatus
Permitted customer status.
protected
array<string|int, mixed>
$permittedCustomerStatus
= []
$priceStatus
Price status.
protected
int
$priceStatus
= 0
$propertiesCombisQuantityCheckMode
Use properties combination quantity?
protected
int
$propertiesCombisQuantityCheckMode
= 0
$propertiesCombisShippingTime
Use properties combination shipping time?
protected
bool
$propertiesCombisShippingTime
= alse
$propertiesCombisWeight
Use properties combination weight?
protected
bool
$propertiesCombisWeight
= alse
$propertiesDropdownMode
Properties dropdown mode.
protected
string
$propertiesDropdownMode
= ''
$showAddedDateTime
Show added time?
protected
bool
$showAddedDateTime
= alse
$showOnStartpage
Show on start page?
protected
bool
$showOnStartpage
= alse
$showPriceOffer
Show price offer?
protected
bool
$showPriceOffer
= alse
$showPropertiesPrice
Show properties price?
protected
bool
$showPropertiesPrice
= alse
$showQuantityInfo
Show quantity info?
protected
bool
$showQuantityInfo
= alse
$showWeight
Show weight?
protected
bool
$showWeight
= alse
$sitemapChangeFreq
Sitemap change frequency.
protected
string
$sitemapChangeFreq
= ''
$sitemapEntry
Is listed as an entry in the sitemap?
protected
bool
$sitemapEntry
= alse
$sitemapPriority
Sitemap entry priority.
protected
string
$sitemapPriority
= ''
$specialOfferId
Special offer id.
protected
int
$specialOfferId
= 1
$startpageSortOrder
Start page sort order.
protected
int
$startpageSortOrder
= 0
Methods
getDetailsTemplate()
Returns the details template name.
public
getDetailsTemplate() : string
Return values
string —getGraduatedQuantity()
Returns the graduated quantity.
public
getGraduatedQuantity() : float
Return values
float —getMinOrder()
Returns the minimum order value.
public
getMinOrder() : float
Return values
float —getOptionsDetailsTemplate()
Returns the options details template.
public
getOptionsDetailsTemplate() : string
Return values
string —getOptionsListingTemplate()
Returns the options listing template.
public
getOptionsListingTemplate() : string
Return values
string —getPriceStatus()
Returns the price status.
public
getPriceStatus() : int
Return values
int —getPropertiesCombisQuantityCheckMode()
Returns the mode which is used for the quantity check.
public
getPropertiesCombisQuantityCheckMode() : int
0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check
Return values
int —getPropertiesDropdownMode()
Returns the properties dropdown mode.
public
getPropertiesDropdownMode() : string
Return values
string —getSitemapChangeFreq()
Returns the sitemap change frequency.
public
getSitemapChangeFreq() : string
Return values
string —getSitemapPriority()
Returns the sitemap priority.
public
getSitemapPriority() : string
Return values
string —getSpecialOfferId()
Returns the Special offer id.
public
getSpecialOfferId() : int
Return values
int —The special offer id.
getStartpageSortOrder()
Returns the sort position of the startpage.
public
getStartpageSortOrder() : int
Return values
int —isPermittedCustomerStatus()
Returns true when the customer status is permitted, false otherwise.
public
isPermittedCustomerStatus(IdType $customerStatusId) : bool
Parameters
- $customerStatusId : IdType
-
Id of customer status.
Return values
bool —isSitemapEntry()
Returns true when the product is to be displayed in the sitemap, false otherwise.
public
isSitemapEntry() : bool
Return values
bool —setDetailsTemplate()
Sets the details listing template.
public
setDetailsTemplate(StringType $template) : ProductSettings|$this
Parameters
- $template : StringType
-
Name of the template
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setGraduatedQuantity()
Sets the graduated quantity.
public
setGraduatedQuantity(DecimalType $quantity) : ProductSettings|$this
Parameters
- $quantity : DecimalType
-
New graduated quantity.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setMinOrder()
Sets the min order value.
public
setMinOrder(DecimalType $quantity) : ProductSettings|$this
Parameters
- $quantity : DecimalType
-
New minimum order.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setOptionsDetailsTemplate()
Sets the options details template.
public
setOptionsDetailsTemplate(StringType $template) : ProductSettings|$this
Parameters
- $template : StringType
-
Name of the template.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setOptionsListingTemplate()
Sets the options listing template.
public
setOptionsListingTemplate(StringType $template) : ProductSettings|$this
Parameters
- $template : StringType
-
Name of the template.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setPermittedCustomerStatus()
Sets customer status permissions.
public
setPermittedCustomerStatus(IdType $customerStatusId, BoolType $permitted) : ProductSettings|$this
Parameters
- $customerStatusId : IdType
-
Id of customer status.
- $permitted : BoolType
-
Is customer permitted or not.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setPriceStatus()
Sets the price status.
public
setPriceStatus(IntType $status) : ProductSettings|$this
Parameters
- $status : IntType
-
New price status.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setPropertiesCombisQuantityCheckMode()
Determine which mode for the quantity check should be used.
public
setPropertiesCombisQuantityCheckMode(IntType $status) : ProductSettings|$this
0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check
Parameters
- $status : IntType
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setPropertiesDropdownMode()
Sets the properties dropdown mode.
public
setPropertiesDropdownMode(StringType $mode) : ProductSettings|$this
Parameters
- $mode : StringType
-
New properties dropdown mode.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setShowAddedDateTime()
Shows or hides the added date time of a product.
public
setShowAddedDateTime(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be displayed, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setShowOnStartpage()
Determine whether the product is to be displayed on the startpage or not.
public
setShowOnStartpage(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be displayed, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setShowPriceOffer()
Shows or hides the price offer of a product.
public
setShowPriceOffer(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be displayed, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setShowPropertiesPrice()
Shows or hides the properties price of a product.
public
setShowPropertiesPrice(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be displayed, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setShowQuantityInfo()
Shows or hides the quantity info of a product.
public
setShowQuantityInfo(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be displayed, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setShowWeight()
Shows or hides the weight of a product.
public
setShowWeight(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be displayed, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setSitemapChangeFreq()
Sets the sitemap change frequency.
public
setSitemapChangeFreq(StringType $freq) : ProductSettings|$this
Parameters
- $freq : StringType
-
New sitemap change frequency.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setSitemapEntry()
Determine whether the product is to be displayed in the sitemap or not.
public
setSitemapEntry(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be displayed, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setSitemapPriority()
Sets the sitemap priority.
public
setSitemapPriority(StringType $priority) : ProductSettings|$this
Parameters
- $priority : StringType
-
New sitemap priority.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setSpecialOfferId()
Sets Special offer id.
public
setSpecialOfferId(IdType $id) : ProductSettingsInterface|$this
Parameters
- $id : IdType
-
The special offer id.
Return values
ProductSettingsInterface|$this —Same ProductSettingsInterface instance for chained method calls.
setStartpageSortOrder()
Sets the start page sort order.
public
setStartpageSortOrder(IntType $sortOrder) : ProductSettings|$this
Parameters
- $sortOrder : IntType
-
Sort position.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setUsePropertiesCombisShippingTime()
Determine whether the properties combis shipping time is to be used or not.
public
setUsePropertiesCombisShippingTime(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be used, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
setUsePropertiesCombisWeight()
Determine whether the properties combis weight is to be used or not.
public
setUsePropertiesCombisWeight(BoolType $status) : ProductSettings|$this
Parameters
- $status : BoolType
-
True when it is to be used, false otherwise.
Return values
ProductSettings|$this —Same ProductSettings instance for chained method calls.
showAddedDateTime()
Returns true when the added date time is to be displayed, false otherwise.
public
showAddedDateTime() : bool
Return values
bool —showOnStartpage()
Returns true when the product is displayed on the start page, false otherwise.
public
showOnStartpage() : bool
Return values
bool —showPriceOffer()
Returns true when the price offer is to be displayed, false otherwise.
public
showPriceOffer() : bool
Return values
bool —showPropertiesPrice()
Returns true when the properties price is to be displayed, false otherwise.
public
showPropertiesPrice() : bool
Return values
bool —showQuantityInfo()
Returns true when the quantity info is to be displayed, false otherwise.
public
showQuantityInfo() : bool
Return values
bool —showWeight()
Returns true when the weight is to be displayed, false otherwise.
public
showWeight() : bool
Return values
bool —usePropertiesCombisShippingTime()
Returns true when the properties combis shipping time is to be used, false otherwise.
public
usePropertiesCombisShippingTime() : bool
Return values
bool —usePropertiesCombisWeight()
Returns true when the properties combis weight is to be used, false otherwise.
public
usePropertiesCombisWeight() : bool