CategorySettings
in package
implements
CategorySettingsInterface
Class CategorySettings
This Class stores some settings regarding display and visibility mode of category related data and is used within a CategoryInterface.
Tags
Interfaces, Classes and Traits
- CategorySettingsInterface
- Interface CategorySettingsInterface
Table of Contents
- $attributes : bool
- Should attributes be displayed?
- $categoryListingTemplate : string
- Current template which is used for category listing.
- $filterSelectionMode : int
- $filterValueDeactivation : int
- $graduatedPrices : bool
- Should graduated prices be displayed?
- $permittedCustomerStatus : array<string|int, mixed>
- Array of permitted customer status.
- $productListingTemplate : string
- Current template which is used for product listing.
- $productSortColumn : string
- Current column by which the products are sorted.
- $productSortDirection : string
- Current direction which the products are sorted in.
- $quantityInput : bool
- Should quantities be displayed?
- $showCategoryFilter : bool
- $showCategoryImageInDescription : bool
- Display category images as part of description?
- $sitemapChangeFreq : string
- Change frequency of the element in the sitemap.
- $sitemapEntry : bool
- Is category/product in the sitemap?
- $sitemapPriority : string
- Priority of the element in the sitemap.
- $stock : bool
- Should quantity info be displayed?
- $subcategories : bool
- Should subcategories be displayed?
- $subcategoryImages : bool
- Should subcategory images be displayed?
- $subcategoryNames : bool
- Should subcategory names be displayed?
- $subcategoryProducts : bool
- Should subcategory products be displayed?
- $viewModeTiled : bool
- Should default view mode be "tiled"?
- getCategoryListingTemplate() : string
- Returns the current category listing template.
- getFilterSelectionMode() : int
- Gets the filter selection mode value.
- getFilterValueDeactivation() : int
- Gets the filter value deactivation.
- getProductListingTemplate() : string
- Returns the current product listing template.
- getProductSortColumn() : string
- Returns the column by which the products are currently sorted.
- getProductSortDirection() : string
- Returns the direction which the products are currently sorted in.
- getSitemapChangeFreq() : string
- Returns the change frequency of the element.
- getSitemapPriority() : string
- Returns the sitemap priority of the element.
- isDefaultViewModeTiled() : bool
- Checks if default view mode should be tiled or not.
- isPermittedCustomerStatus() : bool
- Checks if it is a permitted customer status or not.
- isSitemapEntry() : bool
- Checks if category/product is part of the sitemap.
- setCategoryListingTemplate() : CategorySettings
- Sets the current category listing template.
- setDefaultViewModeTiled() : CategorySettings
- Sets whether default view mode should be tiled or not.
- setFilterSelectionMode() : Category
- Sets the filter selection mode value.
- setFilterValueDeactivation() : Category
- Sets the filter value deactivation.
- setPermittedCustomerStatus() : CategorySettings
- Sets whether a customer status is permitted or not.
- setProductListingTemplate() : CategorySettings
- Sets the current product listing template.
- setProductSortColumn() : CategorySettings
- Sets the column by which the products are currently sorted.
- setProductSortDirection() : CategorySettings
- Sets the direction which the products are currently sorted in.
- setShowAttributes() : CategorySettings
- Sets whether the attributes should be displayed or not.
- setShowCategoryFilter() : Category
- Sets the show category filter value.
- setShowCategoryImageInDescription() : CategorySettingsInterface
- Sets whether category image should be displayed in description or not.
- setShowGraduatedPrices() : CategorySettings
- Sets whether graduated prices should be displayed or not.
- setShowQuantityInput() : CategorySettings
- Sets whether a quantity input should be displayed in product forms or not.
- setShowStock() : CategorySettings
- Sets whether the stock should be displayed or not.
- setShowSubcategories() : CategorySettings
- Sets whether subcategories should be displayed or not.
- setShowSubcategoryImages() : CategorySettings
- Sets whether subcategory images should be displayed or not.
- setShowSubcategoryNames() : CategorySettings
- Sets whether subcategory names should be displayed or not.
- setShowSubcategoryProducts() : CategorySettings
- Sets whether subcategory products should be displayed or not.
- setSitemapChangeFreq() : CategorySettings
- Sets the change frequency of the element.
- setSitemapEntry() : CategorySettings
- Sets whether the category/product is part of the sitemap.
- setSitemapPriority() : CategorySettings
- Sets the sitemap priority of the element.
- showAttributes() : bool
- Checks if attributes should be displayed or not.
- showCategoryFilter() : bool
- Gets the show category filter value.
- showCategoryImageInDescription() : bool
- Checks if category image should be displayed in description or not.
- showGraduatedPrices() : bool
- Checks if graduated prices should be displayed or not.
- showQuantityInput() : bool
- Checks if a quantity input should be displayed in product forms or not.
- showStock() : bool
- Checks if the stock should be displayed or not.
- showSubcategories() : bool
- Checks if subcategories should be displayed or not.
- showSubcategoryImages() : bool
- Checks if subcategory images should be displayed or not.
- showSubcategoryNames() : bool
- Checks if subcategory names should be displayed or not.
- showSubcategoryProducts() : bool
- Checks if subcategory products should be displayed or not.
Properties
$attributes
Should attributes be displayed?
protected
bool
$attributes
= alse
$categoryListingTemplate
Current template which is used for category listing.
protected
string
$categoryListingTemplate
= ''
$filterSelectionMode
protected
int
$filterSelectionMode
= 0
$filterValueDeactivation
protected
int
$filterValueDeactivation
= 0
$graduatedPrices
Should graduated prices be displayed?
protected
bool
$graduatedPrices
= alse
$permittedCustomerStatus
Array of permitted customer status.
protected
array<string|int, mixed>
$permittedCustomerStatus
= []
$productListingTemplate
Current template which is used for product listing.
protected
string
$productListingTemplate
= ''
$productSortColumn
Current column by which the products are sorted.
protected
string
$productSortColumn
= ''
$productSortDirection
Current direction which the products are sorted in.
protected
string
$productSortDirection
= ''
$quantityInput
Should quantities be displayed?
protected
bool
$quantityInput
= alse
$showCategoryFilter
protected
bool
$showCategoryFilter
= alse
$showCategoryImageInDescription
Display category images as part of description?
protected
bool
$showCategoryImageInDescription
= rue
$sitemapChangeFreq
Change frequency of the element in the sitemap.
protected
string
$sitemapChangeFreq
= ''
$sitemapEntry
Is category/product in the sitemap?
protected
bool
$sitemapEntry
= alse
$sitemapPriority
Priority of the element in the sitemap.
protected
string
$sitemapPriority
= ''
$stock
Should quantity info be displayed?
protected
bool
$stock
= alse
$subcategories
Should subcategories be displayed?
protected
bool
$subcategories
= alse
$subcategoryImages
Should subcategory images be displayed?
protected
bool
$subcategoryImages
= alse
$subcategoryNames
Should subcategory names be displayed?
protected
bool
$subcategoryNames
= alse
$subcategoryProducts
Should subcategory products be displayed?
protected
bool
$subcategoryProducts
= alse
$viewModeTiled
Should default view mode be "tiled"?
protected
bool
$viewModeTiled
= alse
Methods
getCategoryListingTemplate()
Returns the current category listing template.
public
getCategoryListingTemplate() : string
Return values
string —getFilterSelectionMode()
Gets the filter selection mode value.
public
getFilterSelectionMode() : int
Return values
int —getFilterValueDeactivation()
Gets the filter value deactivation.
public
getFilterValueDeactivation() : int
Return values
int —getProductListingTemplate()
Returns the current product listing template.
public
getProductListingTemplate() : string
Return values
string —getProductSortColumn()
Returns the column by which the products are currently sorted.
public
getProductSortColumn() : string
Return values
string —getProductSortDirection()
Returns the direction which the products are currently sorted in.
public
getProductSortDirection() : string
Return values
string —getSitemapChangeFreq()
Returns the change frequency of the element.
public
getSitemapChangeFreq() : string
Return values
string —getSitemapPriority()
Returns the sitemap priority of the element.
public
getSitemapPriority() : string
Return values
string —isDefaultViewModeTiled()
Checks if default view mode should be tiled or not.
public
isDefaultViewModeTiled() : bool
Return values
bool —isPermittedCustomerStatus()
Checks if it is a permitted customer status or not.
public
isPermittedCustomerStatus(IdType $customerStatusId) : bool
Parameters
- $customerStatusId : IdType
-
Customer status ID.
Return values
bool —isSitemapEntry()
Checks if category/product is part of the sitemap.
public
isSitemapEntry() : bool
Return values
bool —setCategoryListingTemplate()
Sets the current category listing template.
public
setCategoryListingTemplate(StringType $filename) : CategorySettings
Parameters
- $filename : StringType
-
Category listing template.
Return values
CategorySettings —Same instance for chained method calls.
setDefaultViewModeTiled()
Sets whether default view mode should be tiled or not.
public
setDefaultViewModeTiled(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Is tiled the default view mode?
Return values
CategorySettings —Same instance for chained method calls.
setFilterSelectionMode()
Sets the filter selection mode value.
public
setFilterSelectionMode(IntType $filterSelectionMode) : Category
Parameters
- $filterSelectionMode : IntType
Return values
Category —Same instance for chained method calls.
setFilterValueDeactivation()
Sets the filter value deactivation.
public
setFilterValueDeactivation(IntType $filterValueDeactivation) : Category
Parameters
- $filterValueDeactivation : IntType
Return values
Category —Same instance for chained method calls.
setPermittedCustomerStatus()
Sets whether a customer status is permitted or not.
public
setPermittedCustomerStatus(IdType $customerStatusId, BoolType $permitted) : CategorySettings
Parameters
Return values
CategorySettings —Same instance for chained method calls.
setProductListingTemplate()
Sets the current product listing template.
public
setProductListingTemplate(StringType $filename) : CategorySettings
Parameters
- $filename : StringType
-
Product listing template.
Return values
CategorySettings —Same instance for chained method calls.
setProductSortColumn()
Sets the column by which the products are currently sorted.
public
setProductSortColumn(StringType $column) : CategorySettings
Parameters
- $column : StringType
-
Column by which the products should be sorted.
Return values
CategorySettings —Same instance for chained method calls.
setProductSortDirection()
Sets the direction which the products are currently sorted in.
public
setProductSortDirection(StringType $direction) : CategorySettings
Parameters
- $direction : StringType
-
Direction which the products should be sorted in.
Return values
CategorySettings —Same instance for chained method calls.
setShowAttributes()
Sets whether the attributes should be displayed or not.
public
setShowAttributes(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Should attributes be displayed?
Return values
CategorySettings —Same instance for chained method calls.
setShowCategoryFilter()
Sets the show category filter value.
public
setShowCategoryFilter(BoolType $showCategoryFilter) : Category
Parameters
- $showCategoryFilter : BoolType
Return values
Category —Same instance for chained method calls.
setShowCategoryImageInDescription()
Sets whether category image should be displayed in description or not.
public
setShowCategoryImageInDescription(BoolType $status) : CategorySettingsInterface
Parameters
- $status : BoolType
-
Show image?
Return values
CategorySettingsInterface —Same instance for chained method calls.
setShowGraduatedPrices()
Sets whether graduated prices should be displayed or not.
public
setShowGraduatedPrices(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Show graduated prices?
Return values
CategorySettings —Same instance for chained method calls.
setShowQuantityInput()
Sets whether a quantity input should be displayed in product forms or not.
public
setShowQuantityInput(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Show quantity input?
Return values
CategorySettings —Same instance for chained method calls.
setShowStock()
Sets whether the stock should be displayed or not.
public
setShowStock(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Show quantity info?
Return values
CategorySettings —Same instance for chained method calls.
setShowSubcategories()
Sets whether subcategories should be displayed or not.
public
setShowSubcategories(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Show subcategories?
Return values
CategorySettings —Same instance for chained method calls.
setShowSubcategoryImages()
Sets whether subcategory images should be displayed or not.
public
setShowSubcategoryImages(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Show subcategory images?
Return values
CategorySettings —Same instance for chained method calls.
setShowSubcategoryNames()
Sets whether subcategory names should be displayed or not.
public
setShowSubcategoryNames(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Show subcategory names?
Return values
CategorySettings —Same instance for chained method calls.
setShowSubcategoryProducts()
Sets whether subcategory products should be displayed or not.
public
setShowSubcategoryProducts(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Show subcategory products?
Return values
CategorySettings —Same instance for chained method calls.
setSitemapChangeFreq()
Sets the change frequency of the element.
public
setSitemapChangeFreq(StringType $freq) : CategorySettings
Parameters
- $freq : StringType
-
Change frequency value.
Return values
CategorySettings —Same instance for chained method calls.
setSitemapEntry()
Sets whether the category/product is part of the sitemap.
public
setSitemapEntry(BoolType $status) : CategorySettings
Parameters
- $status : BoolType
-
Value whether the category/product is part of the sitemap.
Return values
CategorySettings —Same instance for chained method calls.
setSitemapPriority()
Sets the sitemap priority of the element.
public
setSitemapPriority(StringType $priority) : CategorySettings
Parameters
- $priority : StringType
-
Element's sitemap priority.
Return values
CategorySettings —Same instance for chained method calls.
showAttributes()
Checks if attributes should be displayed or not.
public
showAttributes() : bool
Return values
bool —showCategoryFilter()
Gets the show category filter value.
public
showCategoryFilter() : bool
Return values
bool —showCategoryImageInDescription()
Checks if category image should be displayed in description or not.
public
showCategoryImageInDescription() : bool
Return values
bool —showGraduatedPrices()
Checks if graduated prices should be displayed or not.
public
showGraduatedPrices() : bool
Return values
bool —showQuantityInput()
Checks if a quantity input should be displayed in product forms or not.
public
showQuantityInput() : bool
Return values
bool —showStock()
Checks if the stock should be displayed or not.
public
showStock() : bool
Return values
bool —showSubcategories()
Checks if subcategories should be displayed or not.
public
showSubcategories() : bool
Return values
bool —showSubcategoryImages()
Checks if subcategory images should be displayed or not.
public
showSubcategoryImages() : bool
Return values
bool —showSubcategoryNames()
Checks if subcategory names should be displayed or not.
public
showSubcategoryNames() : bool
Return values
bool —showSubcategoryProducts()
Checks if subcategory products should be displayed or not.
public
showSubcategoryProducts() : bool