Package DE_EPAGES::ShopConfiguration::API::Object::Provider
object interface for Provider.
Base |
DE_EPAGES::Object::API::Object::Site |
Functions
- addStore
- className
- databases
- dbPackage
- existsFeaturePack
- existsShop
- existsShopType
- existsSiteLocale
- exportXMLElements
- featurePack
- featurePacks
- features
- hasStore
- insertFeaturePack
- insertShop
- insertShopType
- preCreateShop
- removeStore
- shop
- shopService
- shopType
- shopTypes
- shops
- siteLocale
- stores
addStore
Assigns a store database to the provider.
Syntax |
$Provider->addStore( $Store ) |
Input |
|
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $Provider->className; |
Return |
|
databases
Returns all store databases that are assigned to the provider.
Syntax |
$aDatabases = $Provider->databases |
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $Provider->dbPackage; |
Return |
|
existsFeaturePack
Returns true if the provider has a feature pack with the given alias name.
Syntax |
$Exists = $Provider->existsFeaturePack( $Alias ); |
Input |
|
Return |
|
existsShop
Returns true a shop with the given alias name exists for the provider.
Syntax |
$Exists = $Provider->existsShop( $Alias ); |
Input |
|
Return |
|
existsShopType
Returns true if the provider has a shop type with the given alias name.
Syntax |
$Exists = $Provider->existsShopType( $Alias ); |
Input |
|
Return |
|
existsSiteLocale
Returns true if the site supports the given locale.
Syntax |
$Exists = $Site->existsSiteLocale($LocaleID); |
Example |
if( $Site->existsSiteLocale('en_GB') ) { ... } |
Input |
|
Return |
|
exportXMLElements
Exports xml data of multilinguagal attributes of this object.
Syntax |
$Object->exportXMLElements($Driver, $hAllAttributes); |
Input |
|
featurePack
Returns a feature pack of a provider.
Syntax |
$FeaturePack = $Provider->featurePack( $Alias ); |
Return |
|
featurePacks
Returns all feature packs of a provider.
Syntax |
$aFeaturePacks = $Provider->featurePacks |
Return |
|
features
Returns all features that are available for a provider for configuration of feature collections. This list contains the maximum of all features of all assigned store databases.
Syntax |
$aFeatures = $Provider->features |
Return |
|
hasStore
Returns true if the store database is assigned to the provider.
Syntax |
$HasStore = $Provider->hasStore( $Store ) |
Example |
if( $Provider->hasStore( $Store ) { ... } |
Input |
|
Return |
|
insertFeaturePack
Inserts a new feature pack for the provider.
Syntax |
$FeaturePack = $Provider->insertFeaturePack( $hFeaturePack ); |
Input |
|
Return |
|
insertShop
Inserts a shop of the provider. Re-uses a pre-created shop if one exists in the given store database with the given shop type. In this case, the parameters ImportFiles and PublicFilesDir are ignored. See also preCreateShop.
Syntax |
$ShopRef = $Provider->insertShop({ ShopType => $ShopType, Store => $Store, Alias => $Alias, ShopAlias => $ShopAlias, IsClosed => $IsClosed, DomainName => $DomainName, HasSSLCertificate => $HasSSLCertificate, WebServerScriptNamePart => $WebServerScriptNamePart, IsTrialShop => $IsTrialShop, IsInternalTestShop => $IsInternalTestShop, ImportFiles => $aImportFiles, PublicFilesDir => $PublicFilesDir, }); |
Input |
|
Return |
|
insertShopType
Inserts a new shop type for the provider.
Syntax |
$ShopType = $Provider->insertShopType( $hShopType ); |
Input |
|
Return |
|
preCreateShop
Creates a new shop without a real shop alias, which can be re-used later by insertShop
Syntax |
$ShopRef = $Provider->preCreateShop({ ShopType => $ShopType, Store => $Store, ImportFiles => $aImportFiles, PublicFilesDir => $PublicFilesDir, }); |
Input |
|
Return |
|
removeStore
Unassigns a store database from the provider. The database is not deleted.
Syntax |
$Provider->removeStore( $Store ) |
Input |
|
shop
Returns a shop of the provider.
Syntax |
$ShopRef = $Provider->shop( $Alias ); |
Input |
|
Return |
|
shopService
Returns a web service client of the ShopService.
Syntax |
$ShopService = $self->shopService; $ShopService = $self->shopService( $Store ); |
Input |
|
Return |
|
shopType
Returns a shop type of a provider.
Syntax |
$ShopType = $Provider->shopType( $Alias ); |
Input |
|
Return |
|
shopTypes
Returns all shop types packs of a provider.
Syntax |
$aShopTypes = $Provider->shopTypes |
Return |
|
shops
Returns all shops of a provider.
Syntax |
$aShopRefs = $Provider->shops; |
Example |
$_->delete foreach @{ $Provider->shops }; |
Return |
|
siteLocale
Returns locale object with given locale identifier.
Syntax |
$Locale = $Site->siteLocale($LocaleID); |
Example |
$Site->siteLocale('en_GB')->roundMoney($amount, $CurrencyID); |
Input |
|
Return |
|
stores
Returns all store databases that are assigned to the provider.
Syntax |
$aStores = $Provider->stores |
Return |
|