This interface provides a template for an action handler for Wizards
Plenty\Modules\Wizard\Contracts
This interface provides methods to register, get and list all wizards.
Plenty\Modules\Wizard\Contracts
public register(string $wizardKey, string $wizard):void
Register a wizard
string | $wizardKey | |
string | $wizard |
public registerFolders(string $folderClass):void
Register a wizard folder
string | $folderClass |
public get(string $wizardKey, bool $skipTranslation = false):Wizard
Get a single wizard by its key
string | $wizardKey | |
bool | $skipTranslation |
public all():array
List all wizards class names
public folders(bool $hierarchy = false):array
List all wizard folders
bool | $hierarchy |
This interface provides methods to modify wizard data.
Plenty\Modules\Wizard\Contracts
public modify(array $parameters):void
Modify a wizard data for a step
array | $parameters |
This interface provides methods to create, get, list, update and delete wizard data
Plenty\Modules\Wizard\Contracts
public create(string $wizardKey, array $steps = []):void
Creates a new WizardData.
string | $wizardKey | |
array | $steps |
public createDataOption(string $wizardKey, array $data = [], string $optionId = "default"):void
Creates a new WizardData option
string | $wizardKey | |
array | $data | |
string | $optionId |
public get(string $wizardKey):void
Get a single WizardData by its ID
string | $wizardKey |
public getByOptionId(string $wizardKey, string $optionId = "default"):void
Get a single WizardData for an option ID
string | $wizardKey | |
string | $optionId |
public findByWizardKey(string $wizardKey):void
string | $wizardKey |
public list(int $page = 1, int $itemsPerPage = 50, array $filters = []):array
List all WizardData for current plenty ID.
int | $page | |
int | $itemsPerPage | |
array | $filters |
public update(string $wizardKey, array $properties):void
Update data for a WizardData
string | $wizardKey | |
array | $properties |
public updateDataOption(string $wizardKey, string $optionId, array $data, string $stepKey, bool $skipValidation = false):void
Update data for a WizardData option
string | $wizardKey | |
string | $optionId | |
array | $data | |
string | $stepKey | |
bool | $skipValidation |
public delete(string $wizardKey):void
Delete a single WizardData by its ID
string | $wizardKey |
public deleteDataOption(string $wizardKey, string $optionId):void
Delete a single WizardData by its ID
string | $wizardKey | |
string | $optionId |
public finalize(string $wizardKey, string $optionId = "default", array $data = []):void
Finalize wizard
string | $wizardKey | |
string | $optionId | |
array | $data |
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(array $filters = []):void
Sets the filter array.
array | $filters |
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.
This interface provides methods to dynamically load data in the wizard ui.
Plenty\Modules\Wizard\Contracts
This interface provides methods to get and list wizards.
Plenty\Modules\Wizard\Contracts
This interface provides methods to handle final wizard data.
Plenty\Modules\Wizard\Contracts
public handle(array $parameters):bool
Handle wizard data for a finalized wizard
array | $parameters |
The wizard model.
Plenty\Modules\Wizard\Models
Type | Name | Description |
---|---|---|
string | title | The title |
string | key | The wizard's key |
string | settingsHandlerClass | Settings handler |
string | shortDescription | The short description |
string | translationKey | The translation key |
string | deleteConfirmationText | Delete confirmation Text in deletion overlay |
array | topics | The topics |
array | steps | Wizard's structure |
int | priority | Wizard's listing priority in the overview |
string | relevance | Wizard's level of relevance |
array | keywords | Keywords describing the wizard |
public toArray()
Returns this model as an array.
The wizard data model.
Plenty\Modules\Wizard\Models
Type | Name | Description |
---|---|---|
string | uuid | |
string | plentyIdHash | |
string | wizardKey | |
array | data | |
array | steps |
public toArray()
Returns this model as an array.
The wizard folder.
Plenty\Modules\Wizard\Models
Type | Name | Description |
---|---|---|
string | name | The name |
int | priority | The priority |
string | shortDescription | The short description |
string | parent | The parent |
public toArray()
Returns this model as an array.
The wizard form option.
Plenty\Modules\Wizard\Models
Type | Name | Description |
---|---|---|
string | name | The name |
string | placeholder | The placeholder |
string | caption | The caption. Only for checkboxValues. |
string | label | The label |
string | tooltip | The tooltip |
public toArray()
Returns this model as an array.
The wizard step section model.
Plenty\Modules\Wizard\Models
Type | Name | Description |
---|---|---|
string | title | The title |
string | description | The description |
array | form | The form |
public toArray()
Returns this model as an array.
The wizard step model.
Plenty\Modules\Wizard\Models
Type | Name | Description |
---|---|---|
string | title | The title |
string | description | The short description |
string | modifierClass | The modifier class |
string | validationClass | The validation class |
array | sections | The sections |
public toArray()
Returns this model as an array.
Register a wizard folder.
Plenty\Modules\Wizard\Services
public folders():array
Register a wizard.
Plenty\Modules\Wizard\Services
public structure():array
Base data source for wizards
Plenty\Modules\Wizard\Services\DataSources
Type | Name | Description |
---|---|---|
wizardKey | ||
dataStructure |
public setWizardKey(string $wizardKey):void
Sets the wizard key for this data source
string | $wizardKey |
public getIdentifiers():array
List of option identifiers
public create(array $steps = []):array
Create data
array | $steps |
public get():array
Get data
public update(array $properties = []):void
Update data
array | $properties |
public delete():void
Delete data
public createDataOption(array $data = [], string $optionId = "default"):array
Create data option
array | $data | |
string | $optionId |
public getByOptionId(string $optionId = "default"):array
Get data option by its option ID
string | $optionId |
public updateDataOption(string $optionId = "default", array $data = [], string $stepKey = ""):array
Update data option
string | $optionId | |
array | $data | |
string | $stepKey |
public deleteDataOption(string $optionId):void
Delete data option
string | $optionId |
public finalize(string $optionId, array $data = []):void
string | $optionId | |
array | $data |