Plentymarkets interface documentation

Wizard

Contracts

WizardActionHandler

This interface provides a template for an action handler for Wizards

Namespace

Plenty\Modules\Wizard\Contracts

WizardContainerContract

This interface provides methods to register, get and list all wizards.

Namespace

Plenty\Modules\Wizard\Contracts

Methods
public register($wizardKey, $wizard):void

Register a wizard

Parameters

Name

Type

Description

$wizardKey

string

$wizard

string

public registerFolders($folderClass):void

Register a wizard folder

Parameters

Name

Type

Description

$folderClass

string

public get($wizardKey, $skipTranslation = false):Plenty\Modules\Wizard\Models\Wizard
Return type: Wizard

Get a single wizard by its key

Parameters

Name

Type

Description

$wizardKey

string

$skipTranslation

bool

public all():array

List all wizards class names

public folders($hierarchy = false):array

List all wizard folders

Parameters

Name

Type

Description

$hierarchy

bool

WizardDataModifier

This interface provides methods to modify wizard data.

Namespace

Plenty\Modules\Wizard\Contracts

Methods
public modify($parameters):void

Modify a wizard data for a step

Parameters

Name

Type

Description

$parameters

array

WizardDataRepositoryContract

This interface provides methods to create, get, list, update and delete wizard data

Namespace

Plenty\Modules\Wizard\Contracts

Methods
public create($wizardKey, $steps = []):void

Creates a new WizardData.

Parameters

Name

Type

Description

$wizardKey

string

$steps

array

public createDataOption($wizardKey, $data = [], $optionId = "default"):void

Creates a new WizardData option

Parameters

Name

Type

Description

$wizardKey

string

$data

array

$optionId

string

public get($wizardKey):void

Get a single WizardData by its ID

Parameters

Name

Type

Description

$wizardKey

string

public getByOptionId($wizardKey, $optionId = "default"):void

Get a single WizardData for an option ID

Parameters

Name

Type

Description

$wizardKey

string

$optionId

string

public findByWizardKey($wizardKey):void
Parameters

Name

Type

Description

$wizardKey

string

public list($page = 1, $itemsPerPage = 50, $filters = []):array

List all WizardData for current plenty ID.

Parameters

Name

Type

Description

$page

int

$itemsPerPage

int

$filters

array

public update($wizardKey, $properties):void

Update data for a WizardData

Parameters

Name

Type

Description

$wizardKey

string

$properties

array

public updateDataOption($wizardKey, $optionId, $data, $stepKey, $skipValidation = false):void

Update data for a WizardData option

Parameters

Name

Type

Description

$wizardKey

string

$optionId

string

$data

array

$stepKey

string

$skipValidation

bool

public delete($wizardKey):void

Delete a single WizardData by its ID

Parameters

Name

Type

Description

$wizardKey

string

public deleteDataOption($wizardKey, $optionId):void

Delete a single WizardData by its ID

Parameters

Name

Type

Description

$wizardKey

string

$optionId

string

public finalize($wizardKey, $optionId = "default", $data = []):void

Finalize wizard

Parameters

Name

Type

Description

$wizardKey

string

$optionId

string

$data

array

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

WizardDynamicLoader

This interface provides methods to dynamically load data in the wizard ui.

Namespace

Plenty\Modules\Wizard\Contracts

WizardRepositoryContract

This interface provides methods to get and list wizards.

Namespace

Plenty\Modules\Wizard\Contracts

WizardSettingsHandler

This interface provides methods to handle final wizard data.

Namespace

Plenty\Modules\Wizard\Contracts

Methods
public handle($parameters):bool

Handle wizard data for a finalized wizard

Parameters

Name

Type

Description

$parameters

array

Models

Wizard

The wizard model.

Namespace

Plenty\Modules\Wizard\Models

Properties
Name Type Description

title

string

The title

key

string

The wizard’s key

settingsHandlerClass

string

Settings handler

shortDescription

string

The short description

translationKey

string

The translation key

deleteConfirmationText

string

Delete confirmation Text in deletion overlay

topics

array

The topics

steps

array

Wizard’s structure

priority

int

Wizard’s listing priority in the overview

relevance

string

Wizard’s level of relevance

keywords

array

Keywords describing the wizard

Methods
public toArray()

Returns this model as an array.

WizardData

The wizard data model.

Namespace

Plenty\Modules\Wizard\Models

Properties
Name Type Description

uuid

string

plentyIdHash

string

wizardKey

string

data

array

steps

array

Methods
public toArray()

Returns this model as an array.

WizardFolder

The wizard folder.

Namespace

Plenty\Modules\Wizard\Models

Properties
Name Type Description

name

string

The name

priority

int

The priority

shortDescription

string

The short description

parent

string

The parent

Methods
public toArray()

Returns this model as an array.

WizardFormOption

The wizard form option.

Namespace

Plenty\Modules\Wizard\Models

Properties
Name Type Description

name

string

The name

placeholder

string

The placeholder

caption

string

The caption. Only for checkboxValues.

label

string

The label

tooltip

string

The tooltip

Methods
public toArray()

Returns this model as an array.

WizardSection

The wizard step section model.

Namespace

Plenty\Modules\Wizard\Models

Properties
Name Type Description

title

string

The title

description

string

The description

form

array

The form

Methods
public toArray()

Returns this model as an array.

WizardStep

The wizard step model.

Namespace

Plenty\Modules\Wizard\Models

Properties
Name Type Description

title

string

The title

description

string

The short description

modifierClass

string

The modifier class

validationClass

string

The validation class

sections

array

The sections

Methods
public toArray()

Returns this model as an array.

Services

WizardFolderProvider

Register a wizard folder.

Namespace

Plenty\Modules\Wizard\Services

Methods
public folders():array

WizardProvider

Register a wizard.

Namespace

Plenty\Modules\Wizard\Services

Methods
public structure():array

Services

DataSources

BaseWizardDataSource

Base data source for wizards

Namespace

Plenty\Modules\Wizard\Services\DataSources

Properties
Name Type Description

wizardKey

dataStructure

Methods
public setWizardKey($wizardKey):void

Sets the wizard key for this data source

Parameters

Name

Type

Description

$wizardKey

string

public getIdentifiers():array

List of option identifiers

public create($steps = []):array

Create data

Parameters

Name

Type

Description

$steps

array

public get():array

Get data

public update($properties = []):void

Update data

Parameters

Name

Type

Description

$properties

array

public delete():void

Delete data

public createDataOption($data = [], $optionId = "default"):array

Create data option

Parameters

Name

Type

Description

$data

array

$optionId

string

public getByOptionId($optionId = "default"):array

Get data option by its option ID

Parameters

Name

Type

Description

$optionId

string

public updateDataOption($optionId = "default", $data = [], $stepKey = ""):array

Update data option

Parameters

Name

Type

Description

$optionId

string

$data

array

$stepKey

string

public deleteDataOption($optionId):void

Delete data option

Parameters

Name

Type

Description

$optionId

string

public finalize($optionId, $data = []):void
Parameters

Name

Type

Description

$optionId

string

$data

array