Class CategorySettings

This Class stores some settings regarding display and visibility mode of category related data and is used within a CategoryInterface.

CategorySettings implements CategorySettingsInterface

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

Methods summary


				
				 public 
				
				

				getCategoryListingTemplate( void )
				

				: string

Returns the current category listing template.


				
				 public 
				
				

				setCategoryListingTemplate( StringType $filename )
				

				: CategorySettings

Sets the current category listing template.


				
				 public 
				
				

				getProductListingTemplate( void )
				

				: string

Returns the current product listing template.


				
				 public 
				
				

				setProductListingTemplate( StringType $filename )
				

				: CategorySettings

Sets the current product listing template.


				
				 public 
				
				

				getProductSortColumn( void )
				

				: string

Returns the column by which the products are currently sorted.


				
				 public 
				
				

				setProductSortColumn( StringType $column )
				

				: CategorySettings

Sets the column by which the products are currently sorted.

Parameters

$column: Column by which the products should be sorted.

Returns

CategorySettings
Same instance for chained method calls.

Implementation of

CategorySettingsInterface::setProductSortColumn()


				
				 public 
				
				

				getProductSortDirection( void )
				

				: string

Returns the direction which the products are currently sorted in.


				
				 public 
				
				

				setProductSortDirection( StringType $direction )
				

				: CategorySettings

Sets the direction which the products are currently sorted in.

Parameters

$direction: Direction which the products should be sorted in.

Returns

CategorySettings
Same instance for chained method calls.

Implementation of

CategorySettingsInterface::setProductSortDirection()


				
				 public 
				
				

				isSitemapEntry( void )
				

				: boolean

Checks if category/product is part of the sitemap.


				
				 public 
				
				

				setSitemapEntry( BoolType $status )
				

				: CategorySettings

Sets whether the category/product is part of the sitemap.

Parameters

$status: Value whether the category/product is part of the sitemap.

Returns

CategorySettings
Same instance for chained method calls.

Implementation of

CategorySettingsInterface::setSitemapEntry()


				
				 public 
				
				

				getSitemapPriority( void )
				

				: string

Returns the sitemap priority of the element.


				
				 public 
				
				

				setSitemapPriority( StringType $priority )
				

				: CategorySettings

Sets the sitemap priority of the element.


				
				 public 
				
				

				getSitemapChangeFreq( void )
				

				: string

Returns the change frequency of the element.


				
				 public 
				
				

				setSitemapChangeFreq( StringType $freq )
				

				: CategorySettings

Sets the change frequency of the element.


				
				 public 
				
				

				showAttributes( void )
				

				: boolean

Checks if attributes should be displayed or not.


				
				 public 
				
				

				setShowAttributes( BoolType $status )
				

				: CategorySettings

Sets whether the attributes should be displayed or not.

Parameters

$status: Should attributes be displayed?

Returns

CategorySettings
Same instance for chained method calls.

Implementation of

CategorySettingsInterface::setShowAttributes()


				
				 public 
				
				

				showGraduatedPrices( void )
				

				: boolean

Checks if graduated prices should be displayed or not.


				
				 public 
				
				

				setShowGraduatedPrices( BoolType $status )
				

				: CategorySettings

Sets whether graduated prices should be displayed or not.


				
				 public 
				
				

				showQuantityInput( void )
				

				: boolean

Checks if a quantity input should be displayed in product forms or not.


				
				 public 
				
				

				setShowQuantityInput( BoolType $status )
				

				: CategorySettings

Sets whether a quantity input should be displayed in product forms or not.


				
				 public 
				
				

				showStock( void )
				

				: boolean

Checks if the stock should be displayed or not.


				
				 public 
				
				

				setShowStock( BoolType $status )
				

				: CategorySettings

Sets whether the stock should be displayed or not.


				
				 public 
				
				

				showSubcategories( void )
				

				: boolean

Checks if subcategories should be displayed or not.


				
				 public 
				
				

				setShowSubcategories( BoolType $status )
				

				: CategorySettings

Sets whether subcategories should be displayed or not.


				
				 public 
				
				

				showSubcategoryImages( void )
				

				: boolean

Checks if subcategory images should be displayed or not.


				
				 public 
				
				

				setShowSubcategoryImages( BoolType $status )
				

				: CategorySettings

Sets whether subcategory images should be displayed or not.


				
				 public 
				
				

				showSubcategoryNames( void )
				

				: boolean

Checks if subcategory names should be displayed or not.


				
				 public 
				
				

				setShowSubcategoryNames( BoolType $status )
				

				: CategorySettings

Sets whether subcategory names should be displayed or not.


				
				 public 
				
				

				showSubcategoryProducts( void )
				

				: boolean

Checks if subcategory products should be displayed or not.


				
				 public 
				
				

				setShowSubcategoryProducts( BoolType $status )
				

				: CategorySettings

Sets whether subcategory products should be displayed or not.


				
				 public 
				
				

				isDefaultViewModeTiled( void )
				

				: boolean

Checks if default view mode should be tiled or not.


				
				 public 
				
				

				setDefaultViewModeTiled( BoolType $status )
				

				: CategorySettings

Sets whether default view mode should be tiled or not.


				
				 public 
				
				

				isPermittedCustomerStatus( IdType $customerStatusId )
				

				: boolean

Checks if it is a permitted customer status or not.


				
				 public 
				
				

				setPermittedCustomerStatus( IdType $customerStatusId, BoolType $permitted )
				

				: CategorySettings

Sets whether a customer status is permitted or not.


				
				 public 
				
				

				setShowCategoryFilter( BoolType $showCategoryFilter )
				

				: Category

Sets the show category filter value.


				
				 public 
				
				

				showCategoryFilter( void )
				

				: boolean

Gets the show category filter value.


				
				 public 
				
				

				setFilterSelectionMode( IntType $filterSelectionMode )
				

				: Category

Sets the filter selection mode value.


				
				 public 
				
				

				getFilterSelectionMode( void )
				

				: integer

Gets the filter selection mode value.


				
				 public 
				
				

				setFilterValueDeactivation( IntType $filterValueDeactivation )
				

				: Category

Sets the filter value deactivation.


				
				 public 
				
				

				getFilterValueDeactivation( void )
				

				: integer

Gets the filter value deactivation.

Properties summary


				
				protected  
				

				
					$categoryListingTemplate
				

				: string

Current template which is used for category listing.

''


				
				protected  
				

				
					$productListingTemplate
				

				: string

Current template which is used for product listing.

''


				
				protected  
				

				
					$productSortColumn
				

				: string

Current column by which the products are sorted.

''


				
				protected  
				

				
					$productSortDirection
				

				: string

Current direction which the products are sorted in.

''


				
				protected  
				

				
					$sitemapEntry
				

				: boolean

Is category/product in the sitemap?

false


				
				protected  
				

				
					$sitemapPriority
				

				: string

Priority of the element in the sitemap.

''


				
				protected  
				

				
					$sitemapChangeFreq
				

				: string

Change frequency of the element in the sitemap.

''


				
				protected  
				

				
					$attributes
				

				: boolean

Should attributes be displayed?

false


				
				protected  
				

				
					$graduatedPrices
				

				: boolean

Should graduated prices be displayed?

false


				
				protected  
				

				
					$quantityInput
				

				: boolean

Should quantities be displayed?

false


				
				protected  
				

				
					$stock
				

				: boolean

Should quantity info be displayed?

false


				
				protected  
				

				
					$subcategories
				

				: boolean

Should subcategories be displayed?

false


				
				protected  
				

				
					$subcategoryImages
				

				: boolean

Should subcategory images be displayed?

false


				
				protected  
				

				
					$subcategoryNames
				

				: boolean

Should subcategory names be displayed?

false


				
				protected  
				

				
					$subcategoryProducts
				

				: boolean

Should subcategory products be displayed?

false


				
				protected  
				

				
					$viewModeTiled
				

				: boolean

Should default view mode be "tiled"?

false


				
				protected  
				

				
					$permittedCustomerStatus
				

				: array

Array of permitted customer status.

array()


				
				protected  
				

				
					$showCategoryFilter
				

				: boolean

false


				
				protected  
				

				
					$filterSelectionMode
				

				: integer


				
				protected  
				

				
					$filterValueDeactivation
				

				: integer