ePages 6.10 - DE_EPAGES/ProductPortal/API/XML/PortalExportDriver.pm

Package DE_EPAGES::ProductPortal::API::XML::PortalExportDriver

Functions

allProducts
currencyID
descriptionAttribute
exportXML
formatPrice
imageAttribute
imageUrl
isProductValidPortal
isProductValidPortalExt1
items
languageID
portalSite
productPrice
productUrl
shippingMethod
shippingPrice
startMonitor
taxModel
useAddToBasket

allProducts

Returns the product identifiers to be exported. If the option "ExportAllVariation" is selected all SubProducts of a MasterProduct are exported, else only default SubProducts are exported.

Syntax
$aProductIDs = $self->allProducts;
Return
$aProductIDs (ref.array.int)
product identifier

currencyID

Exports to site of portal.

Syntax
$CurrencyID = $self->currencyID;
Return
$CurrencyID (object)
Portal site

descriptionAttribute

used description attribute of portal config.

Syntax
$DescriptionAttribute = $self->descriptionAttribute;
Return
$DescriptionAttribute (string)
description attribute

exportXML

Exports objects into an XML file.

Syntax
$self->exportXML($FileName, $hFileFormat, $aColumnNames, $ViewObject, $NoMonitor);
Input
$FileName (string)
name of export file
$hFormat (ref.hash)
file format specification

$ViewObject (object)
object to view monitor
$aObjects (ref.array.object)
list of objects
$NoMonitor (boolean)
true if output is to be monitored

formatPrice

formats prices (from shipping or products) to portal specific format.

Syntax
$FormattedValue = $self->formatPrice($Value);
Example
$FormattedShippingValue = $self->formatPrice($self->shippingPrice($Product));

imageAttribute

used image attribute of portal config.

Syntax
$ImageAttribute = $self->imageAttribute;
Return
$ImageAttribute (string)
image attribute

imageUrl

Returns url to product image.

Syntax
$URL = $self->imageUrl($Product, $ImageAttribute);
Example
$URL = $self->imageUrl($Product, $self->imageAttribute);

isProductValidPortal

Throws error if not valid, (not visible).

Syntax
$self->isProductValidPortal;

isProductValidPortalExt1

Throws error if not valid (not visible, no name or no price).

Syntax
$self->isProductValidPortalExt1;

items

Returns all product identifier of portal config, initialize monitor.

Syntax
$aProductIDs = $self->items;
Return
$aProductIDs (ref.array.int)
product identifier

languageID

Exports to site of portal.

Syntax
$LanguageID = $self->languageID;
Return
$LanguageID (object)
language

portalSite

Exports to site of portal.

Syntax
$PortalSite = $self->portalSite;
Return
$PortalSite (object)
Portal site

productPrice

get price of product with vars of portal config.

Syntax
$Value = $self->productPrice($Product);

productUrl

Returns url to product.

Syntax
$URL = $self->productUrl($Product);

shippingMethod

used shipping method of portal config.

Syntax
$ShippingMethod = $self->shippingMethod;
Return
$ShippingMethod (object)
shipping method

shippingPrice

get shipping price for product with vars of portal config.

Syntax
$Value = $self->shippingPrice($Product);

startMonitor

starts the monitor

Syntax
$self->startMonitor($PageTypeName);
Input
$PageTypeName (string)
name of pagetype

taxModel

Tax model used for export.

Syntax
$TaxModel = $self->taxModel;
Return
$TaxModel (int)
tax model

useAddToBasket

use add to basket link.

Syntax
$UseAddToBasket = $self->useAddToBasket;
Return
$UseAddToBasket (boolean)
use add to basket link