ePages 7.38.0 - DE_EPAGES/MultiStoreConnector/API/MSSynchronization.pm

Package DE_EPAGES::MultiStoreConnector::API::MSSynchronization

abstract synchronization class

Functions

_transformOutputBooleanParameter
_transformOutputIntegerParameter
clearPageCache
clearSiteCache
dbh
dbi
getAttributeMandatory
getAttributeNames
getAttributeParameterType
isArray
isBool
isInteger
isNumber
isObject
isParamVerificationActivated
isString
new
resetAttributeCache
resetContentObjectCache
resetGlobalContentObjectCache
resetObjectCache
resetObjectDALCache
resetObjectGUIDCache
synchronizeCache
transformInputParameters
transformOutputParametersGet
updatePageCache
verifyContent
verifySubshops

_transformOutputBooleanParameter

Transform boolean attribute of incoming POST request e.g. true -> 1 etc. The given hashref is modified directly.

Syntax
$self->_transformOutputBooleanParameter($hParameters, $Key);
Input
$hParameters (ref.hash)
parameters
$Key (string)
key of the parameter to transform

_transformOutputIntegerParameter

Transform integer attribute for GET response. e.g. '1' -> 1. The given hashref is modified directly.

Syntax
$self->_transformOutputIntegerParameter($hParameters, $Key);
Input
$hParameters (ref.hash)
parameters
$Key (string)
key of the parameter to transform

clearPageCache

clear page cache for a object in a shop

Syntax
$Result = $Synchronization->clearPageCache($Shop,$Object);
Input
$Shop (string)
shop name
$Object (object)
epages 6 object

clearSiteCache

clear site cache for a shop

Syntax
$Result = $Synchronization->clearSiteCache($Shop);
Input
$Shop (string)
shop name

dbh

return the SQLite database handler object

Syntax
$DBH = $HardCoreSynchronization->dbh();
Example
$self->dbh()->prepare('...');
Return
$DBH (object)
SQL database handler

dbi

return the SQLite database handler object

Syntax
$DBH = $HardCoreSynchronization->dbi();
Example
$self->dbi()->prepare('...');
Return
$DBI (object)
SQL database interface

getAttributeMandatory

get parameter type of attribute name

Syntax
$Mandatory = $self->getAttributeMandatory($AttributeName);
Input
$AttributeName (string)
name of attribute
Return
$Mandatory (bool)
true ifproduct attribute is mandatory

getAttributeNames

get all existing attribute names

Syntax
$aAttributeNames = $self->getAttributeNames();
Return
$aAttributeNames (ref.array)
allexisting attribute names

getAttributeParameterType

get parameter type of attribute name

Syntax
$ParameterType = $self->getAttributeParameterType($AttributeName);
Input
$AttributeName (string)
name of attribute
Return
$ParameterType (string)
parameter type of product attribute

isArray

returns true if variable is a JSON array (array reference)

Syntax
$IsObject = $Synchronization->isArray($Check);
Input
$Check (ref/scalar/HASH/ARRAY)
variable to check
Return
$isArray (boolean)
returns true if variable is an array

isBool

returns true if variable is a boolean

Syntax
$IsBool = $Synchronization->isBool($Check);
Input
$Check (ref/scalar/HASH/ARRAY)
variable to check
Return
$IsBool (boolean)
returns true if variable is a boolean

isInteger

returns true if variable is an integer

Syntax
$IsInteger = $Synchronization->isInteger($Check);
Input
$Check (ref/scalar/HASH/ARRAY)
variable to check
Return
$IsInteger (boolean)
returns true if variable is an integer

isNumber

returns true if variable is a number

Syntax
$IsNumber = $Synchronization->isNumber($Check);
Input
$Check (ref/scalar/HASH/ARRAY)
variable to check
Return
$IsNumber (boolean)
returns true if variable is a number

isObject

returns true if variable is a JSON object (hash reference)

Syntax
$IsObject = $Synchronization->isObject($Check);
Input
$Check (ref/scalar/HASH/ARRAY)
variable to check
Return
$IsObject (boolean)
returns true if variable is an object

isParamVerificationActivated

returns true if parameter verification is activated for synchronisation

Syntax
$IsActivated = $Synchronization->isParamVerificationActivated();
Return
$IsActivated (boolean)
returns true if parameter verification is activated

isString

returns true if variable is a string

Syntax
$IsString = $Synchronization->isString($Check);
Input
$Check (ref/scalar/HASH/ARRAY)
variable to check
Return
$IsString (boolean)
returns true if variable is a string

new

Creates a new synchronization object of DE_EPAGES::MultiStoreConnector::API::MSSynchronization.

Syntax
$Synchronization = DE_EPAGES::MultiStoreConnector::API::MSSynchronization->new(%options);
Input
%options (hash)
options for synchronization
  • ROADWORKS - ROADWORKS

Return
$Synchronization (object)
synchronization object

resetAttributeCache

resets the cache of attributes for the given attribute class

Syntax
$Result = $Synchronization->resetAttributeCache($AttributeClassID);
Input
$AttributeClassID (integer)
ID of the attribute's class

resetContentObjectCache

removes complete cache for a object

Syntax
$Result = $Synchronization->resetContentObjectCache($ShopID);
Input
$ShopID (integer)
shop id

resetGlobalContentObjectCache

removes complete cache for all content objects

Syntax
$Result = $Synchronization->resetGlobalContentObjectCache();
Return
$Success (boolean)
returns true if everything is correct

resetObjectCache

removes complete cache for a object

Syntax
$Result = $Synchronization->resetObjectCache();
Input
$ObjectID (integer)
object id

resetObjectDALCache

removes DAL cache for a object

Syntax
$Result = $Synchronization->resetObjectDALCache($ObjectID, $IsObjectDeleted);
Input
$ObjectID (integer)
object id
$IsObjectDeleted (bool)
1 if object is deleted, 0 if object was updated or added

resetObjectGUIDCache

removes complete cache for a object by accessing with guid

Syntax
$Result = $Synchronization->resetObjectGUIDCache($GUID);
Input
$GUID (string)
object guid

synchronizeCache

synchronize the cache for epages installation

Syntax
$Result = $Synchronization->synchronizeCache();

transformInputParameters

transform attributes e.g. 'true' -> 1 etc.

Syntax
$self->transformInputParameters($hParameters);
Input
$hParameters
hash.ref

transformOutputParametersGet

Transform attributes for GET response e.g. 1 -> true etc. The given hashref is modified directly.

Syntax
$self->transformOutputParametersGet($hParameters);
Input
$hParameters (ref.hash)
parameters

updatePageCache

updates page cache for a object

Syntax
$Result = $Synchronization->updatePageCache($Object);
Input
$Object (object)
epages 6 object
Return
$Success (boolean)
returns true if everything is correct

verifyContent

verify attributes parameter, throws error if verification fails

Syntax
$self->verifyContent($hContent);
Input
$hContent
ref.hash

verifySubshops

Checks if the given shop aliases are in the database (store) If at least one alias is invalid, an error is thrown, otherwise the method returns without error.

Syntax
$Synchronization->verifySubshops($aMultiStoreSubShops, $StoreName);
Input
$aMultiStoreSubShops (ref.array.string)
shop aliases
$StoreName (string)
store name