Plentymarkets interface documentation

Config

Contracts

DesignConfigRepositoryContract

Repository for DesignConfig of the deprecated CMS

Namespace

Plenty\Modules\Template\Design\Config\Contracts

Methods
public findByDesignName($designName):array
Parameters

Name

Type

Description

$designName

string

 
public findByDesignAndWebStore($designName, $webStoreId):Plenty\Modules\Template\Design\Config\Models\DesignConfig
Return type: DesignConfig
Parameters

Name

Type

Description

$designName

string

$webStoreId

int

 
public findByDesign($design):array
Parameters

Name

Type

Description

$design

Design

 
public update($data, $designName, $webstoreId):Plenty\Modules\Template\Design\Config\Models\DesignConfig
Return type: DesignConfig
Parameters

Name

Type

Description

$data

array

$designName

string

$webstoreId

int

 
public copyDesignConfig($designName, $newDesignName):Plenty\Modules\Template\Design\Config\Models\DesignConfig
Return type: DesignConfig
Parameters

Name

Type

Description

$designName

string

$newDesignName

string

DesignRepositoryContract

Repository for Design of the deprecated CMS

Namespace

Plenty\Modules\Template\Design\Config\Contracts

Methods
public loadAll():array
public findByDesignName($designName, $withConfig = true):Plenty\Modules\Template\Design\Config\Models\Design
Return type: Design
Parameters

Name

Type

Description

$designName

string

$withConfig

bool

 
public getCheckoutType():array

Models

Design

Design model of the deprecated CMS

Namespace

Plenty\Modules\Template\Design\Config\Models

Properties
Name Type Description

designName

string

imageDir

string

directory of images

export

bool

directory of images

updatedAt

string

created at date timestamp

createdAt

string

updated at date timestamp

config

array

list of configurations of each webstore
Methods
public toArray()

Returns this model as an array.

DesignConfig

Design configuration model

Namespace

Plenty\Modules\Template\Design\Config\Models

Properties
Name Type Description

webstoreId

int

error404ContentPageId

int

bankContentPageId

int

cancellationRightsContentPageId

int

termsConditionsContentPageId

int

contactContentPageId

int

legalDisclosureContentPageId

int

helpContentPageId

int

itemNotFoundContentPageId

int

paymentMethodsContentPageId

int

privacyPolicyContentPageId

int

shippingContentPageId

int

frontPageContentPageId

int

customerRegistrationPageId

int

orderConfirmationPageId

int

lostPasswordPageId

int

loginPageId

int

logoutPageId

int

typeOfCheckout

int

checkoutStep1PageId

int

checkoutStep2PageId

int

checkoutStep3PageId

int

checkoutStep4PageId

int

checkoutStep5PageId

int

checkoutStep6PageId

int

checkoutStep7PageId

int

checkoutStep8PageId

int

checkoutStep9PageId

int

checkoutStep10PageId

int

pageDesignWebshop

string

pageDesignCheckout

string

pageDesignMyAccount

string

pageDesignBlog

string

pageDesignForum

string
Methods
public toArray()

Returns this model as an array.