To keep the code clean, compact and orderly a number of javascript functions were made available.
Naturally it is possible to add an extra functionality such as javascript functions and event
handlers to Scripts.js or in the file Index.tpl.
Function that will check if the key pressed is indeed the “enter” key.
Function that will select the value of an input field.
Parameter |
Datatype |
Description |
sDOMId |
String |
The ID of the input field. E.g.
<input type="text" id="SearchField" value=""/>
|
Function that forwards user to location indicated.
Parameter |
Datatype |
Description |
Location |
String |
Location to which user is forwarded. |
Signing on a visitor to the newsletter by means of this method is outdated.
Use the action hook SubscribeToNewsletter..
To simply add a button in the selected style and colour, a span element with the declaration
PredefinedButton should be implemented. This span is automatically converted to a stylized
button.
Example
);">shoppingcart</span>
Variables are small pieces of code with a specific name ( the variable name) that represent a
specific functionality. This functionality may vary from displaying a piece of text to loading
the content modules of the webshops. Below you will find the available variables and their
description.
Variable |
Description |
{$_IncludeHead} |
Include of global head data, Template.css and Scripts.js. |
{$_IncludeContent} |
Include of the contentpage in question (homepage, category, guestbook, productdetails,
order route etc. etc.).
|
{$_IncludeTail} |
Include of global tail-data, such as measuring pixels and statistics. |
Variable |
Description |
{$sProtocol} |
Gives 'http://' or'https://' back depending on the reserved page. |
{$sAbsoluteMediaLocation} |
Absolute path to the map to which the files were uploaded. HTP or HTPS is automatically
specified depending on the reserved page.
|
{$sRelativeMediaLocation} |
Relative path to the map to which files were uploaded. This variable is meant for usage
in the file Template.css to prevent security conflicts.
|
{$sCustomerLoginPageDeeplink} |
Link to the login page. |
{$sCustomerLogoutPageDeeplink} |
Link that provides log-out if customer presses the “log-out” button. |
{$sCustomerRegistrationPageDeeplink} |
Link to the registration page. This link is only available if the choice for the login
system is switched on and registration is possible.
|
{$sCurrentPage} |
Gives back what type of page is reserved. Based on this several layout pages can be
developed. This variable may contain following values:
- HomePage, the welcome page.
- TextPage, a textual page.
- CategoryPage, a category page.
- ProductPage, the product detail page.
- NewsPage, the news page.
|
{$sSearchPageDeeplink} |
The URL to the search page. This variable should be used to forward your own search
functionality to the right page. The search words entered should be added to this
variable. The construction of SearchPageDeeplink} consists of {$sProtocol} + website
main domain + '/website/index.php?Show=Search&KeyWord='.
|
{$sBasketPageDeeplink} |
The URL to the shopping basket. This variable should be used to forward a shopping cart
overview developed by yourself to the correct page.
|
{$HomeFolder} |
Path to the home folder, used to create image paths. |
Variable |
Setting |
{$bShowPricesToGuests} |
Setting: Show prices to guests
Location: Starting point/My webshop/Settings/ Loginsystems
Value: true of false.
|
{$bCustomerLoginActive} |
Setting: Users Login
Location: Startingpoint/My webshop/ Settings/ Loginsystems
Value: false if 'off', otherwise true.
|
{$sCustomerLoginSystemType} |
Setting: Users Login
Location: Startingpoint/My webshop/ Settings/ Loginsystems
Value:
- Inactive, loginsystem is off.
- ActiveWithRegistration, loginsysteem staat aan met de mogelijkheid tot
registreren.
- ActiveNoRegistration, loginsysteem is on but no option of registering.
Attentention {$sCustomerRegistrationPageDeeplink} does not contain a value.
- ActiveAutomaticRegistration, loginsysteem is on , after placing an order an
account is created automatically.
|
{$sCurrency} |
Setting: Valuta
Location: Startingpoint/My webshop/Settings/ Order proces settings.
Value:
- USA, American Dollar
- CAD, Canadian Dollar
- DKK, Danish Crowns
- EU, Euro
- UK, English Pound
- RON, Romanian Lei
- SRD, Surinam Dollar
- TL, Turkish Lira
- SEK, Swedish Crown
- CHF, Swiss Franc
|
Variable |
Description |
{$sBodyLogic} |
Adds logic to the <body>-tag for processing the
electronic payments . This variable should be used as
follows: <body {$sBodyLogic}>.
|
{$sPageTitleH1} |
<h1>-tag for the current page. This variable structures
the crumb path within the category structure and product detail page.
|
{$iSelectedCategoryId} |
Gives back the ID of the selected product category. |
{$iSelectedSubCategoryId} |
Gives back the ID of the selected product subcategory. |
{$iSelectedPageId} |
Gives back the ID of the selected page. |
{$sResellerName} |
Gives back the name of the reseller. |
{$sResellerDeeplink} |
Gives back the link of the reseller's website. |
{$sPoweredBy} |
Gives back the reseller's HTML-code 'Powered by'. |
{$bCustomerLoggedIn} |
Geeft aan met true of false of de klant is ingelogd. |
{$sCustomerName} |
Gives back the customer name of the logged in customer. |
{$fCustomerDiscount} |
Indicates the discount percentage of the customergroup of the customer. This variable
only contains a value if the customer in question is in a customergroup.
|
Objectproperties
Property |
Description |
Title |
Title of blog item. |
Content |
Textual content of blog item. |
ImageDeeplink |
Link to the image that was added to the blog item. |
Deeplink |
Link to the blog item. |
CreateDate |
Date when blog item was created. |
Author |
Author of blog item. |
AuthorWebsiteDeeplink |
Link to author's website. |
CommentCount |
Number of reactions to blog item. |
Available in code fragment
Code fragment |
Variable |
Description |
Last blogs |
{$aBlogs} |
An array of Blog-objects ( last 10). |
Diagram |
|
ObjectpropertiesType | Property | Description |
int | $Id | The Id of the product. |
int | $WebsiteId | The Id of the website. |
string | $Name | The Product name. |
string | $ProductNumber | The product article number. |
string | $EAN | The product EAN. |
string | $MPN | The product MPN. |
string | $SKU | The product SKU. |
string | $ShortDescription | The short description of a product. |
string | $Description | The full description of a product. |
string | $Unit | The Unity of product. |
boolean | $OrderWithoutStock | Can this product be ordered without stock. |
string | $Weight | The weight of the product. |
string | $Memo | The product Memo. |
string | $Specs | The product specification link. |
\DateTime | $CreateDate | The create date of this product. |
\DateTime | $LastModified | The last Modified date of this product. |
string | $Brand | The brand of this product. |
string | $Supplier | The supplier of this product. |
string | $Condition | The condition of this product. |
\Decorator\Protom\Product\KeywordCollection | $Keyword | A collection of keywords linked to this product. |
\Decorator\Protom\Product\PropertyGroupCollection | $Property | A collection of properties linked to this product. |
\Decorator\Protom\Product\RelevantProductCollection | $RelevantProduct | A collection of relevant products linked to this product. |
\Decorator\Protom\Product\Price | $Price | The price object of this product. |
\Decorator\Protom\Product\PhotoCollection | $Photo | A collection of photo's linked to this product. |
\Decorator\Protom\Product\StaggeredPrice | $StaggeredPrice | A collection of prices linked to this product. |
\Decorator\Protom\Product\AttachmentCollection | $Attachment | A collection of attachments linked to this product. |
\Decorator\Protom\Product\UploadCollection | $Upload | A collection of uploads linked to this product. |
\Decorator\Protom\Product\VideoCollection | $Video | A collection of video's linked to this product. |
\Decorator\Protom\Product\ReviewCollection | $Review | A collection of reviews linked to this product. |
\Decorator\Protom\Product\BundleCollection | $Bundle | A collection of product bundels linked to this product. |
\Decorator\Protom\Product\CreditPoint | $CreditPoint | The Creditpoint information. |
\Decorator\Protom\Product\VariationCollection | $Variation | A collection of Variation linked to this product. |
\Decorator\Protom\Product\ProConCollection | $ProCon | A collection of Pro's and con's linked to this product. |
\Decorator\Protom\Product\AttributeCollection | $Attribute | A collection of Attributes linked to this product. |
\Decorator\Protom\Product\AttributeCombinationCollection | $AttributeCombination | A collection of Attribute combinations linked to this product. |
\Decorator\Protom\Product\Button | $Button | The button of this product. |
\Decorator\Protom\Product\Amount | $Amount | The Amount information. |
boolean | $IsActive | Is the product active. |
\Decorator\Protom\Product\Color | $Color | Color information of this product. |
boolean | $IsVisible | Is this product visible. |
\Decorator\Protom\Product\CategoryCollection | $Category | A collection of categories linked to this product. |
\Decorator\Protom\Product\Shipping | $Shipping | The Shipping information. |
\Decorator\Protom\Product\Stock | $Stock | The Stock information. |
\Decorator\Protom\Product\Deposit | $Deposit | The Deposit information. |
string | $Uri | The URI of this product. |
string | $Alias | The alias of the product. |
\Decorator\Protom\Product\EndUserSettingCollection | $EndUserSetting | A collection of end user settings linked to this product. |
\Decorator\Protom\Product\Calculator | $Calculator | The product calculator. |
boolean | $IsOnWishlist | Is The Product On a wishlist. |
\Decorator\Protom\Product\Quotation | $Quotation | Quotation properties of this products. |
boolean | $IsDigital | Is The Product a Digital product. |
\Decorator\Protom\Product\Package | $Package | Is the object that contains package information. |
boolean | $IsNew | Is The Product a new product. |
int | $Id | The Id of the product. |
int | $WebsiteId | The Id of the website. |
string | $Name | The Product name. |
string | $ProductNumber | The product article number. |
string | $EAN | The product EAN. |
string | $MPN | The product MPN. |
string | $SKU | The product SKU. |
string | $ShortDescription | The short description of a product. |
string | $Description | The full description of a product. |
string | $Unit | The Unity of product. |
boolean | $OrderWithoutStock | Can this product be ordered without stock. |
string | $Weight | The weight of the product. |
string | $Memo | The product Memo. |
string | $Specs | The product specification link. |
\DateTime | $CreateDate | The create date of this product. |
\DateTime | $LastModified | The last Modified date of this product. |
string | $Brand | The brand of this product. |
string | $Supplier | The supplier of this product. |
string | $Condition | The condition of this product. |
\Decorator\Protom\Product\KeywordCollection | $Keyword | A collection of keywords linked to this product. |
\Decorator\Protom\Product\PropertyGroupCollection | $Property | A collection of properties linked to this product. |
\Decorator\Protom\Product\RelevantProductCollection | $RelevantProduct | A collection of relevant products linked to this product. |
\Decorator\Protom\Product\Price | $Price | The price object of this product. |
\Decorator\Protom\Product\PhotoCollection | $Photo | A collection of photo's linked to this product. |
\Decorator\Protom\Product\StaggeredPrice | $StaggeredPrice | A collection of prices linked to this product. |
\Decorator\Protom\Product\AttachmentCollection | $Attachment | A collection of attachments linked to this product. |
\Decorator\Protom\Product\UploadCollection | $Upload | A collection of uploads linked to this product. |
\Decorator\Protom\Product\VideoCollection | $Video | A collection of video's linked to this product. |
\Decorator\Protom\Product\ReviewCollection | $Review | A collection of reviews linked to this product. |
\Decorator\Protom\Product\BundleCollection | $Bundle | A collection of product bundels linked to this product. |
\Decorator\Protom\Product\CreditPoint | $CreditPoint | The Creditpoint information. |
\Decorator\Protom\Product\VariationCollection | $Variation | A collection of Variation linked to this product. |
\Decorator\Protom\Product\ProConCollection | $ProCon | A collection of Pro's and con's linked to this product. |
\Decorator\Protom\Product\AttributeCollection | $Attribute | A collection of Attributes linked to this product. |
\Decorator\Protom\Product\AttributeCombinationCollection | $AttributeCombination | A collection of Attribute combinations linked to this product. |
\Decorator\Protom\Product\Button | $Button | The button of this product. |
\Decorator\Protom\Product\Amount | $Amount | The Amount information. |
boolean | $IsActive | Is the product active. |
\Decorator\Protom\Product\Color | $Color | Color information of this product. |
boolean | $IsVisible | Is this product visible. |
\Decorator\Protom\Product\CategoryCollection | $Category | A collection of categories linked to this product. |
\Decorator\Protom\Product\Shipping | $Shipping | The Shipping information. |
\Decorator\Protom\Product\Stock | $Stock | The Stock information. |
\Decorator\Protom\Product\Deposit | $Deposit | The Deposit information. |
string | $Uri | The URI of this product. |
string | $Alias | The alias of the product. |
\Decorator\Protom\Product\EndUserSettingCollection | $EndUserSetting | A collection of end user settings linked to this product. |
\Decorator\Protom\Product\Calculator | $Calculator | The product calculator. |
boolean | $IsOnWishlist | Is The Product On a wishlist. |
\Decorator\Protom\Product\Quotation | $Quotation | Quotation properties of this products. |
boolean | $IsDigital | Is The Product a Digital product. |
\Decorator\Protom\Product\Package | $Package | Is the object that contains package information. |
boolean | $IsNew | Is The Product a new product. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the collection of videos visible. |
\Decorator\Protom\Product\Video[] | $Videos | An array of video's. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the video. |
string | $Name | The name of the video. |
int | $Position | The sorting position of the video. |
string | $VideoLink | The link of the video. |
ObjectpropertiesObjectpropertiesObjectpropertiesObjectpropertiesObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the variation collection visible. |
boolean | $UseColor | Use color or images as icons. |
\Decorator\Protom\Product[] | $Variations | Array of different variations. |
ObjectpropertiesType | Property | Description |
boolean | $UseColor | Use color |
\Decorator\Protom\Product\Color | $Color | Color object |
\Decorator\Protom\Product\Photo | $Photo | Photo object |
\Decorator\Protom\Product | $Product | Product |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are product attachments visible. |
\Decorator\Protom\Product\Upload[] | $Uploads | An Array of uploads. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the upload. |
string | $Description | The description of the upload. |
boolean | $IsRequired | Is this upload required. |
string | $Position | The sorting position of the upload. |
\Decorator\Protom\Product\Upload\File | $File | The file object. |
ObjectpropertiesType | Property | Description |
string | $Filename | The original filename. |
string | $Tempname | The filename on the server. |
string | $Deeplink | The deeplink to the path. |
string | $Icon | The deeplink to the icon. |
ObjectpropertiesType | Property | Description |
boolean | $IsEnabled | Is stock enabled. |
boolean | $IsVisible | Is stock number visible. |
int | $Amount | What is the amount of stock. |
string | $Type | Stock based on product or attribute. |
string | $DisplayType | Display level as icons or text. |
string | $Level | Either high, medium, or low stock level. |
string | $IconSet | The icon set to use. |
\Decorator\Protom\Product\Stock\Warning | $Warning | Warning when product is not available based on stock. |
ObjectpropertiesType | Property | Description |
string | $Message | Warning message of Stock |
boolean | $IsVisible | Is the warning message visible |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are staggered prices visible. |
boolean | $IsActive | Are staggered prices active. |
\Decorator\Protom\Product\Price[] | $Prices | An array of prices. |
\Decorator\Protom\Product\Price | $Selected | Which price is selected. |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product\Price | $Price | The shipping price. |
string | $DeeplinkDetails | Link to the details of this shipping. |
\Decorator\Protom\Product\Shipping\Delivery | $Delivery | The delivery information. |
string | $BasedOn | Setting of on which, either fixed or weight, a price is based. |
ObjectpropertiesType | Property | Description |
string | $Message | The delivery message. |
string | $LowOnStockMessage | The delivery message shown when the product is low on stock. |
boolean | $IsVisible | Is the delivery message visible. |
string | $Color | The color of the delivery message if available. |
string | $Label | The info text of the delivery. |
string | $LowOnStockLabel | The info text of the delivery when it is low on stock. |
int | $Days | The amount of days in which the product is delivered. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are reviews visible. |
int | $Count | The number of reviews. |
int | $Score | The average score of the given reviews. |
\Decorator\Protom\Product\Review[] | $Reviews | Array of reviews. |
string | $Error | Possible error message. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the review. |
string | $Review | The review text. |
int | $Points | The number of given points. |
\DateTime | $DateCreated | The review create date. |
string | $Name | The name of the reviewer. |
boolean | $Approved | Is the review approved. |
int | $UserId | Id of a possible logged in user that placed the review. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are relevant products visible. |
\Decorator\Protom\Product[] | $Products | An array of products. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is this quotation label element visible. |
string | $Caption | Caption of the label. |
boolean | $IsVisible | Is this quotation label element visible. |
string | $Caption | Caption of the label. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the properties visible. |
\Decorator\Protom\Product\Property\FeaturedCollection | $Featured | Collection of properties. |
\Decorator\Protom\Product\PropertyGroup[] | $Groups | An array of property groups. |
\Decorator\Protom\Product\Property[] | $Properties | An array of properties. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the property group. |
string | $Name | The name of the property group. |
\Decorator\Protom\Product\Property[] | $Properties | An array of properties. |
ObjectpropertiesType | Property | Description |
int | $Id | id of property |
string | $Name | name of property |
string | $Description | Description of the property |
string | $Value | Value of the property |
string | $Icon | optional icon |
string | $Type | Type of the property |
bool | $IsText | Is the type of the property text. |
bool | $IsOption | Is the type of the property option. |
bool | $IsOptionCheckbox | Is the type of the property optioncheckbox. |
bool | $IsCheckbox | Is the type of the property checkbox. |
bool | $IsGroup | Is the type of the property group. |
bool | $IsCollapsedGroup | Is the type of the property collapsedgroup. |
bool | $IsTextArea | Is the type of the property textarea. |
bool | $IsPrice | Is the type of the property price. |
int | $Id | id of property |
string | $Name | name of property |
string | $Description | Description of the property |
string | $Value | Value of the property |
string | $Icon | optional icon |
string | $Type | Type of the property |
bool | $IsText | Is the type of the property text. |
bool | $IsOption | Is the type of the property option. |
bool | $IsOptionCheckbox | Is the type of the property optioncheckbox. |
bool | $IsCheckbox | Is the type of the property checkbox. |
bool | $IsGroup | Is the type of the property group. |
bool | $IsCollapsedGroup | Is the type of the property collapsedgroup. |
bool | $IsTextArea | Is the type of the property textarea. |
bool | $IsPrice | Is the type of the property price. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | are featured properties visible |
\Decorator\Protom\Product\Property[] | $Properties | Array of featured properties |
ObjectpropertiesType | Property | Description |
string | $Id | The id of the Category. |
int | $Parent | The id of the parent category. |
string | $Name | The name of the category. |
string | $Description | The dscription of the category. |
\Decorator\Protom\Product\ProductCategory\DescriptionPhoto | $DescriptionPhoto | The Description photo. |
Photo | $Photo | The category photo. |
\Decorator\Protom\Product\ProductCategory\EndUserSettingCollection | $EndUserSetting | Collection of end user settings. |
ObjectpropertiesType | Property | Description |
boolean | $IsActive | Are there any end user settings active for this product. |
\Decorator\Protom\Product\ProductCategory\EndUserSetting[] | $Settings | The end user settings. |
ObjectpropertiesType | Property | Description |
string | $Value | The value of this endusersetting. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the photo. |
string | $Path | The dynamic path of the photo. |
string | $Alt | The alt text of the photo. |
int | $Id | The id of the photo. |
string | $Path | The dynamic path of the photo. |
string | $Alt | The alt text of the photo. |
string | $Location | Location of the photo |
boolean | $IsVisible | Is the photo visible |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the pro's and con's visible. |
\Decorator\Protom\Product\ProCon[] | $ProCons | An array of pro's and con's. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the pro or con. |
\DateTime | $CreateDate | The create date of this pro or con. |
string | $Type | The type, either pro or con. |
string | $Value | The value of this pro or con. |
string | $Icon | The icon of this pro or con. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the package. |
string | $Name | The name of the package. |
boolean | $IsVisible | Is the package visible. |
int | $Id | The id of the package. |
string | $Name | The name of the package. |
boolean | $IsVisible | Is the package visible. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the keywords visible. |
\Decorator\Protom\Product\Keyword[] | $Keywords | An array of keywords. |
ObjectpropertiesType | Property | Description |
string | $Keyword | A given keyword. |
string | $Deeplink | The deeplink to the keyword page. |
ObjectpropertiesType | Property | Description |
boolean | $IsActive | Are there any end user settings active for this product. |
\Decorator\Protom\Product\EndUserSetting[] | $Settings | The end user settings. |
boolean | $IsActive | Are there any end user settings active for this product. |
\Decorator\Protom\Product\EndUserSetting[] | $Settings | The end user settings. |
ObjectpropertiesType | Property | Description |
string | $Value | The value of this enduserSetting |
string | $Value | The value of this enduserSetting |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the deposits visible. |
\Decorator\Protom\Product\Price | $Container | Price of the container deposit. |
\Decorator\Protom\Product\Price | $Safety | Price of the safety deposit. |
ObjectpropertiesType | Property | Description |
boolean | $IsActive | Are creditpoints active. |
boolean | $IsVisible | Are creditpoints visible. |
string | $Name | Name of creditpoints. |
boolean | $IsCustom | Are custom creditpoints applied. |
int | $Amount | Amount of creditpoints earned when buying this product. |
boolean | $IsActive | Are creditpoints active. |
boolean | $IsVisible | Are creditpoints visible. |
string | $Name | Name of creditpoints. |
boolean | $IsCustom | Are custom creditpoints applied. |
int | $Amount | Amount of creditpoints earned when buying this product. |
ObjectpropertiesType | Property | Description |
boolean | $IsEmpty | Is the color visible. |
string | $Class | The css class of the color. |
string | $Style | The css style of the color. |
string | $Hex | The color in HEX. |
string | $Name | The name of the Color. |
boolean | $IsDark | Is it a dark color. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Calculator visible. |
string | $Name | The name of the Calculator. |
boolean | $IsTypeRoll | Is true if the type of the calculator is Roll. |
boolean | $IsTypeLength | Is true if the type of the calculator is Length. |
boolean | $IsTypeSurfaceArea | Is true if the type of the calculator is Surface area. |
boolean | $IsTypeVolume | Is true if the type of the calculator is Volume. |
boolean | $IsTypeWeight | Is true if the type of the calculator is Weight. |
boolean | $IsTypeSurfaceAreaWH | Is true if the type of the calculator is Surface area. |
string | $CalculationMethod | The CalculationMethod of the Calculator. |
string | $Unit | The Unit of the Calculator. |
string | $Caption | Defines the caption of the calculator. |
float | $RequestAmount | The given amount on which the calculation is based. |
\Decorator\Protom\Product\Calculator\Margin | $Margin | Margin object of the Calculator. |
\Decorator\Protom\Product\Calculator\DimensionCollection | $Dimension | The given calculator Dimensions. |
\Decorator\Protom\Product\Calculator\Button | $Button | Button object of the calculator. |
\Decorator\Protom\Product\Calculator\ErrorCollection | $Error | Collection of possible errors returned. |
boolean | $IsVisible | Is the Calculator visible. |
string | $Name | The name of the Calculator. |
boolean | $IsTypeRoll | Is true if the type of the calculator is Roll. |
boolean | $IsTypeLength | Is true if the type of the calculator is Length. |
boolean | $IsTypeSurfaceArea | Is true if the type of the calculator is Surface area. |
boolean | $IsTypeVolume | Is true if the type of the calculator is Volume. |
boolean | $IsTypeWeight | Is true if the type of the calculator is Weight. |
boolean | $IsTypeSurfaceAreaWH | Is true if the type of the calculator is Surface area. |
string | $CalculationMethod | The CalculationMethod of the Calculator. |
string | $Unit | The Unit of the Calculator. |
string | $Caption | Defines the caption of the calculator. |
float | $RequestAmount | The given amount on which the calculation is based. |
\Decorator\Protom\Product\Calculator\Margin | $Margin | Margin object of the Calculator. |
\Decorator\Protom\Product\Calculator\DimensionCollection | $Dimension | The given calculator Dimensions. |
\Decorator\Protom\Product\Calculator\Button | $Button | Button object of the calculator. |
\Decorator\Protom\Product\Calculator\ErrorCollection | $Error | Collection of possible errors returned. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the margin visible. |
boolean | $IsEditable | Is the margin editable. |
string | $Description | The description of the margin. |
float | $Value | The margin value. |
string | $Name | The name of the margin. |
boolean | $IsVisible | Is the margin visible. |
boolean | $IsEditable | Is the margin editable. |
string | $Description | The description of the margin. |
float | $Value | The margin value. |
string | $Name | The name of the margin. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the error visible? |
string | $Message | The error message |
boolean | $IsVisible | Is the error visible? |
string | $Message | The error message |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product\Calculator\ErrorMessage[] | $Errors | The available errors |
\Decorator\Protom\Product\Calculator\ErrorMessage[] | $Errors | The available errors |
ObjectpropertiesType | Property | Description |
bool | $IsVisible | Is the collection visible. |
bool | $IsCombined | Are the different dimensions combined to one singular input. |
float | $Value | Calculation value of the given combined dimensions together. |
string | $Unit | The given unit. |
string | $Description | The given description. |
\Decorator\Protom\Product\Calculator\Dimension[] | $Dimensions | The available dimensions. |
bool | $IsVisible | Is the collection visible. |
bool | $IsCombined | Are the different dimensions combined to one singular input. |
float | $Value | Calculation value of the given combined dimensions together. |
string | $Unit | The given unit. |
string | $Description | The given description. |
\Decorator\Protom\Product\Calculator\Dimension[] | $Dimensions | The available dimensions. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
float | $Surface | The Surface area of the Calculator |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
string | $Length | The Length of the Calculator |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
boolean | $IsVisible | Is the Dimension data visible |
string | $Type | The Type of the Calculator |
float | $MinValue | The minimum input value |
float | $MaxValue | The maximum input value |
string | $Width | The Width of the Calculator |
string | $Length | The Length of the Calculator |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the error visible? |
string | $Hook | The button hook |
string | $Caption | The button caption |
boolean | $IsVisible | Is the error visible? |
string | $Hook | The button hook |
string | $Caption | The button caption |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the button visible. |
boolean | $IsActive | Is the button active. |
string | $Caption | Caption of the button. |
string | $Hook | Defines the js hook of this button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the button visible. |
boolean | $IsActive | Is the button active. |
string | $Caption | Caption of the button. |
string | $Hook | Defines the js hook of this button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the product bundles visible. |
string | $DiscountText | Possible discount text of the product bundle. |
\Decorator\Protom\Product\Bundle[] | $Bundles | An array of bundles. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of this bundle. |
boolean | $IsRecommended | Is the bundle recomended yes or no. |
boolean | $HasVariablePrice | Does the bundle have a fixed price or a price based on the products included (variable). |
string | $Name | Name of the bundle. |
string | $Description | The description of the bundle, only available if it is a recommended bundle. |
\Decorator\Protom\Product\Price | $Price | Price of the bundle. |
\Decorator\Protom\Product\Bundle\Product[] | $Products | An array of BundleProducts. |
string | $Uri | The URI of this product. |
string | $Alias | The alias of the product. |
\Decorator\Protom\Product\Button | $Button | The order button of this bundle. |
string | $LinkDescription | The description of the bundle (all product names). |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Bundle product Visible. |
\Decorator\Protom\Product | $Product | The Product in the Bundle. |
boolean | $IsVisible | Is the Bundle product Visible. |
\Decorator\Protom\Product | $Product | The Product in the Bundle. |
boolean | $IsFree | Is The bundle product a free product. |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product | $Combinations | available attribute combinations |
ObjectpropertiesType | Property | Description |
int | $Id | id of the combination |
int | $ProductId | id of the product |
int | $CombinationId | id of the combination |
string | $Attribute | The combination of attribute values |
\Decorator\Protom\Product\AttributeCombination\Product | $Product | Product of the attributecombination |
boolean | $IsVisible | Is the attribute combination visible |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product\Attribute\SelectedCollection | $Selected | Selected attributes |
\Decorator\Protom\Product | $Product | Product |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the attributes visible? |
\Decorator\Protom\Product\Attribute\SelectedCollection | $Selected | Selected attributes |
\Decorator\Protom\Product\Attribute\OptionCollection | $Option | Collection of options |
boolean | $HasRequiredAttribute | Has this colection required attributes (no text fields) |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the attribute. |
string | $Option | The option name of an attribute. |
string | $Value | The value name of an attribute. |
string | $Unit | The unit of an attribute. |
\Decorator\Protom\Product\Price | $Price | The price object of an attribute. |
boolean | $IsSelected | Is the attribute selected. |
boolean | $IsVisible | Is the attribute visible. |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product\Attribute[] | $Attributes | An array of attributes. |
boolean | $AreRequiredAttributesSelected | Are all required attributes selected. |
int | $CombinationId | The attribute combination id. |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product\Attribute\Option[] | $Options | An array of options. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the option. |
string | $Option | The option name. |
int | $Type | Type of this option, either dropdown or input. |
\Decorator\Protom\Product\Attribute[] | $Attributes | An array of attributes. |
boolean | $IsVisible | Is the option visible. |
boolean | $IsRequired | Is the option required. |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product\AttributeCombination[] | $Combinations | array of combinations |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Product\Attribute[] | $Attributes | array of attributes |
\Decorator\Protom\Product\Attribute\Combination | $Combination | attribute combination |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are product attachments visible. |
\Decorator\Protom\Product\Attachment[] | $Attachments | An array of attachments. |
ObjectpropertiesType | Property | Description |
int | $Id | The id of the attachment. |
string | $Language | Language of the attachment. |
string | $Path | Path to the attachment. |
string | $Name | Name of the attachment. |
string | $Position | The sorting position. |
string | $Size | The File size. |
string | $Icon | The File Icon of the file. |
ObjectpropertiesType | Property | Description |
int | $Precision | The number of digits behind the seperator. |
float | $MinimalOrderAmount | The minimal amount which has to be ordered. |
float | $Step | The step which you can increase / decrease the amount. |
double | $Amount | The amount of how many the customer wants. |
boolean | $IsFixed | Are there fixed amounts. |
boolean | $IsVisible | Is the exact number visible. |
\Decorator\Protom\Product\Amount[] | $FixedAmounts | Array of fixed amounts. |
ObjectpropertiesObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
ObjectpropertiesType | Property | Description |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is Upselling Visible. |
\Factory\Product\Upselling\Product[] | $Products | The products in the upselling element. |
\Decorator\Protom\Page\Basket\Upselling\Position | $Position | The position of the upselling element. |
boolean | $IsVisible | Is Upselling Visible. |
\Factory\Product\Upselling\Product[] | $Products | The products in the upselling element. |
\Decorator\Protom\Page\Basket\Upselling\Position | $Position | The position of the upselling element. |
ObjectpropertiesType | Property | Description |
boolean | $IsActive | Are there any enduser settings active for this product. |
\Decorator\Protom\Page\Template\EndUserSetting[] | $Settings | The enduser settings. |
boolean | $IsActive | Are there any enduser settings active for this product. |
\Decorator\Protom\Page\Template\EndUserSetting[] | $Settings | The enduser settings. |
ObjectpropertiesType | Property | Description |
string | $Value | The value of this enduserSetting |
string | $Value | The value of this enduserSetting |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | |
ObjectpropertiesType | Property | Description |
int | $Id | The takout slot id. |
DateTime | $Date | The Date formatted in datetime. |
int | $AvailableCapacity | The available capacity. |
int | $Capacity | The current capacity. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the takout message visible. |
string | $Message | The takout message. |
ObjectpropertiesType | Property | Description |
DateTime | $Date | A DateTime formatted date. |
int | $AvailableCapacity | The available capacity. |
int | $Capacity | The current capacity. |
array | $Slots | An array of slots. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the takeout checker visible. |
boolean | $IsValid | Is the takeout checker valid. |
string | $Country | The chosen country to check. |
\Decorator\Protom\Page\Takeout\Checkout | $Checkout | The checkout data. |
string | $Zipcode | The given zipcode to check. |
\Decorator\Protom\Page\Takeout\Date | $Date | The given date. |
\Decorator\Protom\Page\Takeout\Slot | $Slot | The reserved slot. |
\Decorator\Protom\Page\Takeout\Message | $Message | A given message. |
array | $Checkouts | An array of checkout types. |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Product\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Page\Product\Review | $Review | Review settings of the page |
\Decorator\Protom\Product | $Product | The Currently viewed product of the product page |
\Decorator\Protom\Page\Product\Question | $Question | The question settings |
\Decorator\Protom\Page\Product\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Product\ViewedByOthers | $ViewedByOthers | Product viewed by others |
\Decorator\Protom\Page\Product\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Product\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Product\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Product\WishlistCollection | $CustomerWishlist | The wishlist |
\Decorator\Protom\Page\Product\CalculatorSummary | $CalculatorSummary | The calculation summary of the set |
string | $Title | The page title |
\Decorator\Protom\Page\Product\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Page\Product\Review | $Review | Review settings of the page |
\Decorator\Protom\Product | $Product | The Currently viewed product of the product page |
\Decorator\Protom\Page\Product\Question | $Question | The question settings |
\Decorator\Protom\Page\Product\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Product\ViewedByOthers | $ViewedByOthers | Product viewed by others |
\Decorator\Protom\Page\Product\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Product\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Product\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Product\WishlistCollection | $CustomerWishlist | The wishlist |
\Decorator\Protom\Page\Product\CalculatorSummary | $CalculatorSummary | The calculation summary of the set |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
ObjectpropertiesType | Property | Description |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are viewed by others products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
string | $Name | The given template name. |
string | $Path | The given template path. |
boolean | $IsProtom | Is the template a protom template. |
boolean | $HasCustomBreadcrumb | If the template has a custom breadcrumb the global breadcrumb will be hidden. |
string | $Name | The given template name. |
string | $Path | The given template path. |
boolean | $IsProtom | Is the template a protom template. |
boolean | $HasCustomBreadcrumb | If the template has a custom breadcrumb the global breadcrumb will be hidden. |
\Decorator\Protom\Page\Template\EndUserSettingCollection | $EndUserSetting | Collection of end user settings. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the reviews visible. |
boolean | $IsPostingAllowed | Is posting of reviews allowed. |
boolean | $IsApprovalEnabled | Is an approval of posted reviews needed. |
boolean | $IsNameRequired | Is a name required. |
string | $ApprovalText | The given approval text upon sending a review. |
\Decorator\Protom\Page\Product\Review\Field[] | $Fields | An array of form fields. |
int | $ItemsPerPage | The amount of items per page. |
CreditPoint | $CreditPoint | A Creditpoint object. |
boolean | $IsVisible | Are the reviews visible. |
boolean | $IsPostingAllowed | Is posting of reviews allowed. |
boolean | $IsApprovalEnabled | Is an approval of posted reviews needed. |
boolean | $IsNameRequired | Is a name required. |
string | $ApprovalText | The given approval text upon sending a review. |
\Decorator\Protom\Page\Product\Review\Field[] | $Fields | An array of form fields. |
int | $ItemsPerPage | The amount of items per page. |
CreditPoint | $CreditPoint | A Creditpoint object. |
ObjectpropertiesType | Property | Description |
string | $Name | The name of the field. |
string | $FieldName | The systemname of the field. |
string | $Type | The field type either score, textarea or text. |
boolean | $Required | Is the field required yes or no. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the question block visible. |
string | $Image | The possible attached image. |
\Decorator\Protom\Page\Product\Question\SocialMediaCollection | $SocialMedia | The question linked social media data. |
\Decorator\Protom\Page\Product\Question\Email | $Email | The question email object. |
\Decorator\Protom\Page\Product\Question\Telephone | $Telephone | The question telephone object. |
\Decorator\Protom\Page\Product\Question\WhatsApp | $WhatsApp | The question whatsapp object. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is platform visible |
string | $Name | Name of Platform |
string | $Deeplink | The link of WhatsApp |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the platform visible. |
string | $Name | The name of the platform. |
string | $Deeplink | The Link to the Platform. |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Page\Product\Question\SocialMedia[] | $SocialMedia | A Socialmedia object. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the platform visible. |
string | $Platform | The Socialmedia platform. |
string | $AccountName | The Platform account name. |
string | $Deeplink | The link to the socialmedia platform. |
boolean | $HasIcon | Does it have a custom icon. |
string | $Icon | The custom svg wrapped around an tag in a string. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the platform visible. |
string | $Name | The name of the platform. |
string | $Deeplink | The link to the platform. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the compare functionality visible. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the summary visible |
float | $RequestedAmount | the requested amount of the summary |
float | $Amount | the amount of the summary |
string | $Description | the description of the summary |
string | $UnitDescription | the description of the unit summary |
\Decorator\Protom\Product\Price | $Price | The price object from the summary |
boolean | $IsVisible | Is the summary visible |
float | $RequestedAmount | the requested amount of the summary |
float | $Amount | the amount of the summary |
string | $Description | the description of the summary |
string | $UnitDescription | the description of the unit summary |
\Decorator\Protom\Product\Price | $Price | The price object from the summary |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
string | $Keywords | The metadata keywords. |
string | $Description | The metadata description. |
string | $PageTitle | The metadata page title. |
boolean | $IsNoIndex | Is the page to be indexed. |
boolean | $IsNoFollow | Is a nofollow active on this page. |
string | $Uri | The URI of this page. |
string | $Alias | The alias of the page. |
string | $Deeplink | The deeplink of the page. |
string | $Keywords | The metadata keywords. |
string | $Description | The metadata description. |
string | $PageTitle | The metadata page title. |
boolean | $IsNoIndex | Is the page to be indexed. |
boolean | $IsNoFollow | Is a nofollow active on this page. |
string | $Uri | The URI of this page. |
string | $Alias | The alias of the page. |
string | $Deeplink | The deeplink of the page. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Bundle product Visible. |
\Decorator\Protom\Product | $Product | The Product in the Bundle. |
boolean | $IsVisible | Is the Bundle product Visible. |
\Decorator\Protom\Product | $Product | The Product in the Bundle. |
Available in code fragment
Code fragment |
Variable |
Description |
Fetch products |
{foreach \Factory\Protom\Products::Fetch([]) as $Product}
{/foreach}
|
Fetch an array of products based on the arguments in supplied as parameter. The
parameters are combined (no intersection), "product" are added in "products" and are
added in products in categorie (categorie). The sorted result array contains DisplayedProduct objects, not to
confuse with Products.
|
Available parameters
Parameter |
Description |
Category |
One category id |
Categories |
Array of category ids. Please suplly the sub category id's also. |
Product |
One product id |
Products |
Array of product ids. |
The example below outputs the product name of products with the ids 1,2,3 and every product in
category 8.
{foreach \Factory\Protom\Products::Fetch([
'products' => [1,2],
'product' => 3,
'category' => 8]) as $oProduct}
{$oProduct->Name} <br />
{/foreach}
{\Factory\Protom\Products::Fetch(['product' => 392717250])->current()->Name}
The example below fetches products with the ids, 1 and 2.
{foreach \Factory\Protom\Products::Fetch([
'products' => [1],
'product' => 2
]) as $oProduct}
{$oProduct->Name} <br />
{/foreach}
Objectproperties
Property |
Description |
Name |
Brand name. |
Available in code fragment
Codefragment |
Variable |
Description |
List of brands |
{$aBrands} |
An array of Brand-objects. |
Objectproperties
Property |
Description |
Title |
Title of category or page. |
Deeplink |
Deeplink to the category or page in question. Value of the last crumb is empty. |
Available in code fragment
Codefragment |
Variable |
Description |
Crumb path |
{$aCrumbs} |
An array of Crumb-objects. |
Objectproperties
Property |
Description |
FlagIcon |
Deeplink to the standard flag icon, to be used in <img /> .
|
Code |
Country code, two digits (ISO 3166-1). |
Domain |
Domain of the language. |
Available in code fragment
Codefragment |
Variable |
Description |
Language flags |
{$aLanguages} |
An array of Language-objects. |
Objectproperties
Property |
Description |
Title |
Title of newsitem. |
Content |
Content of newsitem. |
Date |
Date of precessing. |
Deeplink |
Link to news item. |
Available in code fragment
Codefragment |
Variable |
Description |
List of newsitems |
{$aNewsItems} |
An array of NewsItem-objects. |
Objectproperties
Property |
Description |
ProductNumber |
Product number/Article number. |
ProductName |
Name of products. |
Count |
Number of products. E.g. 2 if two identical products are in the shopping cart. |
Tax |
VAT-value as integer. E.g. 0,6 or 21. |
Unit |
Product unit. |
Price |
Selling price (if a discount is applicable, it is deducted ) Examples values: 10, 10.1
and 10.95.
|
FromPrice |
The original price (if discount is applicable is will differ from Price) Example values:
10, 10.1 en 10.95.
|
Discount |
Discount on a product (if applicable) . Value contains discountvalue. Example values:
10, 10.1 en 10.95.
|
TotalPrice |
Total price of this product (Count * Price). Example values: 10, 10.1 en 10.95. |
PriceFormatted |
Formatted selling price (if a discount is applicable is is deducted). Example values:
10,00, 10,10 en 10,95.
|
FromPriceFormatted |
Formatted original price (if a discount is applicable it differs from Price ). Example
values: 10,00, 10,10 en 10,95.
|
DiscountFormatted |
Formatted discount on a product (if applicable). Example values: 10,00, 10,10 en
10,95.
|
TotalPriceFormatted |
Formatted total price of this product (Count * Price). Example values: 10,00, 10,10 en
10,95.
|
Deeplink |
Deeplink to product detail page. |
MainImageDeeplink |
Deeplink to main image of product. |
MainImageThumbnailDeeplink |
Deeplink to thumbnail of main image of product. |
Available in code fragment
Codefragment |
Variable |
Description |
Small shopping basket |
{$aOrderRows} |
An array of OrderRow-objects. |
Objectproperties
Property |
Description |
Id |
Unique page ID. |
Title |
Page title (also used as link name). |
PageType |
Page type of the page. Optional page types:
- HomePage
- About
- AgreementTerms
- BannerPage
- Calendar
- ContactPage
- DownloadPage
- EnumeratePage
- FAQPage
- GuestbookReview
- HomePage
- LinkPage
- MailingList
- MailingPage
- NewHomePage
- NewsPage
- PageBlog
- Poll
- PresentationPage
- PriceListPage
- RedirectPage
- ReservePage
- RoutePage
- ShowMailings
- StandardPage
- UserAccount
|
Deeplink |
Link to linked page. |
Available in code fragment
Codefragment |
Variable |
Description |
Pages |
{$aPages} |
An array of Page-objects. |
Objectproperties
Property |
Description |
ProductName |
Name of product. |
ProductNumber |
Productnumber/article number. |
ShortDescription |
Short description (max. 200 characters). |
Description |
Full description. |
Unit |
Unity of product. |
Tax |
VAT-value as integer. E.g. 0, 6 of 21. |
Stock |
Current stock. |
StockDeliveryStandard |
Standard delivery time for the product |
BrandId |
Product brand |
Weight |
Current weight of product |
Specs |
Specification URL |
Attributes |
Product attributes |
EANNumber |
EAN Number |
MPNNumber |
MPN Number |
Price |
Selling price (if a discount is applicable, it is deducted). Example values: 10, 10.1 en
10.95.
|
FromPrice |
Original price (if discount is applicable it will differ from Price. Example values: 10,
10.1 en 10.95
|
Discount |
Discount on a product (if applicable). Value contains discount value. Example values:
10, 10.1 en 10.95.
|
PriceFormatted |
Formatted selling price (if a discount is applicable, it is deducted). Example values:
10,00, 10,10 en 10,95.
|
FromPriceFormatted |
Formatted original price (if discount is applicable it differs from Price). Example
values: 10,00, 10,10 en 10,95.
|
DiscountFormatted |
Formatted discount on a product (if applicable). Example values: 10,00, 10,10 en 10,95
|
Deeplink |
Deeplink to product page. |
MainImageDeeplink |
Deeplink to main image of product.
As standard a measurement of 500px wide with matching space. The platform offers a
render farm that allows you to scale to any measure you desire. This may make quite a
difference in bandwidth. To scale an mage ( and automatically saving it, following code
is used:
{$oProduct->MainImageDeeplink|replace:'/Large':'/150'}.
Using this
code that normally was served as 500 px width – the image will be served as an image of
150px width. If the image of 150px width did not exist as yet, it is automatically
created. Images cannot be made larger than the orginal uploaded file.
|
MainImageThumbnailDeeplink |
Deeplink to the thumbnail of the main image of the product. |
ImageDeeplink |
Deeplink to all the images of product.
As standard a measurement of 500px wide with matching space. The platform offers a
render farm that allows you to scale to any measure you desire. This may make quite a
difference in bandwidth. To scale an mage ( and automatically saving it, following code
is used:
{$oProduct->ImageDeeplink|replace:'/Large':'/150'}.
Using this code
that normally was served as 500 px width – the image will be served as an image of 150px
width. If the image of 150px width did not exist as yet, it is automatically created.
Images cannot be made larger than the orginal uploaded file.
|
ImageThumbnailDeeplink |
Deeplink to the thumbnail of all the images of the product. |
CreateDate |
Y-m-d H:i:s Date when product was created. |
OrderButtonType |
Type of button that was advised in product management:
- OrderButton, orderbutton (consult hook_AddProductToCart
for implementation documentation).
- OfferButton, offerbutton
- NoButton, no button
|
ShowOrderButton |
true of false
|
ReviewsTotal |
Product reviews available
|
ReviewsAverage |
Average review rating
|
ReviewsMin |
Min. rating available string '0'
|
ReviewsMax |
Max. rating available string '5'
|
Determine true of false for property ShowOrderButton
The property ShowOrderButton contains the value true or false depending on several combinations of
settings and product properties. Factors that should be taken into account are:
Setting |
Location |
Show prices to guest |
Starting point/My webshop/Settings/General/Login systems |
Hide orderbutton if no more stock is available |
Starting point / My webshop / Settings / Orderprocess and stock / Stockmanagement /
Stock options
|
Product has stock |
Starting point / My products/Product management / product in question/Tab Stock |
Stocktype |
Starting point / My products / Product management / Product in question / Tab Stock |
Stock |
Starting point / My products / Product management / Product in question / Tab stock |
Show order / offer button at product |
Starting point / My products / Productmanagement / Product in question / Tab Options
|
The property
ShowOrderButton is only
true for following combinations:
-
Show prices to guests [=Yes]and also
Hide orderbutton if no stock is available[=checked]and also
Product has stock [=Yes] and also
Stock is [=Bigger than 0] and also
Show order/offerbutton with product[=Orderbutton]
-
Show prices to guests[=Yes]and also
Hide orderbutton if no stock is available [=Unchecked]and also
Show order/offerbutton with product[=Orderbutton]
-
Show prices to guests[=Yes] and also
Product has stock [=Unchecked] and also
Show order/offerbutton with product[=Orderbutton]
-
Show prices to guests[=Yes] and also
Product type [=Attribute] and also
Show order/offerbutton with product [=Orderbutton]
-
Show prices to guests [=No] and also
Customer logged in [=No] and also
Hide order button if there is no stock available [=Checked] and also
Product has stock [=Checked] and also
Stock [=Bigger than 0] and also
Show order/offerbutton with product[=Orderbutton]
-
Show prices to guests [=No] and also
Customer logged in [=Yes] and also
Hide orderbutton if no stock is available [=Unchecked]and also
Show order/offer button with product [=Orderbutton]
-
Show prices to guests [=No] and also
Customer logged in [=Yes] and also
Product has stock [=Unchecked] and also
Show order/offer button with product [=Orderbutton]
-
Show prices to guests [=No] and also
Customer logged in [=Ja] and also
Stocktype [=Attribute] and also
Show order/offer button with product [=Orderbutton]
Available in code fragment
Codefragment |
Variable |
Description |
BestSellers |
{$aBestSellers} |
An array of Product-object maximum 25. |
Product on offer |
{$oSpecialOffer} |
A Product-object |
Example product category image |
{$aProductCategoryProducts} |
An array of Product-objects. This code fragment is available in the filesProductCategory1.sub.tpl,
ProductCategory2.sub.tpl, ProductCategory3.sub.tpl and ProductCategory4.sub.tpl
and be used as layout for category pages and certain elements on the modular page.
|
Within the platform, product categories can be used in several places , however, it depends on
the location what object properties a ProductCategory-object has. ProductCategory-objects are
available in following places:
- - Index.tpl
- - ProductCategory1.sub.tpl
- - ProductCategory2.sub.tpl
- - ProductCategory3.sub.tpl
- - ProductCategory4.sub.tpl
- - SubCategory1.sub.tpl
- - SubCategory2.sub.tpl
ProductCategory in Index.tpl
ProductCategory-objects in the file Index.tpl are usually used to build the navigation structure
within the theme. In below tables the object properties are named and it is mentioned in which
code fragments these object properties are available.
Objectproperties
Property |
Description |
Id |
Unique ID of product category. |
ParentId |
ID of upper category. |
Name |
Name of category. |
Description |
Description of category |
ShowOrderButton |
true of false.This attribute may be used to determine if an order
button should be shown or not. This depends on the setting chosen for the category in
question in the catalogue module.
|
ApplyPhotoEnlargement |
true of false.This attribute may be used to determine if a large
picture should be shown or not. This depends on the setting chosen for the category in
question in the catalogue module.
|
ApplyPhotoCanvas |
true of false.This attribute may be used to determine if a canvas
image shoud be used or not. This depends on the setting chosen for the category in
question in the catalogue module.
|
ProductsPerPage |
Number of products that is shown per page within the category in question. This depends
on the setting chosen for the category in question in the catalogue module.
|
Deeplink |
Link to the product category page. |
SubCategories |
An array of ProductCategory-objects, within the main category if the main category
contains sub categories. With in a sub categorie is possible to loop the sub
categories again. This can up to three deep.
|
Available in code fragment
Codefragment |
Variable |
Description |
Catalogue (with subcategories) |
{$aCategories} |
An array of ProductCategory- objects. |
Catalogue (without subcategories) |
{$aCategories} |
An array of ProductCategory- objects. |
ProductCategory in ProductCategory(1|2|3|4).sub.tpl
ProductCategory-objects within the files ProductCategory1.sub.tpl, ProductCategory2.sub.tpl,
ProductCategory3.sub.tpl and productCategory4.sub.tpl are used to give supplementary information
within a product category description. In below tables the object properties are mentioned as
well as the code fragments in which the object properties are available.
Object properties
Property |
Description |
Id |
Unique ID of product category. |
ProductCount |
Total number of products in the product category. |
CurrentSubPage |
Currently active subpage. |
ProductsPerPage |
The number of products that can be displayed for each page. |
ShowOrderButton |
true of false. This attribute can be used to determine if an order
button should be shown or not. This depends on the chosen setting for the category in
question in the catalogue module.
|
ApplyPhotoEnlargement |
true of false. This attribute can be used to determine if a large
picture should be shown or not. This depends on the setting chosen for the category in
question in the catalogue module.
|
ApplyPhotoCanvas |
true of false. This attribute can be used to determine if a canvas
image should be used or not. This depends on the setting chosen for the category in
question in the catalogue module.
|
Available in code fragment
Codefragment |
Variable |
Description |
Example product category image |
{$oProductCategory} |
A Productcategory-object. |
ProductCategory in SubCategory(1|2).sub.tpl
ProductCategory-objects in the files SubCategory1.sub.tpl and SubCategory2.sub.tpl are used to
show the subcategories within a product category image. In below tables the object properties
are named. and also in which code fragments these object properties are available.
Objectproperties
Property |
Description |
Id |
Unique ID of product category. |
Name |
Name of subcategory. |
Description |
Description of subcategory. |
ShowOrderButton |
true of false. This attribute can be used to determine if an order
button should be shown or not. This depends on the chosen setting for the category in
question in the catalogue module true of false.
|
ApplyPhotoEnlargement |
true of false. This attribute can be used to determine if a large
picture should be shown or not. This depends on the setting chosen for the category in
question in the catalogue module.
|
ApplyPhotoCanvas |
true of false. This attribute can be used to determine if a canvas
image should be used or not. This depends on the setting chosen for the category in
question in the catalogue module.
|
Deeplink |
Link to the product category page. |
MainImageDeeplink |
Link to the image of the product category. |
Beschikbaar in codefragment
Codefragment |
Variable |
Description |
Example subcategories within category |
{$aProductCategorySubCategories} |
An array of ProductCategory-objects. |
Object properties
Property |
Description |
Name |
Name of feed:
- Latest product.
- Most popular offers.
- Latest news.
|
Deeplink |
Link to RSS feed in question. |
Available in codefragement
Codefragment |
Variable |
Description |
List of RSS feeds |
{$aRSSFeeds} |
An array of RSSFeed-objects |
Object properties
Property |
Description |
Platform |
Name of platform:
- Facebook.
- Google.
- Instagram.
- LinkedIN.
- Pinterest.
- Twitter.
- Youtube.
|
AccountName |
Accountnaam on platform |
Deeplink |
Link to account in question. |
HasIcon |
Does it have a custom icon. |
Icon |
The custom svg wrapped around an <i> tag in a string. |
Available in codefragment
Codefragment |
Variable |
Description |
Social Media Accounts |
{$aSocialMediaAccounts} |
An array van SocialMediaAccount-objects. |
If you develop a theme for an end user who does not have any knowledge of web development, you
can add end user settings to your theme. The end user can manage those settings trough input
field in the settings of the template. Every user settings is part of a category, A minimum of
one end user category setting should be created to be able to create end user settings.
These
In order to create structure, end user settings should be distinguished into categories.
Categories are divided into three types namely: Template, Product and Category. The type define
where those user settings are displayed and where the end user is able to enter their value. For
categories with the type `tempalte` each category is represented as a separate tab for the end
user, where for each tab/category the settings created for the end user can be represented.
Examples of categories may be: “General”, “Colours”, Main page” etc.
There are three category types, namely: Template, Product and Category. Those types represent
where the end user settings are displayed. Categories with the type `Template` are displayed in
the settings of the template. Categories with the type `Product`, and with the type `Category`
are displayed in the category. The last two categories are a bit different then the `Template`
type. Only settings of the active template are displayed on every product and category. Each
value entered in the end user settings at a product or category are linked/ saved at the
product/ category. And unlike the template type different end user categories are not displayed
in multiple tabs but in different cards (this is a because the limited horizontal screen size).
When you copy a product the end user setting value is also copied, when you delete an end user
setting, the value is also deleted.
Inputfield |
Description |
Label |
Label of the setting. This is the naming of the setting in the dialogue window for the
end user.
|
Variable name |
Name of the variable the value can be read out with. The chosen variable name should be
unique for each separate theme. In order to print the value of a variable the entering
{$oEndUserSetting->VariableName} is used, 'VariableName' being the chosen variable name.
The variable name may exclusively contain alfa numeric characters.
|
Type |
- Text, an input field for a text line.
- Tekstbox, a text field.
- Tekstbox with layout and textfield provided with layout options.
- Menu, a selection box containing a minimum of two choices. As many choices a
desired may be added.
- Upload field for an image. The end user may select and upload a file.
- Colour option box, a field that allows the end user to select a colour by using
a colour palette.
- Numeric value, an input field for a numeric value.
|
Standard value |
The standard value for the setting if end user has not selected a a value. |
The end user settings that were created are shown in the item “Code fragments” as a special item.
By clicking an end user setting it is placed in the active editor. If the work field layout
“Theme file as well as separate CSS window” is used, this means that the implementation code is
placed in the editor for theme file or CSS file. The end user settings may be used in the theme
files Index.tpl, ProductLayouts, ProductCategories, Template.css and Scrtipts.js.
Implementing Product and Category end user settings. When you edit the index.tpl the system does
not know which product you are viewing therefore you need too tell it. You can do that with the
exampled below where $iProductId and $iCategory id is the corresponding id.
Display product variable on the Index.tpl:
{\Protom\EndUserSetting::Product($iProductId)->variable_name}
Display category variable on the Index.tpl:
{\Protom\EndUserSetting::Category($iCategoryId)->variable_name}
On the other hand on the product page you can use the following examples to retreive end user
settings, for more information see EndUserSettingCollection:
Display product variable on the ProductLayout:
{$Product->EndUserSetting->Settings["variable_name"]}
{* or with some magic you are able too get like so *}
{$Product->EndUserSetting->variable_name}
Display category variables on the ProductLayout:
{$Product->Category->Categories[0]->EndUserSetting->Settings["variable_name"]} {* Where 0 is the first category *}
{* or with some magic you are able too get like so *}
{$Product->Category->Categories[0]->EndUserSetting->variable_name}
Display template variable on the ProductLayout:
{$Page->Template->EndUserSetting->Settings["variable_name"]}
{* or with some magic you are able too get like so *}
{$Page->Template->EndUserSetting->variable_name}
When you use the "magic" way (`->EndUserSetting->variable_name`) you can not use the
variable names "IsActive" or "Settings", those are reserved. Use
EndUserSetting->Settings["IsActive"] instead.
There no such thing for the Category page.. yet
If your webshop uses multilingual spport you may want to include multiligual variables in the
theme you develop. E.g. a shoppingcart image you developed yourself. You may wish to show
“Shopping basket”, but to your English visitors you may like to show “Shoppingcart”. Following
documentation and examples will teach you how to realise this.
If you do not specify a translation for a certain language ( read following syntax-structure) ,
and the webshop is represented in that language, the translation you specified first will be
shown automatically. It makes no difference in which order the translations are placed.
Each text you wish to present multilangually, should get a multilingual definition.
The
syntax of such a definition consists of a number of elements:
Syntax |
Description |
{* ml |
This indicates that a multilingual translation will start. Attention: spacing at the end
is obligatory!.
|
sPlaceHolderName |
Name of the variable that is defined. |
:nl[Vertaling]
:en[Translation]
:de[Uebersetzung]
:fr[Traduction]
:tr[Çeviri]
|
Here the translation is given for each language. A language starts with a semicolon
followed by the language code. The translation per language is represented by square
brackets.
|
/ml *} |
This indicates the end of a multilingual translation. |
Language code |
Language |
nl |
Dutch. |
en |
English. |
de |
German. |
fr |
French. |
tr |
Turkish. |
Extensive notation:
{* ml
sHelloWorld
:nl[Hallo wereld]
:en[Hello world]
:de[Hallo Welt]
:fr[Bonjour monde]
/ml *}
My multilingual variable: {$sHelloWorld}
Shortened notation:
{* ml sHelloWorld:nl[Hallo wereld]:en[Hello world]:de[Hallo Welt]:fr[Bonjour monde]/ml *}
My shortened notation multilingual variable: {$sHelloWorld}
No translation for every language:
Note: In this example the active language of the webshop is Dutch, the English language will be
shown.
{* ml
sHelloWorld
:en[Hello world]
:de[Hallo Welt]
/ml *}
My multilingual variable: {$sHelloWorld}
AJAX Widgets are widgets that can contain a certain content and can be restored “below water”
(showing formatting and styles) without the page the visitor is on at that moment having to be
loaded again. AJAX stands for Asynchronous Javascript And XML meaning that the data will be
retrieved asynchronously from the webserver.
This is a technique that allows you to make pages interactive without having to restore a whole
page. Below is described how to recognize and apply an AJAX Widget, followed by the description
of AJAX Widgets available.
Syntax |
Description |
{* plugin *} |
This indicates the start of an AJAX Widget. |
<div id=""> |
The div in which the AJAX Widget-code is placed. The ID of the div
should be a valid AJAX Widget-name (see available AJAX Widgets). If no valid ID is
specified and the syntax is correct, the theme is filed but there is no
callback-function in the webshop that will trigger this AJAX Widget.
|
</div> |
The closing tag of the div in which the AJAZX widget-code is placed. |
{* /plugin *} |
This indicates that an AJAX Widget ends. |
Example:
{* plugin *}
<div id="SmallBasket">
// Widget code
</div>
{* /plugin *}
Following AJAX Widgets are available:
Shopping basket
The shopping basket is a typical example of anAJAX Widget. It is often an item that you wish to
present clean-cut, well-organized and well-considered. A shopping basket as AJAX Widget is very
user friendly because the option “Show dialogue window shopping cart”( My
webshop/Settings/Orderproces and stock/Order proces settings) is available. The shopping basket
information is automatically updated as soon as a visitor places a product in the shopping
basket, without the page reloading again.
Basic code
{* plugin *}
<div id="SmallBasket">
</div>
{* /plugin *}
Available variables within this widget
Variable |
Content and data type of variable |
{$aOrderRows} |
An array of OrderRow-objects (see 'List of objects') |
Example:
{* plugin *}
<div id="SmallBasket">
{if $aOrderRows|@count eq 0}
{* ml
sBasketLine
:nl[Er zijn nog geen producten in uw winkelmand geplaatst.]
:en[There are no products in your shopping cart yet.]
:de[Es gibt keine Produkte in Ihrem Warenkorb.]
:fr[Il n'y a aucun produit dans votre panier pour le moment.]
/ml *}
{$sBasketLine}
{else}
<table cellpadding="0" cellspacing="0" width="100%">
{$fTotal = 0}
{foreach from=$aOrderRows item=oOrderRow}
{$fTotal = $fTotal + $oOrderRow->TotalPrice}
<tr>
<td style="width:30px; text-align:center;">{$oOrderRow->Count}</td>
<td style="width:15px;"> × </td>
<td>{$oOrderRow->ProductName|middle_truncate:50:3}</td>
<td style="width:15px; text-align:center;"> {$sCurrency} </td>
<td style="width:50px; text-align:right;">{$oOrderRow->PriceFormatted}</td>
</tr>
{/foreach}
<tr>
<td colspan="3"></td>
<td style="width:15px; text-align:center;"> {$sCurrency} </td>
<td style="width:50px; text-align:right;">{$fTotal|number_format:'2':',':'.'}</td>
</tr>
</table>
{* ml
sPayButton
:nl[Afrekenen]
:en[Checkout]
:de[Abrechnen]
:fr[Régler]
/ml *}
<input type="button" value="{$sPayButton}" onclick="window.location = '{$sBasketPageDeeplink}';"/>
{/if}
</div>
{* /plugin *}
Action Hooks are the link between your Pro-Tom design and the internal functionality of the
webshop platform. Action Hooks are marked out because they are hooked via the
class-attribute.
Adds a product to the visitor's shopping basket.
Conditional functioning based on settings.
Settings “Functioning order button & shoppingcart' |
Location |
Startingpoint / My webshop / Settings / Order proces settings |
Behaviour based on value |
- To shopping cart-page - visitor is forwarded to the shopping
basket page.
- Show dialogue window shopping cart - visitor remains on current
page and is shown a dialogue window showing the added product including
quantity.
|
Data-attributes
Attribute |
Obligatory |
Description |
data-product-id |
Yes |
Unique product id (Product::Id) |
data-quantity |
No |
Quantity ordered. The action hook only accepts an integer-value, all other values are
converted to '1'.
|
Example
<span class="hook_AddProductToCart PredefinedButton" data-product-id="123">
Bestellen
</span>
Example with order quantity input field
<script type="text/javascript">
$(document).ready(function() {
$('.change-quantity').keyup(function() {
// Controleren op een integer-invoerwaarde, anders de waarde 1 toekennen
var iNewQuantity = Math.floor($(this).val()) == $(this).val() && $.isNumeric($(this).val())
? $(this).val()
: 1;
$(this)
.parent()
.find('.hook_AddProductToCart')
.attr(
'data-quantity',
iNewQuantity
);
});
});
</script>
<div>
<input type="text" class="change-quantity" value="1"/>
<span class="hook_AddProductToCart PredefinedButton" data-product-id="123" data-quantity="1">
Bestellen
</span>
</div>
Adds a product to the visitor's shopping basket.
Conditional functioning based on settings.
Settings “Functioning order button & shoppingcart' |
Location |
Startingpoint / My webshop / Settings / Order proces settings |
Behaviour based on value |
- To shopping cart-page - visitor is forwarded to the shopping
basket page.
- Show dialogue window shopping cart - visitor remains on current
page and is shown a dialogue window showing the added product including
quantity.
|
Data-attributes
Attribute |
Obligatory |
Description |
data-product-id |
Yes |
Unique product id (Product::Id) |
form requirements
input name |
Obligatory |
Description |
product_amount |
No |
Input field for the amount of products you would like to order. |
product_attribute{$Option->Id} |
No |
Input field used for each of the product attributes. it is essential to use the
{$Option->Id} within the name for this to work correctly.
|
product_upload |
No |
Input field for uploading a file, like an image that needs to be printed onto the
product.
|
Button hook |
No |
The button hook can be used instead of defining the hook manually, but this can only be
done while using the factory products implementation.
|
Callbacks (ajaxRequest)
Callbacks can be used to fetch the result of the hook action.
Callback |
Type |
Description |
doOrder |
Callback function name. |
This is the callback function name used for obtaining the original call's result. |
onSuccess |
Succes |
Adding the product to the basket was succesfull. |
onError |
Error |
Adding the product to the basket didn't happen due to any errors. |
Callback content
The content of any returned callback.
Name |
Type |
Description |
product_id |
(number), the product id. |
The product id can be used to target a specific error or success class on the page. |
messages |
Array of messages. |
Result messages of a callback. |
message: attributecombinations |
attributecombinations |
Result message, attributecombination error defined as name: attributecombinations |
message: amount |
amount |
Result message, amount error, like minimal amount not reached, defined as name: amount
|
message: stock |
stock |
Result message, stock error, like product is out of stock, defined as name: stock |
Example of the button (manual)
<span class="hook__global__product-order PredefinedButton" data-product-id="123">
Bestellen
</span>
Example of the button (using the factory
products)
<a class="cs-button cs-button--primary product__button--order {$Product->Button->Hook}" data-product-id="{$Product->Id}" tabindex="0">{$Product->Button->Caption}</a>
Example with a form, including a quantity input field.
<div>
<form name='form-product'>
<input type="text" name="product_amount" class="change-quantity" value="1"/>
<span class="hook__global__product-order PredefinedButton" data-product-id="123">
Bestellen
</span>
</form>
</div>
Example with a form, including a quantity input field and some attribute combination
fields.
<div>
<form name='form-product'>
{foreach $Product->Attribute->Option->Options as $Option}
{if $Option->Type == 2 || $Option->Type == 3}
<div class="product__attribute product__attribute--input">
<label>{$Option->Option} {if $Option->IsRequired}*{/if}</label>
<input type="text" name="product_attribute[{$Option->Id}]" value="{$Option->Attributes[0]->Value}">
</div>
{else}
<div class="product__attribute product__attribute--select">
<label>{$Option->Option} {if $Option->IsRequired}*{/if}</label>
<select name="product_attribute[{$Option->Id}]">
{foreach $Option->Attributes as $Attribute}
<option value="{$Attribute->Id}"
{if $Attribute->IsSelected}selected="selected"{/if}>
{$Attribute->Value}
</option>
{/foreach}
</select>
</div>
{/if}
{/foreach}
<input type="text" name="product_amount" class="change-quantity" value="1"/>
<span class="hook__global__product-order PredefinedButton" data-product-id="123">
Bestellen
</span>
</form>
</div>
Example of using callbacks.
$(document).ready(function() {
ajaxRequest.doOrder({
onError: function(data) {
$.each(data.messages, function (index, message) {
$('.error__' + data.product_id + '__' + message.toLowerCase()).show();
});
}
});
});
<div class="error-messages error__{$Product->Id}__attributecombinations" style="display:none;"> Attribute combination error!</div>
<div class="error-messages error__{$Product->Id}__amount" style="display:none;"> The minimal order amount is not reached!</div>
<div class="error-messages error__{$Product->Id}__stock" style="display:none;"> This product is currently not in stock!</div>
Sign on a visitor for the newsletter on the mailing list “Logged on via website”. In
input-elements the action hook will check if enter was pressed and will try to sign on the
visitor. The action hook reacts on click-events on all other element types. A succesful log on
ensues if a name and valid email address have been entered.
Attention: the implementation code should be nested in an element
with the id NewsMailRegistration, otherwise the action hook logic required will not be loaded!
DOM-elements
Element |
Obligatory |
Description |
input#NewsEmailEmail |
Yes |
Mail address of the subschriber. |
input#NewsEmailName |
No |
Name of subscriber. |
input#NewsEmailBName |
No |
Company name of subscriber. |
Result shown
Element |
Description |
#NewsLetterEmailError |
Is filled with the result of the logon:
- You were succesfully signed on for the newsletter
- This email address was added to the list
- This is an invalid email address
|
Example
<div id="NewsMailRegistration">
<div id="NewsLetterEmailError"></div>
<input type="text" id="NewsMailName" class="hook_SubscribeToNewsletter" placeholder="Uw naam"/><br/>
<input type="text" id="NewsMailEmail" class="hook_SubscribeToNewsletter" placeholder="Uw e-mailadres"/><br/>
<a href="#" class="hook_SubscribeToNewsletter PredefinedButton">
Aanmelden
</span>
</div>
You can customize the entire product page, from rearrage to delete or add content, even put
confetti on your order button when pressed. Here I will describe how you do all of this. There
are a couple of things you need to know before you start. The available variabels, hooks,
placeholders an javascript objects. Lets start with the variabels.
In ProductLayout1.tpl and ProductLayout2.tpl are 2 variabels available, namely $Page and
$Product
Type |
Property |
Description |
string |
$Title |
The page title |
\Decorator\Protom\Page\Product |
$Page |
The current product page |
\Decorator\Protom\Page\Product\Template |
$Template |
The template to use |
\Decorator\Protom\Page\Metadata |
$Metadata |
of the page |
\Decorator\Protom\Page\Product\Review |
$Review |
Review settings of the page |
\Decorator\Protom\Product |
$Product |
The Currently viewed product of the product page |
\Decorator\Protom\Page\Product\Question |
$Question |
The question settings |
\Decorator\Protom\Page\Product\ViewedRecently |
$ViewedRecently |
Recently viewed products |
\Decorator\Protom\Page\Product\ViewedByOthers |
$ViewedByOthers |
Product viewed by others |
\Decorator\Protom\Page\Product\MostViewed |
$MostViewed |
Most viewed products |
\Decorator\Protom\Page\Product\Compare |
$Compare |
Compare setting |
\Decorator\Protom\Page\Product\Breadcrumb |
$Breadcrumb |
The breadcrumb |
\Decorator\Protom\Page\Product\WishlistCollection |
$CustomerWishlist |
The wishlist |
\Decorator\Protom\Page\Product\CalculatorSummary |
$CalculatorSummary |
The calculation summary of the set |
Place holders are classes where pieces of content will be loaded when hooks or ajaxrequests are
triggered. When not implemented the page will not be dynamic. The functions and placeholders
have a link based on their name. For example the content of "function ProductPhoto" will be
loaded in element with the class "page__product__photo". It is possible to use the same
placeholder multiple times.
Function |
Placeholder |
ProductShortDescription |
page__product__short-description |
ProductReview |
page__product__review |
ProductStock |
page__product__stock |
ProductPrice |
page__product__price |
ProductStaggeredPrice |
page__product__staggered-price |
ProductVariation |
page__product__variation |
ProductAttribute |
page__product__attribute |
ProductAmount |
page__product__amount |
ProductCreditpoint |
page__product__creditpoint |
ProductButton |
page__product__button |
Wishlist |
page__wishlist |
Compare |
page__compare |
ProductMainPhoto |
page__product__main-photo |
ProductDescription |
page__product__description |
ProductProCon |
page__product__pro-con |
ProductKeyword |
page__product__keyword |
ProductProperty |
page__product__property |
ViewedRecently |
page__viewed-recently |
ProductRelevant |
page__product__relevant |
ViewedByOthers |
page__viewed-by-others |
MostViewed |
page__most-viewed |
ProductBundle |
page__product__bundle |
ProductVideo |
page__product__video |
ProductUpload |
page__product__upload |
ProductAttachment |
page__product__attachment |
ProductImage |
page__product__image |
ProductPhoto |
page__product__photo |
Breadcrumb |
page__breadcrumb |
ProductReviewSummary |
page__product__review-summary |
Question |
page__question |
ProductDeposit |
page__product__deposit |
ProductVariations |
page__product__variations |
ProductAttributes |
page__product__attributes |
WishList |
page__wish-list |
ProductInformation |
page__product__information |
ProductProcon |
page__product__procon |
ProductCreditPoint |
page__product__credit-point |
Ajax request performs actions and update placeholders with the current data. You as a developer
can catch the success and error events of those ajax requests. Or load placeholders with ajax
instead on page load to increase performance.
Action |
Description |
ajaxRequest.load |
The "functions" function will be loaded with ajax and place in the correspondending
placeholder, see example below
|
ajaxRequest.doOrder |
Adds the current $Product to the basket |
ajaxRequest.doAmountChange |
Performs an amount change |
ajaxRequest.doAttributeChange |
Perfomrs an attribute change |
ajaxRequest.doAddReview |
Adds an review to the product |
ajaxRequest.doAskAQuestion |
Sends an Ask A Question email with the .form-ask-a-question contents |
ajaxRequest.doProductUpload |
Uploads a file to the $Product |
ajaxRequest.doQuotation |
Add the current $Product to the quoation |
Example #1
Loads functions in their places on document ready
$(document).ready(function () {
ajaxRequest.load({
functions: ['ViewedRecently', 'ProductRelevant', 'MostViewed', 'ViewedByOthers', 'ProductBundle'],
onSuccess: function () {
InitViewedRecently();
InitProductRelevant();
InitMostViewed();
InitViewedByOthers();
},
});
});
Example #2
Puts confetti on your screen when order button is pressed.
{if $Page->Template->IsProtom}
<script src="https://protom.ccvshop.nl/assets/confetti.js/confetti.min.js"></script>
{/if}
<script>
$(document).ready(function () {
ajaxRequest.doOrder({
onSuccess: function () {
confetti.start()
},
});
});
</script>
You can customize the entire category page, from rearrage to delete or add content, even put
confetti on your order button when pressed. Here I will describe how you do all of this. There
are a couple of things you need to know before you start. The available variabels, hooks,
placeholders an javascript objects.
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | If this Description is visible on the page. |
string | $Value | The Bottom description in text. |
boolean | $IsVisible | If this Description is visible on the page. |
string | $Value | The Bottom description in text. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | If this Description is visible on the page. |
string | $Value | The top description in text. |
\Decorator\Protom\Category\Photo | $Photo | The photo used in the top description. |
boolean | $IsVisible | If this Description is visible on the page. |
string | $Value | The top description in text. |
\Decorator\Protom\Category\Photo | $Photo | The photo used in the top description. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the compare functionality visible. |
\Decorator\Protom\Category\Description\Top | $Top | The Top description and photo from the category. |
\Decorator\Protom\Category\Description\Bottom | $Bottom | The Bottom description from the category. |
boolean | $IsVisible | Is the compare functionality visible. |
\Decorator\Protom\Category\Description\Top | $Top | The Top description and photo from the category. |
\Decorator\Protom\Category\Description\Bottom | $Bottom | The Bottom description from the category. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Description functionality visible. |
\Decorator\Protom\Category\Description[] | $Descriptions | A collection of descriptions. |
boolean | $IsVisible | Is the Description functionality visible. |
\Decorator\Protom\Category\Description[] | $Descriptions | A collection of descriptions. |
ObjectpropertiesType | Property | Description |
string | $Value | The value of this enduserSetting |
string | $Value | The value of this enduserSetting |
ObjectpropertiesType | Property | Description |
boolean | $IsActive | Are there any end user settings active for this product. |
\Decorator\Protom\Category\EndUserSetting[] | $Settings | The end user settings. |
boolean | $IsActive | Are there any end user settings active for this product. |
\Decorator\Protom\Category\EndUserSetting[] | $Settings | The end user settings. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the subcategory collection visible. |
boolean | $IsPartOfFilters | Is the subcategory collection visible. |
string | $deprecated_TemplatePath | Deprecated path to the template. |
\Decorator[] | $deprecated_SubCategories | Deprecated collection of subcategories. |
boolean | $IsVisible | Is the subcategory collection visible. |
boolean | $IsPartOfFilters | Is the subcategory collection visible. |
string | $deprecated_TemplatePath | Deprecated path to the template. |
\Decorator[] | $deprecated_SubCategories | Deprecated collection of subcategories. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is this category visible. |
\Decorator\Protom\Category\Product | $Product | Collections of products. |
int | $Id | The id of this category. |
string | $Name | The Name op this category. |
string | $Uri | The URI of this category. |
string | $Alias | The alias of the category. |
\Decorator\Protom\Category\PhotoCollection | $Photo | A collection of photo's linked to this category. |
boolean | $ProductsHaveCanvasPhotos | If product photo should be shown as canvas. |
\Decorator\Protom\Category\SubCategory | $SubCategory | A collection of this category's child categories. |
\Decorator\Protom\Category\EndUserSettingCollection | $EndUserSetting | A collection of end user settings linked to this category. |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | The page parameters. Similar to $Page->Parameter. |
\Decorator\Protom\Category\DescriptionCollection | $Description | The page Descriptions set in the category. |
boolean | $IsVisible | Is this category visible. |
\Decorator\Protom\Category\Product | $Product | Collections of products. |
int | $Id | The id of this category. |
string | $Name | The Name op this category. |
string | $Uri | The URI of this category. |
string | $Alias | The alias of the category. |
\Decorator\Protom\Category\PhotoCollection | $Photo | A collection of photo's linked to this category. |
boolean | $ProductsHaveCanvasPhotos | If product photo should be shown as canvas. |
\Decorator\Protom\Category\SubCategory | $SubCategory | A collection of this category's child categories. |
\Decorator\Protom\Category\EndUserSettingCollection | $EndUserSetting | A collection of end user settings linked to this category. |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | The page parameters. Similar to $Page->Parameter. |
\Decorator\Protom\Category\DescriptionCollection | $Description | The page Descriptions set in the category. |
ObjectpropertiesObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the compare functionality visible. |
string | $Deeplink | A link to the comparison page. |
boolean | $IsVisible | Is the compare functionality visible. |
string | $Deeplink | A link to the comparison page. |
ObjectpropertiesType | Property | Description |
boolean | $IsSelected | Is this display type selected. |
string | $Hook | Defines the js hook of this button. |
int | $Layout | The ID of this display type. |
string | $Icon | The icon that represents this display type. |
boolean | $IsSelected | Is this display type selected. |
string | $Hook | Defines the js hook of this button. |
int | $Layout | The ID of this display type. |
string | $Icon | The icon that represents this display type. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Should the display type selection be visible. |
\Decorator\Protom\Page\Category\DisplayType\DisplayType[] | $DisplayTypes | Collection of the different display types. |
\Decorator\Protom\Page\Category\DisplayType\DisplayType | $Selected | The selected display type. |
boolean | $IsVisible | Should the display type selection be visible. |
\Decorator\Protom\Page\Category\DisplayType\DisplayType[] | $DisplayTypes | Collection of the different display types. |
\Decorator\Protom\Page\Category\DisplayType\DisplayType | $Selected | The selected display type. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the Filter functionality visible. |
int | $Id | The Id of the Filter. |
boolean | $IsSelected | Is the Filter selected. |
boolean | $IsColor | Is the Filter from the type color. |
boolean | $IsCheckBox | Is the Filter from the type checkbox. |
boolean | $IsInput | Is the Filter from the type input. |
boolean | $IsRangeStepSlider | Is the Filter from the type RangeStepSlider. |
boolean | $IsDropDown | Is the Filter from the type Dropdown. |
boolean | $IsRangeSlider | Is the Filter from the type RangeSlider. |
string | $Type | The type Sort of the filter. |
string | $Property | The Property of the filter. |
string | $Name | The Name of the filter. |
string | $Hook | The Hook of the filter. |
\Decorator\Protom\Page\Category\Filter\Value[] | $Values | The Values of the filter. |
\Decorator\Protom\Page\Category\Filter\Shortlist | $Shortlist | The Shortlist values of the filter. |
boolean | $IsVisible | Is the Filter functionality visible. |
int | $Id | The Id of the Filter. |
boolean | $IsSelected | Is the Filter selected. |
boolean | $IsColor | Is the Filter from the type color. |
boolean | $IsCheckBox | Is the Filter from the type checkbox. |
boolean | $IsInput | Is the Filter from the type input. |
boolean | $IsRangeStepSlider | Is the Filter from the type RangeStepSlider. |
boolean | $IsDropDown | Is the Filter from the type Dropdown. |
boolean | $IsRangeSlider | Is the Filter from the type RangeSlider. |
string | $Type | The type Sort of the filter. |
string | $Property | The Property of the filter. |
string | $Name | The Name of the filter. |
string | $Hook | The Hook of the filter. |
\Decorator\Protom\Page\Category\Filter\Value[] | $Values | The Values of the filter. |
\Decorator\Protom\Page\Category\Filter\Shortlist | $Shortlist | The Shortlist values of the filter. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the SelectedFilter functionality visible. |
\Decorator\Protom\Page\Category\Filter\SelectedFilters[] | $SelectedFilters | The selected Filters In the Filter. |
boolean | $IsVisible | Is the SelectedFilter functionality visible. |
\Decorator\Protom\Page\Category\Filter\SelectedFilters[] | $SelectedFilters | The selected Filters In the Filter. |
ObjectpropertiesType | Property | Description |
int | $ | $Id The Id from the selected filters. |
string | $Description | The Description from the selecterd filters as Filtername: all filter selected values. |
string | $FilterName | The name of the Selected Filter. |
string | $FilterType | The Filter Type of the Selected Filter. |
string | $Hook | The hook to reset the selected filter |
array | $ | $FilterSelectedValues A collection of values from the selected filter. |
int | $ | $Id The Id from the selected filters. |
string | $Description | The Description from the selecterd filters as Filtername: all filter selected values. |
string | $FilterName | The name of the Selected Filter. |
string | $FilterType | The Filter Type of the Selected Filter. |
string | $Hook | The hook to reset the selected filter |
array | $ | $FilterSelectedValues A collection of values from the selected filter. |
ObjectpropertiesObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the compare functionality visible |
string | $Name | |
string | $Tooltip | |
string | $Hook | |
boolean | $IsSelected | |
boolean | $IsOnShortlist | |
boolean | $IsVisible | Is the compare functionality visible |
string | $Name | |
string | $Tooltip | |
string | $Hook | |
boolean | $IsSelected | |
boolean | $IsOnShortlist | |
string | $Class | |
string | $Style | |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the compare functionality visible |
string | $Name | |
string | $Tooltip | |
string | $Hook | |
boolean | $IsSelected | |
boolean | $IsOnShortlist | |
boolean | $IsVisible | Is the compare functionality visible |
string | $Name | |
string | $Tooltip | |
string | $Hook | |
boolean | $IsSelected | |
boolean | $IsOnShortlist | |
string | $Prefix | |
string | $Suffix | |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the compare functionality visible |
string | $Name | |
string | $Tooltip | |
string | $Hook | |
boolean | $IsSelected | |
boolean | $IsOnShortlist | |
boolean | $IsVisible | Is the compare functionality visible |
string | $Name | |
string | $Tooltip | |
string | $Hook | |
boolean | $IsSelected | |
boolean | $IsOnShortlist | |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the compare functionality visible. |
\Decorator\Protom\Page\Category\Filter\Filter[] | $Filters | The Filter for the object. |
\Decorator\Protom\Page\Category\Filter\SelectedFilter | $SelectedFilter | The Selected filters for the object. |
boolean | $IsVisible | Is the compare functionality visible. |
\Decorator\Protom\Page\Category\Filter\Filter[] | $Filters | The Filter for the object. |
\Decorator\Protom\Page\Category\Filter\SelectedFilter | $SelectedFilter | The Selected filters for the object. |
ObjectpropertiesType | Property | Description |
integer | $Value | The amount of items per page. |
boolean | $IsSelected | If this value is selected. |
integer | $Value | The amount of items per page. |
boolean | $IsSelected | If this value is selected. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | If the items per page should be displayed. |
ItemsPerPage[] | $ItemsPerPage | The possible items per page that could be shown. |
ItemsPerPage | $Selected | The selected value. |
string | $Hook | The Hook of ItemsPerPage. |
boolean | $IsVisible | If the items per page should be displayed. |
ItemsPerPage[] | $ItemsPerPage | The possible items per page that could be shown. |
ItemsPerPage | $Selected | The selected value. |
string | $Hook | The Hook of ItemsPerPage. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | If this page is visible. |
boolean | $IsSelected | If this page is selected. |
string | $Uri | The URI of this page. |
string | $Hook | Defines the js hook of this button. |
int | $PageNumber | The number of this page. |
ObjectpropertiesType | Property | Description |
\Decorator\Protom\Page\Category\Pagination\Page[] | $Pages | Collection of all pages. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | If pagination should be shown. |
int | $NumberOfPages | Number of pages. Can be zero. |
boolean | $IsPageRange | Is there should be a range of pages shown. |
boolean | $IsNextPageOnScroll | If the next page is shown on scroll. |
boolean | $IsNextPageOnClick | If the next page is shown on click. |
\Decorator\Protom\Page\Category\Pagination\PageCollection | $Page | A colleciton of all available pages. |
\Decorator\Protom\Page\Category\Pagination\Page | $Selected | The current page. |
\Decorator\Protom\Page\Category\Pagination\Page | $Previous | The previous page. |
\Decorator\Protom\Page\Category\Pagination\Page | $Next | The next page. |
string | $Hook | Defines the js hook of this page. |
boolean | $IsVisible | If pagination should be shown. |
int | $NumberOfPages | Number of pages. Can be zero. |
boolean | $IsPageRange | Is there should be a range of pages shown. |
boolean | $IsNextPageOnScroll | If the next page is shown on scroll. |
boolean | $IsNextPageOnClick | If the next page is shown on click. |
\Decorator\Protom\Page\Category\Pagination\PageCollection | $Page | A colleciton of all available pages. |
\Decorator\Protom\Page\Category\Pagination\Page | $Selected | The current page. |
\Decorator\Protom\Page\Category\Pagination\Page | $Previous | The previous page. |
\Decorator\Protom\Page\Category\Pagination\Page | $Next | The next page. |
string | $Hook | Defines the js hook of this page. |
ObjectpropertiesType | Property | Description |
string | $Name | Display name of this sorting option. |
string | $Value | The value that should be passed when changed. |
boolean | $IsSelected | If this value is the current selected value. |
string | $Name | Display name of this sorting option. |
string | $Value | The value that should be passed when changed. |
boolean | $IsSelected | If this value is the current selected value. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the sorting option visible. |
\Decorator\Protom\Page\Category\SortingOption\SortingOptions[] | $SortingOptions | The different option to use as sorting. |
\Decorator\Protom\Page\Category\SortingOption\SortingOptions | $Selected | The current selected option. |
string | $Hook | The Hook of SortingOptions. |
boolean | $IsVisible | Is the sorting option visible. |
\Decorator\Protom\Page\Category\SortingOption\SortingOptions[] | $SortingOptions | The different option to use as sorting. |
\Decorator\Protom\Page\Category\SortingOption\SortingOptions | $Selected | The current selected option. |
string | $Hook | The Hook of SortingOptions. |
ObjectpropertiesType | Property | Description |
boolean | $IsActive | If there are end user settings for this category. |
\Decorator\Protom\Page\Category\Template\EndUserSetting[] | $Settings | Enduser settings collection. |
boolean | $IsActive | If there are end user settings for this category. |
\Decorator\Protom\Page\Category\Template\EndUserSetting[] | $Settings | Enduser settings collection. |
ObjectpropertiesType | Property | Description |
string | $Name | The given template name. |
string | $Path | The given template path. |
boolean | $IsProtom | Is the template a protom template. |
boolean | $HasCustomBreadcrumb | If the template has a custom breadcrumb the global breadcrumb will be hidden. |
string | $Name | The given template name. |
string | $Path | The given template path. |
boolean | $IsProtom | Is the template a protom template. |
boolean | $HasCustomBreadcrumb | If the template has a custom breadcrumb the global breadcrumb will be hidden. |
string | $WrapperPath | Internal path to load this template. |
\Decorator\Protom\Page\Template\EndUserSettingCollection | $EndUserSetting | Collection of end user settings. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
ObjectpropertiesType | Property | Description |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
ObjectpropertiesType | Property | Description |
string | $Keywords | The metadata keywords. |
string | $Description | The metadata description. |
string | $PageTitle | The metadata page title. |
boolean | $IsNoIndex | Is the page to be indexed. |
boolean | $IsNoFollow | Is a nofollow active on this page. |
string | $Uri | The URI of this page. |
string | $Alias | The alias of the page. |
string | $Deeplink | The deeplink of the page. |
string | $Keywords | The metadata keywords. |
string | $Description | The metadata description. |
string | $PageTitle | The metadata page title. |
boolean | $IsNoIndex | Is the page to be indexed. |
boolean | $IsNoFollow | Is a nofollow active on this page. |
string | $Uri | The URI of this page. |
string | $Alias | The alias of the page. |
string | $Deeplink | The deeplink of the page. |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
int | $Id | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
int | $Id | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
int | $Id | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
int | $Id | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
int | $Id | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
int | $Id | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
int | $Id | |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the most viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
ObjectpropertiesType | Property | Description |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
string | $Title | The page title |
\Decorator\Protom\Page\Category\Template | $Template | The template to use |
\Decorator\Protom\Page\Metadata | $Metadata | of the page |
\Decorator\Protom\Category | $Category | The Currently viewed category of the category page |
\Decorator\Protom\Page\Category\ViewedRecently | $ViewedRecently | Recently viewed products |
\Decorator\Protom\Page\Category\MostViewed | $MostViewed | Most viewed products |
\Decorator\Protom\Page\Category\Compare | $Compare | Compare setting |
\Decorator\Protom\Page\Category\Breadcrumb | $Breadcrumb | The breadcrumb |
\Decorator\Protom\Page\Category\ItemPerPage | $ItemPerPage | |
\Decorator\Protom\Page\Category\SortingOption | $SortingOption | |
\Decorator\Protom\Page\Category\DisplayType | $DisplayType | |
\Decorator\Protom\Page\Category\Pagination | $Pagination | |
\Decorator\Protom\Page\Category\WishlistCollection | $CustomerWishlist | |
\Decorator\Protom\Page\Category\Product\Parameter | $Parameter | |
\Decorator\Protom\Page\Category\FilterCollection | $Filter | |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the takeout checker visible. |
boolean | $IsValid | Is the takeout checker valid. |
string | $Country | The chosen country to check. |
\Decorator\Protom\Page\Takeout\Checkout | $Checkout | The checkout data. |
string | $Zipcode | The given zipcode to check. |
\Decorator\Protom\Page\Takeout\Date | $Date | The given date. |
\Decorator\Protom\Page\Takeout\Slot | $Slot | The reserved slot. |
\Decorator\Protom\Page\Takeout\Message | $Message | A given message. |
array | $Checkouts | An array of checkout types. |
ObjectpropertiesType | Property | Description |
DateTime | $Date | A DateTime formatted date. |
int | $AvailableCapacity | The available capacity. |
int | $Capacity | The current capacity. |
array | $Slots | An array of slots. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the takout message visible. |
string | $Message | The takout message. |
ObjectpropertiesType | Property | Description |
int | $Id | The takout slot id. |
DateTime | $Date | The Date formatted in datetime. |
int | $AvailableCapacity | The available capacity. |
int | $Capacity | The current capacity. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | |
ObjectpropertiesType | Property | Description |
string | $Value | The value of this enduserSetting |
string | $Value | The value of this enduserSetting |
ObjectpropertiesType | Property | Description |
boolean | $IsActive | Are there any enduser settings active for this product. |
\Decorator\Protom\Page\Template\EndUserSetting[] | $Settings | The enduser settings. |
boolean | $IsActive | Are there any enduser settings active for this product. |
\Decorator\Protom\Page\Template\EndUserSetting[] | $Settings | The enduser settings. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is Upselling Visible. |
\Factory\Product\Upselling\Product[] | $Products | The products in the upselling element. |
\Decorator\Protom\Page\Basket\Upselling\Position | $Position | The position of the upselling element. |
boolean | $IsVisible | Is Upselling Visible. |
\Factory\Product\Upselling\Product[] | $Products | The products in the upselling element. |
\Decorator\Protom\Page\Basket\Upselling\Position | $Position | The position of the upselling element. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
boolean | $IsVisible | Are the recently viewed products visible. |
\Decorator\Protom\Product[] | $Products | An array of Products. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
boolean | $IsVisible | Is the button visible. |
string | $Caption | The caption of the button. |
\Decorator\Protom\Page\Wishlist\Icon | $Icon | The icon of the button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
boolean | $IsVisible | Is the icon visible. |
string | $Icon | The HTML string of the icon. |
ObjectpropertiesType | Property | Description |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
int | $Id | Id of the Wishlist. |
string | $Name | Name of the Wishlist. |
string | $Hook | Defines the js hook of this button. |
ObjectpropertiesType | Property | Description |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
boolean | $IsVisible | Is the wishlist collection visible. |
\Decorator\Protom\Page\Wishlist\Button | $Button | The button of the wishlist. |
\Decorator\Protom\Page\Wishlist[] | $Wishlists | An array of wishlists. |
\Decorator\Protom\Page\Wishlist | $New | An array for a new wishlist. |
Objectproperties
According to the GDPR a guest must accept which cookies they are allowing to be set, we
differentiate 3 types of cookies; 'functional','statistic' and 'marketing'. When a cookie is set
`CookiePolice` will check if the type of the cookie matches the
preference. If not, the cookie is denied. To make your life easier, a Cookie class is available
to set and remove cookies.
<script>
let exdate = new Date();
exdate.setDate(exdate.getDate() + 365);
Cookie.set('SetAccordion', 1, {
expires: exdate,
type: Cookiepolice.type.functional
});
Cookie.remove('SetAccordion');
</script>
Which cookies are depending on apps and implementations of third parties. Below is a list of
cookie we (can) set.
Type |
Name |
Description |
Functional |
PHPSESSID |
Here the session id will be stored |
Functional |
cookie_preference |
Stores the cookie preference |
Functional |
CCVPAY_TERMINAL_INFO |
When using an physical pin terminal, the id of that terminal will be stored in here |
Functional |
ml_Language |
Stores the selected language |
Statistics |
shop-visit-uuid |
An unique id for statistical purposes |
Functional |
csrf-token |
A csrf token |
When a guests sets their cookie preference in the cookie bar, you as an developer can hook onto
that action by implementing doSetCookiePreference
<script>
ajaxRequest.doSetCookiePreference({
onSuccess: function() {
console.log("success");
}
});
</script>
You're also able to develop your very own cookiebar. This can all be done by implementing your very own form.
The form will need the call to action hook: hook_UpdateCookiePreferences to work.
The eventual response can be obtained by using the earlier named doSetCookiePreference function.
<div class="CookieBar">
<div>
<div>Some text.</div>
<div>
<form name="form__cookie-preference" id="form__cookie-preference">
<li><input type="checkbox" name="cookies[]" id="preference__necessary" value="functional" checked="checked" disabled /><label for="preference__necessary">Functional</label></li>
<li><input type="checkbox" name="cookies[]" id="preference__statistic" value="statistic" /><label for="preference__statistic">Statistics</label></li>
<li><input type="checkbox" name="cookies[]" id="preference__marketing" value="marketing" /><label for="preference__marketing">Marketing</label></li>
<span>
<a>
<span class="hook_UpdateCookiePreferences">Accept selected cookies</span>
</a>
</span>
</form>
</div>
</div>
</div>
When a cookie is set `CookiePolice` will check if the type of the cookie matches the preference.
If not, the cookie is denied. This is done by adding the type as a cookie flag
<script>
let exdate = new Date();
exdate.setDate(exdate.getDate() + 365);
document.cookie = "old=skool;expires: exdate;type=marketing";
</script>
Or by adding it too the `Cookie.Add` functions
<script>
Cookie.set('name', 'value', {
expires: exdate,
type: Cookiepolice.type.marketing
});
</script>
When removing, no type is needed.
<script>
Cookie.remove('name');
</script>
A custom cookie bar is possible, as long as you set the right cookie preferences one way or the
other, the name of the cookie is `cookie_preference` and the value is a coma seperated value of
the type of cookie types. Where `cookie_preference` will always be present.
<script>
let exdate = new Date();
exdate.setDate(exdate.getDate() + 365);
Cookie.set('cookie_preference', 'functional,statistic,marketing', {
expires: exdate,
type: Cookiepolice.type.functional
});
</script>
Hooks are class on buttons/links that perform an actions. The mostly do Ajax requests to change a
property of the page/product object
Hook |
Description |
hook__product-upload--delete |
Hook to delete an upload, will trigger ajax request: doUpload |
hook__product-upload |
Hook to do an upload, will trigger ajax request: doUpload |
hook__product-amount--minus |
Hook to change amount with minus 1, will trigger ajax request: doAmountChange |
hook__product-amount--plus |
Hook to change amount with plus 1, will trigger ajax request: doAmountChange |
hook__product-amount |
Hook to change amount with the value of [name=product_amount], will trigger ajax
request: doAmountChange
|
hook__product-attribute |
Hook to change the selected attributes defined in [name=product_attribute] , will
trigger ajax request: doAttributeChange
|
hook__product-order |
Hook to order the current $Product on the products page |
hook__product-add-review |
Hook to add an review with the content of .form-add-review, will trigger ajax request
doAddReview
|
hook__product-ask-a-question |
Hook to send an asked question with the content of .form-ask-a-question, will trigger
ajax request doAskAQuestion
|
hook__bundle-order |
Hook to order the complete bundle defined by attribute data-bundle-id |
hook__bundle-attribute-dialog |
Hook to open a dialog for selecting attributes for the bundle with attribute
data-bundle-id
|
hook__product-quotation |
hook to add product to a quotation |