Class ProductSettings

ProductSettings implements ProductSettingsInterface

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

Methods summary


				
				 public 
				
				

				getDetailsTemplate( void )
				

				: string

Returns the details template name.


				
				 public 
				
				

				getOptionsDetailsTemplate( void )
				

				: string

Returns the options details template.


				
				 public 
				
				

				getOptionsListingTemplate( void )
				

				: string

Returns the options listing template.


				
				 public 
				
				

				showOnStartpage( void )
				

				: boolean

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


				
				 public 
				
				

				getStartpageSortOrder( void )
				

				: integer

Returns the sort position of the startpage.


				
				 public 
				
				

				showAddedDateTime( void )
				

				: boolean

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


				
				 public 
				
				

				showQuantityInfo( void )
				

				: boolean

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


				
				 public 
				
				

				showWeight( void )
				

				: boolean

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


				
				 public 
				
				

				showPriceOffer( void )
				

				: boolean

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


				
				 public 
				
				

				getPriceStatus( void )
				

				: integer

Returns the price status.


				
				 public 
				
				

				getMinOrder( void )
				

				: float

Returns the minimum order value.


				
				 public 
				
				

				getGraduatedQuantity( void )
				

				: float

Returns the graduated quantity.


				
				 public 
				
				

				isSitemapEntry( void )
				

				: boolean

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


				
				 public 
				
				

				getSitemapPriority( void )
				

				: string

Returns the sitemap priority.


				
				 public 
				
				

				getSitemapChangeFreq( void )
				

				: string

Returns the sitemap change frequency.


				
				 public 
				
				

				showPropertiesPrice( void )
				

				: boolean

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


				
				 public 
				
				

				getPropertiesDropdownMode( void )
				

				: string

Returns the properties dropdown mode.


				
				 public 
				
				

				usePropertiesCombisWeight( void )
				

				: boolean

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


				
				 public 
				
				

				getPropertiesCombisQuantityCheckMode( void )
				

				: integer

Returns the mode which is used for the quantity check.


				
				 public 
				
				

				usePropertiesCombisShippingTime( void )
				

				: boolean

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


				
				 public 
				
				

				setDetailsTemplate( StringType $template )
				

				: ProductSettings|ProductSettings

Sets the details listing template.


				
				 public 
				
				

				setOptionsDetailsTemplate( StringType $template )
				

				: ProductSettings|ProductSettings

Sets the options details template.


				
				 public 
				
				

				setOptionsListingTemplate( StringType $template )
				

				: ProductSettings|ProductSettings

Sets the options listing template.


				
				 public 
				
				

				setShowOnStartpage( BoolType $status )
				

				: ProductSettings|ProductSettings

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 
				
				

				setStartpageSortOrder( IntType $sortOrder )
				

				: ProductSettings|ProductSettings

Sets the start page sort order.


				
				 public 
				
				

				setShowAddedDateTime( BoolType $status )
				

				: ProductSettings|ProductSettings

Shows or hides the added date time of a product.


				
				 public 
				
				

				setShowQuantityInfo( BoolType $status )
				

				: ProductSettings|ProductSettings

Shows or hides the quantity info of a product.


				
				 public 
				
				

				setShowWeight( BoolType $status )
				

				: ProductSettings|ProductSettings

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 
				
				

				setShowPriceOffer( BoolType $status )
				

				: ProductSettings|ProductSettings

Shows or hides the price offer of a product.


				
				 public 
				
				

				setPriceStatus( IntType $status )
				

				: ProductSettings|ProductSettings

Sets the price status.


				
				 public 
				
				

				setMinOrder( DecimalType $quantity )
				

				: ProductSettings|ProductSettings

Sets the min order value.


				
				 public 
				
				

				setGraduatedQuantity( DecimalType $quantity )
				

				: ProductSettings|ProductSettings

Sets the graduated quantity.


				
				 public 
				
				

				setSitemapEntry( BoolType $status )
				

				: ProductSettings|ProductSettings

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 
				
				

				setSitemapPriority( StringType $priority )
				

				: ProductSettings|ProductSettings

Sets the sitemap priority.


				
				 public 
				
				

				setSitemapChangeFreq( StringType $freq )
				

				: ProductSettings|ProductSettings

Sets the sitemap change frequency.


				
				 public 
				
				

				setShowPropertiesPrice( BoolType $status )
				

				: ProductSettings|ProductSettings

Shows or hides the properties price of a product.


				
				 public 
				
				

				setPropertiesDropdownMode( StringType $mode )
				

				: ProductSettings|ProductSettings

Sets the properties dropdown mode.


				
				 public 
				
				

				setUsePropertiesCombisWeight( BoolType $status )
				

				: ProductSettings|ProductSettings

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


				
				 public 
				
				

				setPropertiesCombisQuantityCheckMode( IntType $status )
				

				: ProductSettings|ProductSettings

Determine which mode for the quantity check should be used.


				
				 public 
				
				

				setUsePropertiesCombisShippingTime( BoolType $status )
				

				: ProductSettings|ProductSettings

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


				
				 public 
				
				

				isPermittedCustomerStatus( IdType $customerStatusId )
				

				: boolean

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


				
				 public 
				
				

				setPermittedCustomerStatus( IdType $customerStatusId, BoolType $permitted )
				

				: ProductSettings|ProductSettings

Sets customer status permissions.

Properties summary


				
				protected  
				

				
					$detailsTemplate
				

				: string

Details template.

''


				
				protected  
				

				
					$optionsDetailsTemplate
				

				: string

Option detail template.

''


				
				protected  
				

				
					$optionsListingTemplate
				

				: string

Options listing template.

''


				
				protected  
				

				
					$showOnStartpage
				

				: boolean

Show on start page?

false


				
				protected  
				

				
					$startpageSortOrder
				

				: integer

Start page sort order.


				
				protected  
				

				
					$showAddedDateTime
				

				: boolean

Show added time?

false


				
				protected  
				

				
					$showQuantityInfo
				

				: boolean

Show quantity info?

false


				
				protected  
				

				
					$showWeight
				

				: boolean

Show weight?

false


				
				protected  
				

				
					$showPriceOffer
				

				: boolean

Show price offer?

false


				
				protected  
				

				
					$priceStatus
				

				: integer

Price status.


				
				protected  
				

				
					$minOrder
				

				: float

Minimal order value.

0.0


				
				protected  
				

				
					$graduatedQuantity
				

				: float

Graduated quantity.

0.0


				
				protected  
				

				
					$sitemapEntry
				

				: boolean

Is listed as an entry in the sitemap?

false


				
				protected  
				

				
					$sitemapPriority
				

				: string

Sitemap entry priority.

''


				
				protected  
				

				
					$sitemapChangeFreq
				

				: string

Sitemap change frequency.

''


				
				protected  
				

				
					$showPropertiesPrice
				

				: boolean

Show properties price?

false


				
				protected  
				

				
					$propertiesDropdownMode
				

				: string

Properties dropdown mode.

''


				
				protected  
				

				
					$propertiesCombisWeight
				

				: boolean

Use properties combination weight?

false


				
				protected  
				

				
					$propertiesCombisQuantityCheckMode
				

				: integer

Use properties combination quantity?


				
				protected  
				

				
					$propertiesCombisShippingTime
				

				: boolean

Use properties combination shipping time?

false


				
				protected  
				

				
					$permittedCustomerStatus
				

				: array

Permitted customer status.

array()