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 string`	# `getCategoryListingTemplate( )` Returns the current category listing template. Returns the current category listing template. Returns string Implementation of `CategorySettingsInterface::getCategoryListingTemplate()`
`public CategorySettings`	# `setCategoryListingTemplate( StringType $filename )` Sets the current category listing template. Sets the current category listing template. Parameters `$filename` Category listing template. Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setCategoryListingTemplate()`
`public string`	# `getProductListingTemplate( )` Returns the current product listing template. Returns the current product listing template. Returns string Implementation of `CategorySettingsInterface::getProductListingTemplate()`
`public CategorySettings`	# `setProductListingTemplate( StringType $filename )` Sets the current product listing template. Sets the current product listing template. Parameters `$filename` Product listing template. Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setProductListingTemplate()`
`public string`	# `getProductSortColumn( )` Returns the column by which the products are currently sorted. Returns the column by which the products are currently sorted. Returns string Implementation of `CategorySettingsInterface::getProductSortColumn()`
`public CategorySettings`	# `setProductSortColumn( StringType $column )` Sets the column by which the products are currently sorted. 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 string`	# `getProductSortDirection( )` Returns the direction which the products are currently sorted in. Returns the direction which the products are currently sorted in. Returns string Implementation of `CategorySettingsInterface::getProductSortDirection()`
`public CategorySettings`	# `setProductSortDirection( StringType $direction )` Sets the direction which the products are currently sorted in. 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 boolean`	# `isSitemapEntry( )` Checks if category/product is part of the sitemap. Checks if category/product is part of the sitemap. Returns boolean Implementation of `CategorySettingsInterface::isSitemapEntry()`
`public CategorySettings`	# `setSitemapEntry( BoolType $status )` Sets whether the category/product is part of the sitemap. 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 string`	# `getSitemapPriority( )` Returns the sitemap priority of the element. Returns the sitemap priority of the element. Returns string Implementation of `CategorySettingsInterface::getSitemapPriority()`
`public CategorySettings`	# `setSitemapPriority( StringType $priority )` Sets the sitemap priority of the element. Sets the sitemap priority of the element. Parameters `$priority` Element's sitemap priority. Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setSitemapPriority()`
`public string`	# `getSitemapChangeFreq( )` Returns the change frequency of the element. Returns the change frequency of the element. Returns string Implementation of `CategorySettingsInterface::getSitemapChangeFreq()`
`public CategorySettings`	# `setSitemapChangeFreq( StringType $freq )` Sets the change frequency of the element. Sets the change frequency of the element. Parameters `$freq` Change frequency value. Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setSitemapChangeFreq()`
`public boolean`	# `showAttributes( )` Checks if attributes should be displayed or not. Checks if attributes should be displayed or not. Returns boolean Implementation of `CategorySettingsInterface::showAttributes()`
`public CategorySettings`	# `setShowAttributes( BoolType $status )` Sets whether the attributes should be displayed or not. 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 boolean`	# `showGraduatedPrices( )` Checks if graduated prices should be displayed or not. Checks if graduated prices should be displayed or not. Returns boolean Implementation of `CategorySettingsInterface::showGraduatedPrices()`
`public CategorySettings`	# `setShowGraduatedPrices( BoolType $status )` Sets whether graduated prices should be displayed or not. Sets whether graduated prices should be displayed or not. Parameters `$status` Show graduated prices? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowGraduatedPrices()`
`public boolean`	# `showQuantityInput( )` Checks if a quantity input should be displayed in product forms or not. Checks if a quantity input should be displayed in product forms or not. Returns boolean Implementation of `CategorySettingsInterface::showQuantityInput()`
`public CategorySettings`	# `setShowQuantityInput( BoolType $status )` Sets whether a quantity input should be displayed in product forms or not. Sets whether a quantity input should be displayed in product forms or not. Parameters `$status` Show quantity input? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowQuantityInput()`
`public boolean`	# `showStock( )` Checks if the stock should be displayed or not. Checks if the stock should be displayed or not. Returns boolean Implementation of `CategorySettingsInterface::showStock()`
`public CategorySettings`	# `setShowStock( BoolType $status )` Sets whether the stock should be displayed or not. Sets whether the stock should be displayed or not. Parameters `$status` Show quantity info? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowStock()`
`public boolean`	# `showSubcategories( )` Checks if subcategories should be displayed or not. Checks if subcategories should be displayed or not. Returns boolean Implementation of `CategorySettingsInterface::showSubcategories()`
`public CategorySettings`	# `setShowSubcategories( BoolType $status )` Sets whether subcategories should be displayed or not. Sets whether subcategories should be displayed or not. Parameters `$status` Show subcategories? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowSubcategories()`
`public boolean`	# `showSubcategoryImages( )` Checks if subcategory images should be displayed or not. Checks if subcategory images should be displayed or not. Returns boolean Implementation of `CategorySettingsInterface::showSubcategoryImages()`
`public CategorySettings`	# `setShowSubcategoryImages( BoolType $status )` Sets whether subcategory images should be displayed or not. Sets whether subcategory images should be displayed or not. Parameters `$status` Show subcategory images? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowSubcategoryImages()`
`public boolean`	# `showSubcategoryNames( )` Checks if subcategory names should be displayed or not. Checks if subcategory names should be displayed or not. Returns boolean Implementation of `CategorySettingsInterface::showSubcategoryNames()`
`public CategorySettings`	# `setShowSubcategoryNames( BoolType $status )` Sets whether subcategory names should be displayed or not. Sets whether subcategory names should be displayed or not. Parameters `$status` Show subcategory names? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowSubcategoryNames()`
`public boolean`	# `showSubcategoryProducts( )` Checks if subcategory products should be displayed or not. Checks if subcategory products should be displayed or not. Returns boolean Implementation of `CategorySettingsInterface::showSubcategoryProducts()`
`public CategorySettings`	# `setShowSubcategoryProducts( BoolType $status )` Sets whether subcategory products should be displayed or not. Sets whether subcategory products should be displayed or not. Parameters `$status` Show subcategory products? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowSubcategoryProducts()`
`public boolean`	# `isDefaultViewModeTiled( )` Checks if default view mode should be tiled or not. Checks if default view mode should be tiled or not. Returns boolean Implementation of `CategorySettingsInterface::isDefaultViewModeTiled()`
`public CategorySettings`	# `setDefaultViewModeTiled( BoolType $status )` Sets whether default view mode should be tiled or not. Sets whether default view mode should be tiled or not. Parameters `$status` Is tiled the default view mode? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setDefaultViewModeTiled()`
`public boolean`	# `isPermittedCustomerStatus( IdType $customerStatusId )` Checks if it is a permitted customer status or not. Checks if it is a permitted customer status or not. Parameters `$customerStatusId` Customer status ID. Returns boolean Implementation of `CategorySettingsInterface::isPermittedCustomerStatus()`
`public CategorySettings`	# `setPermittedCustomerStatus( IdType $customerStatusId, BoolType $permitted )` Sets whether a customer status is permitted or not. Sets whether a customer status is permitted or not. Parameters `$customerStatusId` Customer status ID. `$permitted` Is permitted? Returns `CategorySettings` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setPermittedCustomerStatus()`
`public Category`	# `setShowCategoryFilter( BoolType $showCategoryFilter )` Sets the show category filter value. Sets the show category filter value. Parameters `$showCategoryFilter` Returns `Category` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setShowCategoryFilter()`
`public boolean`	# `showCategoryFilter( )` Gets the show category filter value. Gets the show category filter value. Returns boolean Implementation of `CategorySettingsInterface::showCategoryFilter()`
`public Category`	# `setFilterSelectionMode( IntType $filterSelectionMode )` Sets the filter selection mode value. Sets the filter selection mode value. Parameters `$filterSelectionMode` Returns `Category` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setFilterSelectionMode()`
`public integer`	# `getFilterSelectionMode( )` Gets the filter selection mode value. Gets the filter selection mode value. Returns integer Implementation of `CategorySettingsInterface::getFilterSelectionMode()`
`public Category`	# `setFilterValueDeactivation( IntType $filterValueDeactivation )` Sets the filter value deactivation. Sets the filter value deactivation. Parameters `$filterValueDeactivation` Returns `Category` Same instance for chained method calls. Implementation of `CategorySettingsInterface::setFilterValueDeactivation()`
`public integer`	# `getFilterValueDeactivation( )` Gets the filter value deactivation. Gets the filter value deactivation. Returns integer Implementation of `CategorySettingsInterface::getFilterValueDeactivation()`

Properties summary

`protected string`	`$categoryListingTemplate` Current template which is used for category listing. Current template which is used for category listing.	# `''`
`protected string`	`$productListingTemplate` Current template which is used for product listing. Current template which is used for product listing.	# `''`
`protected string`	`$productSortColumn` Current column by which the products are sorted. Current column by which the products are sorted.	# `''`
`protected string`	`$productSortDirection` Current direction which the products are sorted in. Current direction which the products are sorted in.	# `''`
`protected boolean`	`$sitemapEntry` Is category/product in the sitemap? Is category/product in the sitemap?	# `false`
`protected string`	`$sitemapPriority` Priority of the element in the sitemap. Priority of the element in the sitemap.	# `''`
`protected string`	`$sitemapChangeFreq` Change frequency of the element in the sitemap. Change frequency of the element in the sitemap.	# `''`
`protected boolean`	`$attributes` Should attributes be displayed? Should attributes be displayed?	# `false`
`protected boolean`	`$graduatedPrices` Should graduated prices be displayed? Should graduated prices be displayed?	# `false`
`protected boolean`	`$quantityInput` Should quantities be displayed? Should quantities be displayed?	# `false`
`protected boolean`	`$stock` Should quantity info be displayed? Should quantity info be displayed?	# `false`
`protected boolean`	`$subcategories` Should subcategories be displayed? Should subcategories be displayed?	# `false`
`protected boolean`	`$subcategoryImages` Should subcategory images be displayed? Should subcategory images be displayed?	# `false`
`protected boolean`	`$subcategoryNames` Should subcategory names be displayed? Should subcategory names be displayed?	# `false`
`protected boolean`	`$subcategoryProducts` Should subcategory products be displayed? Should subcategory products be displayed?	# `false`
`protected boolean`	`$viewModeTiled` Should default view mode be "tiled"? Should default view mode be "tiled"?	# `false`
`protected array`	`$permittedCustomerStatus` Array of permitted customer status. Array of permitted customer status.	# `array()`
`protected boolean`	`$showCategoryFilter`	# `false`
`protected integer`	`$filterSelectionMode`	# `0`
`protected integer`	`$filterValueDeactivation`	# `0`

Packages

Classes

Class CategorySettings

Methods summary

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns