ePages 6.11.0 - DE_EPAGES/Design/API/Style.pm

Package package

This package provides functions to work with Styles.

Package DE_EPAGES::Design::API::Style

@EXPORT_OK
AddStyle
ExistsStyle
Style
AddStyleLogo
DeleteStyleLogo

Functions

AddStyle
AddStyleLogo
DeleteStyleLogo
ExistsStyle
IsSubStyle
Style

AddStyle

Adds a Style to the shops style list.

Syntax
$WantedStyle = AddStyle($Shop, $StyleTemplate);
Input
$Shop (object)
shop object
$StyleTemplate (object)
style template
Return
$WantedStyle (object)
created style object

AddStyleLogo

Sets the logo for a style.

Syntax
AddStyleLogo($Style, $ShopLogo, $Extension);
Input
$Style (object)
style object
$ShopLogo (string)
public path for shoplogo
Return
$Extension (string)
image extension

DeleteStyleLogo

Sets the logo for a style.

Syntax
DeleteStyleLogo($Style, $ShopLogo, $Extension);
Input
$Style (object)
style object
$ShopLogo (string)
public path for shoplogo
Return
$Extension (string)
image extension

ExistsStyle

Returns true if the style with the given style template exists in this shop.

Syntax
$Exists = ExistsStyle($Shop, $StyleTemplate);
Input
$Shop (object)
shop object
$StyleTemplate (object)
style template
Return
$Exists (boolean)
true if style exists

IsSubStyle

If StyleName contains the string "SubStyles/" return is 1

Syntax
my $IsSubStyle = IsSubStyle($StyleName);
Input
$StyleName (string)
name of the style
Return
$IsSubStyle (boolean)
Style is Sub Style, 0 or 1

Style

Returns style of this shop with the StyleName.

Syntax
$Style = Style($Shop, $StyleName);
Input
$Shop (object)
shop object
$StyleTemplate (object)
style template
Return
$Style (object)
style