Interface CategorySettingsInterface

Interface CategorySettingsInterface

This interface defines methods for storing and retrieving some settings regarding display and visibility mode of category related data and is used within a CategoryInterface.

Direct known implementers

CategorySettings

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

Methods summary

public getCategoryListingTemplate( void ) : string

Returns the current category listing template.

public setCategoryListingTemplate( StringType $filename ) : CategorySettingsInterface

Sets the current category listing template.

public getProductListingTemplate( void ) : string

Returns the current product listing template.

public setProductListingTemplate( StringType $filename ) : CategorySettingsInterface

Sets the current product listing template.

public getProductSortColumn( void ) : string

Returns the column by which the products are currently sorted.

public setProductSortColumn( StringType $column ) : CategorySettingsInterface

Sets the column by which the products are currently sorted.

public getProductSortDirection( void ) : string

Returns the direction which the products are currently sorted in.

public setProductSortDirection( StringType $direction ) : CategorySettingsInterface

Sets the direction which the products are currently sorted in.

public isSitemapEntry( void ) : boolean

Checks if category/product is part of the sitemap.

public setSitemapEntry( BoolType $status ) : CategorySettingsInterface

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

public getSitemapPriority( void ) : string

Returns the sitemap priority of the element.

public setSitemapPriority( StringType $priority ) : CategorySettingsInterface

Sets the sitemap priority of the element.

public getSitemapChangeFreq( void ) : string

Returns the change frequency of the element.

public setSitemapChangeFreq( StringType $freq ) : CategorySettingsInterface

Sets the change frequency of the element.

public showAttributes( void ) : boolean

Checks if attributes should be displayed or not.

public setShowAttributes( BoolType $status ) : CategorySettingsInterface

Sets whether the attributes should be displayed or not.

public showGraduatedPrices( void ) : boolean

Checks if graduated prices should be displayed or not.

public setShowGraduatedPrices( BoolType $status ) : CategorySettingsInterface

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

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

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

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

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

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

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

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

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.