API Documentation
Back to top  

CategorySettings

Implements \CategorySettingsInterface

Class CategorySettings

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

category

System
package

Category
subpackage

Entities

Methods

Returns the current category listing template.

getCategoryListingTemplate() : string

Response

string

Gets the filter selection mode value.

getFilterSelectionMode() : integer

Response

integer

Gets the filter value deactivation.

getFilterValueDeactivation() : integer

Response

integer

Returns the current product listing template.

getProductListingTemplate() : string

Response

string

Returns the column by which the products are currently sorted.

getProductSortColumn() : string

Response

string

Returns the direction which the products are currently sorted in.

getProductSortDirection() : string

Response

string

Returns the change frequency of the element.

getSitemapChangeFreq() : string

Response

string

Returns the sitemap priority of the element.

getSitemapPriority() : string

Response

string

Checks if default view mode should be tiled or not.

isDefaultViewModeTiled() : boolean

Response

boolean

Checks if it is a permitted customer status or not.

isPermittedCustomerStatus(\IdType $customerStatusId) : boolean

Arguments

$customerStatusId

\IdType

Customer status ID.

Response

boolean

Checks if category/product is part of the sitemap.

isSitemapEntry() : boolean

Response

boolean

Sets the current category listing template.

setCategoryListingTemplate(\StringType $filename) : \CategorySettings

Arguments

$filename

\StringType

Category listing template.

Response

\CategorySettings

Same instance for chained method calls.

Sets whether default view mode should be tiled or not.

setDefaultViewModeTiled(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Is tiled the default view mode?

Response

\CategorySettings

Same instance for chained method calls.

Sets the filter selection mode value.

setFilterSelectionMode(\IntType $filterSelectionMode) : \Category

Arguments

$filterSelectionMode

\IntType

Response

\Category

Same instance for chained method calls.

Sets the filter value deactivation.

setFilterValueDeactivation(\IntType $filterValueDeactivation) : \Category

Arguments

$filterValueDeactivation

\IntType

Response

\Category

Same instance for chained method calls.

Sets whether a customer status is permitted or not.

setPermittedCustomerStatus(\IdType $customerStatusId, \BoolType $permitted) : \CategorySettings

Arguments

$customerStatusId

\IdType

Customer status ID.

$permitted

\BoolType

Is permitted?

Response

\CategorySettings

Same instance for chained method calls.

Sets the current product listing template.

setProductListingTemplate(\StringType $filename) : \CategorySettings

Arguments

$filename

\StringType

Product listing template.

Response

\CategorySettings

Same instance for chained method calls.

Sets the column by which the products are currently sorted.

setProductSortColumn(\StringType $column) : \CategorySettings

Arguments

$column

\StringType

Column by which the products should be sorted.

Response

\CategorySettings

Same instance for chained method calls.

Sets the direction which the products are currently sorted in.

setProductSortDirection(\StringType $direction) : \CategorySettings

Arguments

$direction

\StringType

Direction which the products should be sorted in.

Response

\CategorySettings

Same instance for chained method calls.

Sets whether the attributes should be displayed or not.

setShowAttributes(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Should attributes be displayed?

Response

\CategorySettings

Same instance for chained method calls.

Sets the show category filter value.

setShowCategoryFilter(\BoolType $showCategoryFilter) : \Category

Arguments

$showCategoryFilter

\BoolType

Response

\Category

Same instance for chained method calls.

Sets whether category image should be displayed in description or not.

setShowCategoryImageInDescription(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show image?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether graduated prices should be displayed or not.

setShowGraduatedPrices(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Show graduated prices?

Response

\CategorySettings

Same instance for chained method calls.

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

setShowQuantityInput(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Show quantity input?

Response

\CategorySettings

Same instance for chained method calls.

Sets whether the stock should be displayed or not.

setShowStock(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Show quantity info?

Response

\CategorySettings

Same instance for chained method calls.

Sets whether subcategories should be displayed or not.

setShowSubcategories(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Show subcategories?

Response

\CategorySettings

Same instance for chained method calls.

Sets whether subcategory images should be displayed or not.

setShowSubcategoryImages(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Show subcategory images?

Response

\CategorySettings

Same instance for chained method calls.

Sets whether subcategory names should be displayed or not.

setShowSubcategoryNames(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Show subcategory names?

Response

\CategorySettings

Same instance for chained method calls.

Sets whether subcategory products should be displayed or not.

setShowSubcategoryProducts(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

Show subcategory products?

Response

\CategorySettings

Same instance for chained method calls.

Sets the change frequency of the element.

setSitemapChangeFreq(\StringType $freq) : \CategorySettings

Arguments

$freq

\StringType

Change frequency value.

Response

\CategorySettings

Same instance for chained method calls.

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

setSitemapEntry(\BoolType $status) : \CategorySettings

Arguments

$status

\BoolType

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

Response

\CategorySettings

Same instance for chained method calls.

Sets the sitemap priority of the element.

setSitemapPriority(\StringType $priority) : \CategorySettings

Arguments

$priority

\StringType

Element's sitemap priority.

Response

\CategorySettings

Same instance for chained method calls.

Checks if attributes should be displayed or not.

showAttributes() : boolean

Response

boolean

Gets the show category filter value.

showCategoryFilter() : boolean

Response

boolean

Checks if category image should be displayed in description or not.

showCategoryImageInDescription() : boolean

Response

boolean

Checks if graduated prices should be displayed or not.

showGraduatedPrices() : boolean

Response

boolean

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

showQuantityInput() : boolean

Response

boolean

Checks if the stock should be displayed or not.

showStock() : boolean

Response

boolean

Checks if subcategories should be displayed or not.

showSubcategories() : boolean

Response

boolean

Checks if subcategory images should be displayed or not.

showSubcategoryImages() : boolean

Response

boolean

Checks if subcategory names should be displayed or not.

showSubcategoryNames() : boolean

Response

boolean

Checks if subcategory products should be displayed or not.

showSubcategoryProducts() : boolean

Response

boolean

Properties

Current template which is used for category listing.

categoryListingTemplate : string
var

The current category listing template.

Type(s)

string

Current template which is used for product listing.

productListingTemplate : string
var

Type(s)

string

Current column by which the products are sorted.

productSortColumn : string
var

Type(s)

string

Current direction which the products are sorted in.

productSortDirection : string
var

Type(s)

string

Is category/product in the sitemap?

sitemapEntry : boolean
var

Type(s)

boolean

Priority of the element in the sitemap.

sitemapPriority : string
var

Type(s)

string

Change frequency of the element in the sitemap.

sitemapChangeFreq : string
var

Type(s)

string

Should attributes be displayed?

attributes : boolean
var

Type(s)

boolean

Should graduated prices be displayed?

graduatedPrices : boolean
var

Type(s)

boolean

Should quantities be displayed?

quantityInput : boolean
var

Type(s)

boolean

Should quantity info be displayed?

stock : boolean
var

Type(s)

boolean

Should subcategories be displayed?

subcategories : boolean
var

Type(s)

boolean

Should subcategory images be displayed?

subcategoryImages : boolean
var

Type(s)

boolean

Should subcategory names be displayed?

subcategoryNames : boolean
var

Type(s)

boolean

Display category images as part of description?

showCategoryImageInDescription : boolean
var

Type(s)

boolean

Should subcategory products be displayed?

subcategoryProducts : boolean
var

Type(s)

boolean

Should default view mode be "tiled"?

viewModeTiled : boolean
var

Type(s)

boolean

Array of permitted customer status.

permittedCustomerStatus : array
var

Type(s)

array

showCategoryFilter

showCategoryFilter : boolean
var

Type(s)

boolean

filterSelectionMode

filterSelectionMode : integer
var

Type(s)

integer

filterValueDeactivation

filterValueDeactivation : integer
var

Type(s)

integer