API Documentation » \CategorySettingsInterface

category	System
package	Category
subpackage	Interfaces

Returns the current category listing template.

getCategoryListingTemplate() : string

Response

string

The current category listing template.

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) : \CategorySettingsInterface

Arguments

$filename

\StringType

Category listing template.

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether default view mode should be tiled or not.

setDefaultViewModeTiled(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Is tiled the default view mode?

Response

\CategorySettingsInterface

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) : \CategorySettingsInterface

Arguments

$customerStatusId

\IdType

Customer status ID.

$permitted

\BoolType

Is permitted?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets the current product listing template.

setProductListingTemplate(\StringType $filename) : \CategorySettingsInterface

Arguments

$filename

\StringType

Product listing template.

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets the column by which the products are currently sorted.

setProductSortColumn(\StringType $column) : \CategorySettingsInterface

Arguments

$column

\StringType

Column by which the products should be sorted.

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets the direction which the products are currently sorted in.

setProductSortDirection(\StringType $direction) : \CategorySettingsInterface

Arguments

$direction

\StringType

Direction which the products should be sorted in.

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether the attributes should be displayed or not.

setShowAttributes(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Should attributes be displayed?

Response

\CategorySettingsInterface

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) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show graduated prices?

Response

\CategorySettingsInterface

Same instance for chained method calls.

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

setShowQuantityInput(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show quantity input?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether the stock should be displayed or not.

setShowStock(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show quantity info?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether subcategories should be displayed or not.

setShowSubcategories(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show subcategories?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether subcategory images should be displayed or not.

setShowSubcategoryImages(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show subcategory images?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether subcategory names should be displayed or not.

setShowSubcategoryNames(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show subcategory names?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets whether subcategory products should be displayed or not.

setShowSubcategoryProducts(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

Show subcategory products?

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets the change frequency of the element.

setSitemapChangeFreq(\StringType $freq) : \CategorySettingsInterface

Arguments

$freq

\StringType

Change frequency value.

Response

\CategorySettingsInterface

Same instance for chained method calls.

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

setSitemapEntry(\BoolType $status) : \CategorySettingsInterface

Arguments

$status

\BoolType

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

Response

\CategorySettingsInterface

Same instance for chained method calls.

Sets the sitemap priority of the element.

setSitemapPriority(\StringType $priority) : \CategorySettingsInterface

Arguments

$priority

\StringType

Element's sitemap priority.

Response

\CategorySettingsInterface

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

CategorySettingsInterface

Methods

Returns the current category listing template.

Response

Gets the filter selection mode value.

Response

Gets the filter value deactivation.

Response

Returns the current product listing template.

Response

Returns the column by which the products are currently sorted.

Response

Returns the direction which the products are currently sorted in.

Response

Returns the change frequency of the element.

Response

Returns the sitemap priority of the element.

Response

Checks if default view mode should be tiled or not.

Response

Checks if it is a permitted customer status or not.

Arguments

$customerStatusId

Response

Checks if category/product is part of the sitemap.

Response

Sets the current category listing template.

Arguments

$filename

Response

Sets whether default view mode should be tiled or not.

Arguments

$status

Response

Sets the filter selection mode value.

Arguments

$filterSelectionMode

Response

Sets the filter value deactivation.

Arguments

$filterValueDeactivation

Response

Sets whether a customer status is permitted or not.

Arguments

$customerStatusId

$permitted

Response

Sets the current product listing template.

Arguments

$filename

Response

Sets the column by which the products are currently sorted.

Arguments

$column

Response

Sets the direction which the products are currently sorted in.

Arguments

$direction

Response

Sets whether the attributes should be displayed or not.

Arguments

$status

Response

Sets the show category filter value.

Arguments

$showCategoryFilter

Response

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

Arguments

$status

Response

Sets whether graduated prices should be displayed or not.

Arguments

$status

Response

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

Arguments

$status

Response

Sets whether the stock should be displayed or not.