ePages 6.17.12 - DE_EPAGES/Catalog/API/Shop.pm

Package DE_EPAGES::Catalog::API::Shop

Contains basic functions for ShopPagerSettings

@EXPORT_OK
GetPageSizeForCategory
GetPageSizeForObject
GetPageSize
SetPageSize

Functions

GetPageSize
GetPageSizeForCategory
GetPageSizeForObject
SetPageSize

GetPageSize

Return PageSize for requested layout

Syntax
$PageSize = GetPageSize( $Shop, $Alias );
Input
$Shop (DE_EPAGES::Shop::API::Object::Shop)
shop object
$Alias (string)
valid alias for layout
Return
$PageSize (integer)
number of products per page

GetPageSizeForCategory

Return PagerSetting for this $Category. Is 'CoverFlow_Color1' or 'CoverFlow_Color2' as category layout selected, then $PageSize is not defined.

Syntax
$PageSize = GetPageSizeForCategory( $Category );
Input
$Category (DE_EPAGES::Content::API::Object::Category)
category object
Return
$PageSize (integer or undef)
number of products per page

GetPageSizeForObject

Return default PageSize for given $Object and $PageTypeAlias. Don't use this function directly instead use wrapper function like GetPageSizeForCategory.

Syntax
$PageSize = GetPageSizeForObject( $Object, $PageTypeAlias, $TemplateTypeFolderAlias );
Example
$PageSize = GetPageSizeForObject( $Category, 'SF-Category', 'Content-Products' );
Input
$Object (object)
object
$PageTypeAlias (string)
PageType name
$TemplateTypeFolderAlias (string)
folder name
Return
$PageSize (integer)
number of product per page

SetPageSize

Store PageSize for specific layout for the current shop.

Syntax
SetPageSize( $Shop, $Alias, $PageSize );
Input
$Shop (DE_EPAGES::Shop::API::Object::Shop)
current shop object
$Alias (string)
valid alias for layout
$PageSize (integer)
page size for specific layout