Class ProductSettings

ProductSettings implements ProductSettingsInterface

Package: Product\Entities
Category: System
Located at Services/Core/Product/Entities/ProductSettings.inc.php

Methods summary

`public string`	# `getDetailsTemplate( )` Returns the details template name. Returns the details template name. Returns string Implementation of `ProductSettingsInterface::getDetailsTemplate()`
`public string`	# `getOptionsDetailsTemplate( )` Returns the options details template. Returns the options details template. Returns string Implementation of `ProductSettingsInterface::getOptionsDetailsTemplate()`
`public string`	# `getOptionsListingTemplate( )` Returns the options listing template. Returns the options listing template. Returns string Implementation of `ProductSettingsInterface::getOptionsListingTemplate()`
`public boolean`	# `showOnStartpage( )` Returns true when the product is displayed on the start page, false otherwise. Returns true when the product is displayed on the start page, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::showOnStartpage()`
`public integer`	# `getStartpageSortOrder( )` Returns the sort position of the startpage. Returns the sort position of the startpage. Returns integer Implementation of `ProductSettingsInterface::getStartpageSortOrder()`
`public boolean`	# `showAddedDateTime( )` Returns true when the added date time is to be displayed, false otherwise. Returns true when the added date time is to be displayed, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::showAddedDateTime()`
`public boolean`	# `showQuantityInfo( )` Returns true when the quantity info is to be displayed, false otherwise. Returns true when the quantity info is to be displayed, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::showQuantityInfo()`
`public boolean`	# `showWeight( )` Returns true when the weight is to be displayed, false otherwise. Returns true when the weight is to be displayed, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::showWeight()`
`public boolean`	# `showPriceOffer( )` Returns true when the price offer is to be displayed, false otherwise. Returns true when the price offer is to be displayed, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::showPriceOffer()`
`public integer`	# `getPriceStatus( )` Returns the price status. Returns the price status. Returns integer Implementation of `ProductSettingsInterface::getPriceStatus()`
`public float`	# `getMinOrder( )` Returns the minimum order value. Returns the minimum order value. Returns float Implementation of `ProductSettingsInterface::getMinOrder()`
`public float`	# `getGraduatedQuantity( )` Returns the graduated quantity. Returns the graduated quantity. Returns float Implementation of `ProductSettingsInterface::getGraduatedQuantity()`
`public boolean`	# `isSitemapEntry( )` Returns true when the product is to be displayed in the sitemap, false otherwise. Returns true when the product is to be displayed in the sitemap, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::isSitemapEntry()`
`public string`	# `getSitemapPriority( )` Returns the sitemap priority. Returns the sitemap priority. Returns string Implementation of `ProductSettingsInterface::getSitemapPriority()`
`public string`	# `getSitemapChangeFreq( )` Returns the sitemap change frequency. Returns the sitemap change frequency. Returns string Implementation of `ProductSettingsInterface::getSitemapChangeFreq()`
`public boolean`	# `showPropertiesPrice( )` Returns true when the properties price is to be displayed, false otherwise. Returns true when the properties price is to be displayed, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::showPropertiesPrice()`
`public string`	# `getPropertiesDropdownMode( )` Returns the properties dropdown mode. Returns the properties dropdown mode. Returns string Implementation of `ProductSettingsInterface::getPropertiesDropdownMode()`
`public boolean`	# `usePropertiesCombisWeight( )` Returns true when the properties combis weight is to be used, false otherwise. Returns true when the properties combis weight is to be used, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::usePropertiesCombisWeight()`
`public integer`	# `getPropertiesCombisQuantityCheckMode( )` Returns the mode which is used for the quantity check. Returns the mode which is used for the quantity check. 0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check Returns integer Implementation of `ProductSettingsInterface::getPropertiesCombisQuantityCheckMode()`
`public boolean`	# `usePropertiesCombisShippingTime( )` Returns true when the properties combis shipping time is to be used, false otherwise. Returns true when the properties combis shipping time is to be used, false otherwise. Returns boolean Implementation of `ProductSettingsInterface::usePropertiesCombisShippingTime()`
`public ProductSettings\|ProductSettings`	# `setDetailsTemplate( StringType $template )` Sets the details listing template. Sets the details listing template. Parameters `$template` Name of the template Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setDetailsTemplate()`
`public ProductSettings\|ProductSettings`	# `setOptionsDetailsTemplate( StringType $template )` Sets the options details template. Sets the options details template. Parameters `$template` Name of the template. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setOptionsDetailsTemplate()`
`public ProductSettings\|ProductSettings`	# `setOptionsListingTemplate( StringType $template )` Sets the options listing template. Sets the options listing template. Parameters `$template` Name of the template. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setOptionsListingTemplate()`
`public ProductSettings\|ProductSettings`	# `setShowOnStartpage( BoolType $status )` Determine whether the product is to be displayed on the startpage or not. Determine whether the product is to be displayed on the startpage or not. Parameters `$status` True when it is to be displayed, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setShowOnStartpage()`
`public ProductSettings\|ProductSettings`	# `setStartpageSortOrder( IntType $sortOrder )` Sets the start page sort order. Sets the start page sort order. Parameters `$sortOrder` Sort position. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setStartpageSortOrder()`
`public ProductSettings\|ProductSettings`	# `setShowAddedDateTime( BoolType $status )` Shows or hides the added date time of a product. Shows or hides the added date time of a product. Parameters `$status` True when it is to be displayed, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setShowAddedDateTime()`
`public ProductSettings\|ProductSettings`	# `setShowQuantityInfo( BoolType $status )` Shows or hides the quantity info of a product. Shows or hides the quantity info of a product. Parameters `$status` True when it is to be displayed, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setShowQuantityInfo()`
`public ProductSettings\|ProductSettings`	# `setShowWeight( BoolType $status )` Shows or hides the weight of a product. Shows or hides the weight of a product. Parameters `$status` True when it is to be displayed, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setShowWeight()`
`public ProductSettings\|ProductSettings`	# `setShowPriceOffer( BoolType $status )` Shows or hides the price offer of a product. Shows or hides the price offer of a product. Parameters `$status` True when it is to be displayed, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setShowPriceOffer()`
`public ProductSettings\|ProductSettings`	# `setPriceStatus( IntType $status )` Sets the price status. Sets the price status. Parameters `$status` New price status. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setPriceStatus()`
`public ProductSettings\|ProductSettings`	# `setMinOrder( DecimalType $quantity )` Sets the min order value. Sets the min order value. Parameters `$quantity` New minimum order. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setMinOrder()`
`public ProductSettings\|ProductSettings`	# `setGraduatedQuantity( DecimalType $quantity )` Sets the graduated quantity. Sets the graduated quantity. Parameters `$quantity` New graduated quantity. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setGraduatedQuantity()`
`public ProductSettings\|ProductSettings`	# `setSitemapEntry( BoolType $status )` Determine whether the product is to be displayed in the sitemap or not. Determine whether the product is to be displayed in the sitemap or not. Parameters `$status` True when it is to be displayed, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setSitemapEntry()`
`public ProductSettings\|ProductSettings`	# `setSitemapPriority( StringType $priority )` Sets the sitemap priority. Sets the sitemap priority. Parameters `$priority` New sitemap priority. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setSitemapPriority()`
`public ProductSettings\|ProductSettings`	# `setSitemapChangeFreq( StringType $freq )` Sets the sitemap change frequency. Sets the sitemap change frequency. Parameters `$freq` New sitemap change frequency. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setSitemapChangeFreq()`
`public ProductSettings\|ProductSettings`	# `setShowPropertiesPrice( BoolType $status )` Shows or hides the properties price of a product. Shows or hides the properties price of a product. Parameters `$status` True when it is to be displayed, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setShowPropertiesPrice()`
`public ProductSettings\|ProductSettings`	# `setPropertiesDropdownMode( StringType $mode )` Sets the properties dropdown mode. Sets the properties dropdown mode. Parameters `$mode` New properties dropdown mode. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setPropertiesDropdownMode()`
`public ProductSettings\|ProductSettings`	# `setUsePropertiesCombisWeight( BoolType $status )` Determine whether the properties combis weight is to be used or not. Determine whether the properties combis weight is to be used or not. Parameters `$status` True when it is to be used, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setUsePropertiesCombisWeight()`
`public ProductSettings\|ProductSettings`	# `setPropertiesCombisQuantityCheckMode( IntType $status )` Determine which mode for the quantity check should be used. Determine which mode for the quantity check should be used. 0 = Default (global stock options) 1 = Products quantity 2 = Combis quantity 3 = No check Parameters `$status` Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setPropertiesCombisQuantityCheckMode()`
`public ProductSettings\|ProductSettings`	# `setUsePropertiesCombisShippingTime( BoolType $status )` Determine whether the properties combis shipping time is to be used or not. Determine whether the properties combis shipping time is to be used or not. Parameters `$status` True when it is to be used, false otherwise. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setUsePropertiesCombisShippingTime()`
`public boolean`	# `isPermittedCustomerStatus( IdType $customerStatusId )` Returns true when the customer status is permitted, false otherwise. Returns true when the customer status is permitted, false otherwise. Parameters `$customerStatusId` Id of customer status. Returns boolean Implementation of `ProductSettingsInterface::isPermittedCustomerStatus()`
`public ProductSettings\|ProductSettings`	# `setPermittedCustomerStatus( IdType $customerStatusId, BoolType $permitted )` Sets customer status permissions. Sets customer status permissions. Parameters `$customerStatusId` Id of customer status. `$permitted` Is customer permitted or not. Returns `ProductSettings`\|`ProductSettings` $this Same ProductSettings instance for chained method calls. Implementation of `ProductSettingsInterface::setPermittedCustomerStatus()`

Properties summary

`protected string`	`$detailsTemplate` Details template. Details template.	# `''`
`protected string`	`$optionsDetailsTemplate` Option detail template. Option detail template.	# `''`
`protected string`	`$optionsListingTemplate` Options listing template. Options listing template.	# `''`
`protected boolean`	`$showOnStartpage` Show on start page? Show on start page?	# `false`
`protected integer`	`$startpageSortOrder` Start page sort order. Start page sort order.	# `0`
`protected boolean`	`$showAddedDateTime` Show added time? Show added time?	# `false`
`protected boolean`	`$showQuantityInfo` Show quantity info? Show quantity info?	# `false`
`protected boolean`	`$showWeight` Show weight? Show weight?	# `false`
`protected boolean`	`$showPriceOffer` Show price offer? Show price offer?	# `false`
`protected integer`	`$priceStatus` Price status. Price status.	# `0`
`protected float`	`$minOrder` Minimal order value. Minimal order value.	# `0.0`
`protected float`	`$graduatedQuantity` Graduated quantity. Graduated quantity.	# `0.0`
`protected boolean`	`$sitemapEntry` Is listed as an entry in the sitemap? Is listed as an entry in the sitemap?	# `false`
`protected string`	`$sitemapPriority` Sitemap entry priority. Sitemap entry priority.	# `''`
`protected string`	`$sitemapChangeFreq` Sitemap change frequency. Sitemap change frequency.	# `''`
`protected boolean`	`$showPropertiesPrice` Show properties price? Show properties price?	# `false`
`protected string`	`$propertiesDropdownMode` Properties dropdown mode. Properties dropdown mode.	# `''`
`protected boolean`	`$propertiesCombisWeight` Use properties combination weight? Use properties combination weight?	# `false`
`protected integer`	`$propertiesCombisQuantityCheckMode` Use properties combination quantity? Use properties combination quantity?	# `0`
`protected boolean`	`$propertiesCombisShippingTime` Use properties combination shipping time? Use properties combination shipping time?	# `false`
`protected array`	`$permittedCustomerStatus` Permitted customer status. Permitted customer status.	# `array()`

Packages

Classes

Class ProductSettings

Methods summary

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of