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 CoreServices/Category/Entities/Interfaces/CategorySettingsInterface.inc.php

Methods summary

`public string`	# `getCategoryListingTemplate( )` Returns the current category listing template. Returns the current category listing template. Returns string The current category listing template.
`public CategorySettingsInterface`	# `setCategoryListingTemplate( StringType $filename )` Sets the current category listing template. Sets the current category listing template. Parameters `$filename` Category listing template. Returns `CategorySettingsInterface` Same instance for chained method calls.
`public string`	# `getProductListingTemplate( )` Returns the current product listing template. Returns the current product listing template. Returns string
`public CategorySettingsInterface`	# `setProductListingTemplate( StringType $filename )` Sets the current product listing template. Sets the current product listing template. Parameters `$filename` Product listing template. Returns `CategorySettingsInterface` Same instance for chained method calls.
`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
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`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
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `isSitemapEntry( )` Checks if category/product is part of the sitemap. Checks if category/product is part of the sitemap. Returns boolean
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`public string`	# `getSitemapPriority( )` Returns the sitemap priority of the element. Returns the sitemap priority of the element. Returns string
`public CategorySettingsInterface`	# `setSitemapPriority( StringType $priority )` Sets the sitemap priority of the element. Sets the sitemap priority of the element. Parameters `$priority` Element's sitemap priority. Returns `CategorySettingsInterface` Same instance for chained method calls.
`public string`	# `getSitemapChangeFreq( )` Returns the change frequency of the element. Returns the change frequency of the element. Returns string
`public CategorySettingsInterface`	# `setSitemapChangeFreq( StringType $freq )` Sets the change frequency of the element. Sets the change frequency of the element. Parameters `$freq` Change frequency value. Returns `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `showAttributes( )` Checks if attributes should be displayed or not. Checks if attributes should be displayed or not. Returns boolean
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `showGraduatedPrices( )` Checks if graduated prices should be displayed or not. Checks if graduated prices should be displayed or not. Returns boolean
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`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
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `showStock( )` Checks if the stock should be displayed or not. Checks if the stock should be displayed or not. Returns boolean
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `showSubcategories( )` Checks if subcategories should be displayed or not. Checks if subcategories should be displayed or not. Returns boolean
`public CategorySettingsInterface`	# `setShowSubcategories( BoolType $status )` Sets whether subcategories should be displayed or not. Sets whether subcategories should be displayed or not. Parameters `$status` Show subcategories? Returns `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `showSubcategoryImages( )` Checks if subcategory images should be displayed or not. Checks if subcategory images should be displayed or not. Returns boolean
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `showSubcategoryNames( )` Checks if subcategory names should be displayed or not. Checks if subcategory names should be displayed or not. Returns boolean
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`public boolean`	# `showSubcategoryProducts( )` Checks if subcategory products should be displayed or not. Checks if subcategory products should be displayed or not. Returns boolean
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`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
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.
`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
`public CategorySettingsInterface`	# `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 `CategorySettingsInterface` Same instance for chained method calls.

Packages

Interfaces

Interface CategorySettingsInterface

Direct known implementers

Methods summary

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns