ePages 7.3.0 - DE_EPAGES/MultiStoreMaster/API/AffiliateVisibility.pm

Package DE_EPAGES::MultiStoreMaster::API::AffiliateVisibility

Affiliate visibility API

Base
Exporter
@EXPORT_OK
IsAffiliateVisible
AddShopsToAffiliateVisibility
RemoveShopsFromAffiliateVisibility
RemoveAllShopsFromAffiliateVisibility

Functions

AddShopsToAffiliateVisibility
IsAffiliateVisible
RemoveAllShopsFromAffiliateVisibility
RemoveShopsFromAffiliateVisibility

AddShopsToAffiliateVisibility

Add shops to affiliateshopvisibility map

Syntax
AddShopsToAffiliateVisibility( $ContentObject, $aShops );
Input
$ContentObject (object)
content objec
$aShops (ref.array)
shop list

IsAffiliateVisible

Triggers the hook 'API_IsAffiliateVisible' to externalize Affiliate shop visibility. If no hook listener sets the 'IsAffiliateVisibility' property, we use $ContentObject->get('IsAffiliateVisible') §trigger API_IsAffiliateVisible | used keys:

  • ContentObject - ContentObject - object
  • ContentObjectID - ContentObject id - integer
  • ShopAlias - shop alias - string
  • IsAffiliateVisible - output parameter: visible=1, invisble=0 - boolean

    Syntax
    IsAffiliateVisible( $ContentObject, $Shop );
    Input
    $ContentObject (object)
    ContentObject
    $ShopAlias (string)
    Shop alias
    Return
    $IsVisible (boolean)
    is visible

    RemoveAllShopsFromAffiliateVisibility

    Remove all shops from affiliateshopvisibility map

    Syntax
    RemoveAllShopsFromAffiliateVisibility( $ContentObject );
    Input
    $ContentObject (object)
    content objec

    RemoveShopsFromAffiliateVisibility

    Remove shops from affiliateshopvisibility map

    Syntax
    RemoveShopsFromAffiliateVisibility( $ContentObject, $aShops );
    Input
    $ContentObject (object)
    content objec
    $aShops (ref.array)
    shop list