Plentymarkets interface documentation
ShopBuilder
Contracts
ContentLinkRepositoryContract
Get, create, delete, and update links between shopBuilder contents and layout containers depending on plugin sets and languages.
Namespace
Plenty\Modules\ShopBuilder\Contracts
Methods
public getContentLinks($pluginSetId):arrayGet all content links for a plugin set.
Name |
Type |
Description |
|
The ID of the plugin set to get content links for. |
public getContentLink($contentLinkId):Plenty\Modules\ShopBuilder\Models\ContentLinkReturn type: ContentLink
Get a single connection between a content and a layout container.
Name |
Type |
Description |
|
The ID of the content link to get. |
public createContentLink($data):Plenty\Modules\ShopBuilder\Models\ContentLinkReturn type: ContentLink
Create a link between a content and a layout container for a specified plugin set and a language.
Name |
Type |
Description |
|
Content link data to create instance with. |
public updateContentLink($contentLinkId, $data):Plenty\Modules\ShopBuilder\Models\ContentLinkReturn type: ContentLink
Update a link between a content and a layout container.
Name |
Type |
Description |
|
ID of the content link. |
|
|
Data to assign to the content link. |
public deleteContentLink($contentLinkId):voidUnlink a content from a layout container. The content itself will remain.
Name |
Type |
Description |
|
The ID of the content link to remove. |
public getContentLinksForContainer($containerName, $pluginSetId = null, $lang = null, $contentType = null, $filterResults = true):voidGet all content links for a specific layout container.
Name |
Type |
Description |
|
The name of the layout container for which to get content links. |
|
|
An ID of a plugin set for which to get content links. Active plugin set will be used by default. |
|
|
The language for which to get content links. Current language will be gotten from session if not defined. |
|
|
Type of the content to get. |
|
|
ContentPreset
Contract for content presets. Presets can provide a predefined set of widgets when creating new contents in the shopBuilder.
Namespace
Plenty\Modules\ShopBuilder\Contracts
Methods
public getWidgets():voidGet the widget configurations of the presets to be assigned to the created content.
ContentRepositoryContract
Get, create, delete, und update shopBuilder contents.
Namespace
Plenty\Modules\ShopBuilder\Contracts
Methods
public getContents():arrayGet all contents with all their widget data.
public searchContents($itemsPerPage = 20, $page = 1, $params = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Search for contents. Search params are queried conjunctively while values for each params are queried disjunctively:
Name |
Type |
Description |
|
Maximum number of items to be returned on each page |
|
|
Current page |
|
|
Search parameters |
public getContent($contentId, $pluginSetId, $frontendLanguage = null, $versionId = ""):Plenty\Modules\ShopBuilder\Models\ContentReturn type: Content
Get a single content.
Name |
Type |
Description |
|
ID of the content to get information for. |
|
|
The plugin set ID to be used for rendering widgets. |
|
|
The language to be used for rendering the widgets. |
|
|
The version of the content. |
public listContentVersions($contentId, $itemsPerPage = 20, $versionIdMarker = ""):voidGet a list of versions of the specified content.
Name |
Type |
Description |
|
ID of the content to get versions for. |
|
|
Number of versions to be displayed at a page. |
|
|
ID of a version to get subsequent versions from. |
public restoreContentVersion($contentId, $versionId, $pluginSetId, $frontendLanguage = null):voidRestore a content to a specific version.
Name |
Type |
Description |
|
ID of the content to restore. |
|
|
ID of the version to restore the content to. |
|
|
||
|
public createContent($pluginSetId, $data, $frontendLanguage = null):Plenty\Modules\ShopBuilder\Models\ContentReturn type: Content
Create new content. New content will not be linked to any layout container.
Name |
Type |
Description |
|
The plugin set to be used to render the content. The raw content data do not depend on a plugin set. |
|
|
The raw content data. |
|
|
The language to be used for rendering the widgets. |
public updateContent($pluginSetId, $contentId, $data, $frontendLanguage = null):Plenty\Modules\ShopBuilder\Models\ContentReturn type: Content
Update content. Metadata, such as the user defined name of the content, will be stored separately to the data of the widgets.
Name |
Type |
Description |
|
The plugin set to be used to render the content. The raw content data do not depend on a plugin set. |
|
|
The ID of the content to be updated. |
|
|
The raw data of the content. |
|
|
The language to be used for rendering the widgets. |
public deleteContent($pluginSetId, $contentId):voidDelete content. Any connections to layout containers will be removed, too.
Name |
Type |
Description |
|
The plugin set to be used to render the content. The raw content data do not depend on a plugin set. |
|
|
The ID of the content to be deleted. |
public duplicateContent($contentId, $targetPluginSetId, $language, $containerName, $contentName):Plenty\Modules\ShopBuilder\Models\ContentReturn type: Content
Duplicate a content and its link.
Name |
Type |
Description |
|
The ID of the content to be duplicated. |
|
|
ID of the plugin set to link the duplicated content to. |
|
|
Language to link the duplicated content to. |
|
|
Name of the layout container to link the duplicated content to. |
|
|
Name of the duplicated content. |
public rebuildContents($containerName = null, $pluginSetId):intRebuild all contents linked to the current plugin set.
Name |
Type |
Description |
|
Name of the layout container to rebuild contents for. |
|
|
ID of the plugin set to rebuild contents for. |
ContentWidgetRepositoryContract
Register shopBuilder widgets.
Namespace
Plenty\Modules\ShopBuilder\Contracts
Methods
public registerWidget($widgetClass):voidRegister a widget to be available in the shopBuilder.
Name |
Type |
Description |
|
Widget class to be registered to the shopBuilder. Should implement the Widget interface. |
public overrideWidget($widgetIdentifier, $overrideWidget):voidOverride a widget class to extend data or settings of the widget.
Name |
Type |
Description |
|
The identifier of the original widget to override. |
|
|
The class of the new class to get information of the widget from. |
DynamicWidget
Contract for widgets with dynamic settings
Namespace
Plenty\Modules\ShopBuilder\Contracts
Methods
public getData():arrayGet base data of the widget. Each widget should define at least an identifier and a label to be displayed in the builder. In total the following information can be provided: <ul> <li>identifier: A unique identifier of the widget. This is used to identify widgets when loading widgets of a content in the builder.</li> <li>label: The label of the widget to be displayed in the list of available widgets in the builder.</li> <li>previewImageURL: The url of the preview image to be displayed in the list of available widgets in the builder.</li> <li>type: The type of the widget. This is used to restrict possible locations of the widgets using the allowedNestingTypes.</li> <li>categories: A list of category keys defined in the list of categories to be displayed in the list of available widgets. If no correspondig category exists, the widget will be located in a generic category.</li> <li>position: The position of the widget in the list of available widgets</li> <li>maxPerPage: Restrict the amount of times the widget can be placed on a single content.</li> <li>allowedNestingTypes: A list of widget types that are allowed to be placed in child dropzones of the widget.</li> <li>deprecated: set to true to hide the widget in the list of available widgets. Existing deprecated widgets can still be edited but not added anymore.</li> </ul>
public getSettings():arrayGet the settings of the widgets. Settings are displayed in a terra-form when the widget is selected in the builder.
public getPreview($widgetSettings = [], $children = []):stringRender the template of the widget twice to get the final markup to be displayed in the preview of the builder.
Name |
Type |
Description |
|
||
|
public render($widgetSettings = [], $children = []):stringRender the template of the widget.
Name |
Type |
Description |
|
||
|
GlobalSettingsHandler
Contract for classes handling global settings for the ShopBuilder. Handler classes can be registered in the shopBuilder.json of a plugin.
Namespace
Plenty\Modules\ShopBuilder\Contracts
Methods
public readSettings():voidRead values of global settings.
public writeSettings($values):voidStore values of global settings.
Name |
Type |
Description |
|
Setting values for the global settings defined by this handler. |
Widget
Contract for content widgets
Namespace
Plenty\Modules\ShopBuilder\Contracts
Methods
public getPreview($widgetSettings = [], $children = []):stringRender the template of the widget twice to get the final markup to be displayed in the preview of the builder.
Name |
Type |
Description |
|
||
|
public render($widgetSettings = [], $children = []):stringRender the template of the widget.
Name |
Type |
Description |
|
||
|
Factories
WidgetDataFactory
Factory to create widget data
Namespace
Plenty\Modules\ShopBuilder\Factories
Methods
public static make($identifier):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Create a new widget factory instance.
Name |
Type |
Description |
|
Unique identifier of the widget. |
public withLabel($label):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Set a label for this widget. Will be translated.
Name |
Type |
Description |
|
Label of the widget to be displayed in the shop builder |
public withPreviewImageUrl($previewImageUrl):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Set the url of a preview image for the widget.
Name |
Type |
Description |
|
public withType($type):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Set the type of the widget.
Name |
Type |
Description |
|
public withCategory($category):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Add a category for the widget. A widget might be assigned to multiple categories.
Name |
Type |
Description |
|
public withPosition($position):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Set the position of the widget.
Name |
Type |
Description |
|
Position of the widget |
public withMaxPerPage($maxPerPage):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Limit the amount of times a widget can be placed on a content.
Name |
Type |
Description |
|
Maximum allowed amount of instances of the widget on a content |
public withAllowedNestingTypes($allowedTypes):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Limits the widget types that you can drop into this widget.
Name |
Type |
Description |
|
public withDeprecated():Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
Set the widget as deprecated.
public withSearchKeyWords($keywords):Plenty\Modules\ShopBuilder\Factories\WidgetDataFactoryReturn type: WidgetDataFactory
List of keywords for the shopBuilder widget search
Name |
Type |
Description |
|
public toArray():arrayGet widget data.
WidgetSettingsFactory
Factory to generate widget settings
Namespace
Plenty\Modules\ShopBuilder\Factories
Methods
public static inherit($parentWidgetClass):Plenty\Modules\ContentBuilder\Factories\WidgetSettingsFactoryReturn type: WidgetSettingsFactory
Create a new factory instance and initialize values from given widget class.
Name |
Type |
Description |
|
public static create($data = []):Plenty\Modules\ContentBuilder\Factories\WidgetSettingsFactoryReturn type: WidgetSettingsFactory
Create a new factory instance with initial values.
Name |
Type |
Description |
|
public createSetting($key, $settingsFactory = "", $args = []):voidCreate a generic widget settings entry.
Name |
Type |
Description |
|
The key of the new settings entry. If key already exists, previous entry will be overridden. |
|
|
Class name of the settings factory to add an instance of |
|
|
Arguments to be passed to the factory constructor method |
public toArray():arrayGenerate settings data from all registered factories
public withPointer($key):Plenty\Modules\ContentBuilder\Factories\WidgetSettingsFactoryReturn type: WidgetSettingsFactory
Set a settings key to insert new settings after.
Name |
Type |
Description |
|
public addSetting($key, $setting):voidInsert a new settings factory at the current pointer.
Name |
Type |
Description |
|
||
|
Helper
MappableSettingsHandler
Helper to map global configurations to plugin configs.
Namespace
Plenty\Modules\ShopBuilder\Helper
ShopBuilderRequest
Get information about the current request made from the shop builder preview.
Namespace
Plenty\Modules\ShopBuilder\Helper
Methods
public isShopBuilder():boolDetermine if the current request is made from the shop builder preview or while rendering a widget via REST.
public getPreviewContentType():stringGet the type of the previewed shop builder content.
public getPreviewUri():voidGet uri of the current preview. This might be used when rendering widgets via REST to know the context where the widget will be placed into after rendering.
public getMainContentType():stringGet the content type of the currently displayed main content.
public setMainContentType($mainContentType):voidSet the type of the currently displayed item content This will be used to determine the corresponding header/footer contents which are linked to a specific type.
Name |
Type |
Description |
|
Possible values: <ul> <li>content</li> <li>checkout</li> <li>myaccount</li> <li>singleitem</li> <li>categoryitem</li> <li>itemsearch</li> <li>itemset</li> </ul> |
public getMainContainerName():stringGet the container name where the main content will be loaded into.
public setMainContainerName($mainContainerName):voidSet the container name where the main content will be loaded into.
Name |
Type |
Description |
|
Name of the layout container. |
public setMainCategory($mainCategory):voidSet the id of the currently displayed category.
Name |
Type |
Description |
|
Id of the currently displayed category. |
Models
Content
Content created by the shop builder. May be linked to layout containers.
Namespace
Plenty\Modules\ShopBuilder\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the content |
|
dataProviderName |
The name of the data provider |
|
createdAt |
The date when the content was created |
|
updatedAt |
The date when the content was last updated |
|
type |
The type of the content |
|
widgets |
The configured widgets of the content. This attribute is deprecated. Use $dropzones instead. |
|
dropzones |
Dropzones of the content |
|
link |
Methods
public toArray()Returns this model as an array.
ContentLink
Links a content from the shop builder to a layout container of the frontend plugin.
Namespace
Plenty\Modules\ShopBuilder\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the content link |
|
contentId |
The ID of the content |
|
containerName |
The name of the container |
|
pluginSetId |
The Id of the plugin set |
|
language |
The language where the content is linked to. |
|
active |
Indicates if the link is active and the content should be visible for the frontend. |
|
relatedContentType |
The content type the content is linked to |
|
relatedContainerName |
The container name the content is linked to |
|
inherit |
Indicates if this content should be inherited to child contents. |
|
invalid |
Indicate if the content is invalid and should be regenerated on next request. |
|
createdAt |
The date when the content was created |
|
updatedAt |
The date when the content was last updated |
|
content |
Methods
public toArray()Returns this model as an array.
ContentPage
A content page provided by a frontend plugin.
Namespace
Plenty\Modules\ShopBuilder\Models
| Name | Type | Description |
|---|---|---|
identifier |
The identifier of the content page |
|
caption |
Translation key to read the caption from |
|
dropzones |
Available dropzones of this page to put contents into. |
Methods
public toArray()Returns this model as an array.
ContentPageDropzone
Layout container of a content page where to display link contents generated by the shop builder.
Namespace
Plenty\Modules\ShopBuilder\Models
| Name | Type | Description |
|---|---|---|
container |
The container where dropped contents should be linked to. |
|
type |
The type of contents which can be linked to this dropzone. |
Methods
public toArray()Returns this model as an array.
ContentWidget
Content widget provided by a frontend plugin
Namespace
Plenty\Modules\ShopBuilder\Models
| Name | Type | Description |
|---|---|---|
identifier |
The identifier of the content widget |
|
widgetClass |
The class of the content widget |
|
label |
The label of the content widget |
|
tooltip |
The tooltip of the content widget |
|
previewImageURL |
The preview image the content widget |
|
type |
The type of the widget |
|
maxPerPage |
Maximum occurrences per content of the widget |
|
categories |
List of categories |
|
allowedNestingTypes |
Allowed types to be nested inside this widget |
|
settings |
The settings of the content widget |
Methods
public toArray()Returns this model as an array.
Providers
DataFieldProvider
Base class for data field providers.
Namespace
Plenty\Modules\ShopBuilder\Providers
Methods
public register():voidRegister data fields and child providers.
public addField($identifier, $label, $expression, $isBlockElement = false, $isDeprecated = false):voidRegister a new data field.
Name |
Type |
Description |
|
Unique identifier of the data field |
|
|
The label of the field |
|
|
The twig expression to be inserted by this field |
|
|
Set to true to handle the element as a block element |
|
|
Deprecated flag for fields |
public addChildProvider($label, $childProviderClass, $params = [], $identifier = ""):voidRegister a nested provider containing a list of child data fields.
Name |
Type |
Description |
|
The label of the group |
|
|
The class name of the nested data fields provider. |
|
|
Additional parameters to be passed to provider constructor method. |
|
|
Data field identifier, class name will be used if empty |
public addSearchKeywords($identifier, $keywords = []):voidAssign keywords to a field to be respected during search.
Name |
Type |
Description |
|
The identifier of the field to assign keywords to. |
|
|
A list of keywords. Each keyword may contain a translation key. A single keyword could be a comma separated list of words. |
Widgets
BaseWidget
BaseWidget class for plentyShop LTS
Namespace
Plenty\Modules\ShopBuilder\Widgets
Methods
public getData():voidpublic getSettings():voidpublic getPreview($widgetSettings = [], $children = []):stringGet the html representation of the widget.
Name |
Type |
Description |
|
The settings provided by the widget. |
|
|
The child widgets of the widget. |
public render($widgetSettings = [], $children = []):stringRender the template of the widget.
Name |
Type |
Description |
|
The settings provided by the widget. |
|
|
The child widgets of the widget. |
Factories
Settings
BaseSettingFactory
Common factory to generate properties of a widget setting definition.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
| Name | Type | Description |
|---|---|---|
data |
Methods
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
CategorySettingFactory
Factory to define a category picker in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
Return type: CategorySettingFactory
Display or hide a button to reset the current selection.
Name |
Type |
Description |
|
public withDisplaySearch($displaySearch):Plenty\Modules\ContentBuilder\Factories\Settings\CategorySettingFactoryReturn type: CategorySettingFactory
Display or hide an input to search for categories with.
Name |
Type |
Description |
|
public withShowFullSelectionPath($showFullSelectionPath):Plenty\Modules\ContentBuilder\Factories\Settings\CategorySettingFactoryReturn type: CategorySettingFactory
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
CheckboxGroupSettingFactory
Factory to define a checkbox group in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withCollapsed($collapsed):Plenty\Modules\ContentBuilder\Factories\Settings\CheckboxGroupSettingFactoryReturn type: CheckboxGroupSettingFactory
Collapse or expand the group by default. The group can be toggled by the user.
Name |
Type |
Description |
|
public withCheckboxValues($checkboxValues):Plenty\Modules\ContentBuilder\Factories\Settings\CheckboxGroupSettingFactoryReturn type: CheckboxGroupSettingFactory
Set available checkboxes of the group.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\CheckboxGroupSettingFactoryReturn type: CheckboxGroupSettingFactory
Set the default value of the group. This should be an array of values.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
CheckboxSettingFactory
Factory to define a checkbox in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withIcon($icon):Plenty\Modules\ContentBuilder\Factories\Settings\CheckboxSettingFactoryReturn type: CheckboxSettingFactory
Set the icon of the checkbox.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
ContainerSettingFactory
Factory to define a container for nested settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public static create($data = []):Plenty\Modules\ContentBuilder\Factories\Settings\ContainerSettingFactoryReturn type: ContainerSettingFactory
Create a new factory instance with initial value.
Name |
Type |
Description |
|
public toArray():arrayGet all children as a native array
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
DateSettingFactory
Factory to define a date picker in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withCalendarTop($isCalendarTop):Plenty\Modules\ContentBuilder\Factories\Settings\DateSettingFactoryReturn type: DateSettingFactory
Display the popup containing the calendar above or below the input field.
Name |
Type |
Description |
|
public withDisplayDateFormat($format):Plenty\Modules\ContentBuilder\Factories\Settings\DateSettingFactoryReturn type: DateSettingFactory
Set the date format to apply to the input field.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
DoubleSettingFactory
Factory to define a number input in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withPriceInput($isPriceInput):Plenty\Modules\ContentBuilder\Factories\Settings\DoubleSettingFactoryReturn type: DoubleSettingFactory
Define if input expects a monetary value.
Name |
Type |
Description |
|
public withDecimalCount($decimalCount):Plenty\Modules\ContentBuilder\Factories\Settings\DoubleSettingFactoryReturn type: DoubleSettingFactory
Set the number of decimal places for the input.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
FileSettingFactory
Factory to define a file input in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withShowPreview($showPreview):Plenty\Modules\ContentBuilder\Factories\Settings\FileSettingFactoryReturn type: FileSettingFactory
Display the preview of the selected file.
Name |
Type |
Description |
|
public withAllowedExtensions($allowedExtensions):Plenty\Modules\ContentBuilder\Factories\Settings\FileSettingFactoryReturn type: FileSettingFactory
Restrict allowed file extensions.
Name |
Type |
Description |
|
public withFoldersAllowed($foldersAllowed):Plenty\Modules\ContentBuilder\Factories\Settings\FileSettingFactoryReturn type: FileSettingFactory
Set to true if the user should be allowed to create new folders.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
RadioGroupSettingFactory
Factory to define a group of radio buttons in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withRadioValues($radioValues):Plenty\Modules\ContentBuilder\Factories\Settings\RadioGroupSettingFactoryReturn type: RadioGroupSettingFactory
Set the available radio buttons in this group.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
SelectSettingFactory
Factory to define a selection input in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withOpenOnTop($openOnTop):Plenty\Modules\ContentBuilder\Factories\Settings\SelectSettingFactoryReturn type: SelectSettingFactory
Set to true to open selection values above the input field.
Name |
Type |
Description |
|
public withListBoxValues($listBoxValues):Plenty\Modules\ContentBuilder\Factories\Settings\SelectSettingFactoryReturn type: SelectSettingFactory
Set available selection values.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
SliderSettingFactory
Factory to define a slider in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withMin($min):Plenty\Modules\ContentBuilder\Factories\Settings\SliderSettingFactoryReturn type: SliderSettingFactory
Set the minimum value of the slider.
Name |
Type |
Description |
|
public withMax($max):Plenty\Modules\ContentBuilder\Factories\Settings\SliderSettingFactoryReturn type: SliderSettingFactory
Set the maximum value of the slider.
Name |
Type |
Description |
|
public withInterval($interval):Plenty\Modules\ContentBuilder\Factories\Settings\SliderSettingFactoryReturn type: SliderSettingFactory
Set the interval between the values of the slider.
Name |
Type |
Description |
|
public withPrecision($precision):Plenty\Modules\ContentBuilder\Factories\Settings\SliderSettingFactoryReturn type: SliderSettingFactory
Set the number of decimal places of the value.
Name |
Type |
Description |
|
public withShowMinMax($showMinMax):Plenty\Modules\ContentBuilder\Factories\Settings\SliderSettingFactoryReturn type: SliderSettingFactory
Set to true to display the minimum and maximum values at each end of the slider.
Name |
Type |
Description |
|
public withShowTicks($showTicks):Plenty\Modules\ContentBuilder\Factories\Settings\SliderSettingFactoryReturn type: SliderSettingFactory
Set to true to display ticks on each value.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
SuggestionSettingFactory
Factory to define an input with suggestions in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withListBoxValues($listBoxValues):Plenty\Modules\ContentBuilder\Factories\Settings\SuggestionSettingFactoryReturn type: SuggestionSettingFactory
Set available values.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
TextSettingFactory
Factory to define a text input in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withPassword($isPassword):Plenty\Modules\ContentBuilder\Factories\Settings\TextSettingFactoryReturn type: TextSettingFactory
Set to true if the input field should be handled as a password input
Name |
Type |
Description |
|
public withReadonly($isReadonly):Plenty\Modules\ContentBuilder\Factories\Settings\TextSettingFactoryReturn type: TextSettingFactory
Set to true if input field should be readonly.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
TextareaSettingFactory
Factory to define a textarea in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withFixedHeight($isFixedHeight):Plenty\Modules\ContentBuilder\Factories\Settings\TextareaSettingFactoryReturn type: TextareaSettingFactory
Set to true if the height should be fixed.
Name |
Type |
Description |
|
public withMaxRows($maxRows):Plenty\Modules\ContentBuilder\Factories\Settings\TextareaSettingFactoryReturn type: TextareaSettingFactory
Set the maximum number of rows for the textarea.
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
UrlSettingFactory
Factory to define an url picker in the widget settings.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public withInternalLinks($internalLinks):Plenty\Modules\ShopBuilder\Factories\Settings\UrlSettingFactoryReturn type: UrlSettingFactory
Name |
Type |
Description |
|
public static create($data = []):voidName |
Type |
Description |
|
public withType($type):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the type of the setting.
Name |
Type |
Description |
|
public withDefaultValue($defaultValue):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the default value for the setting.
Name |
Type |
Description |
|
The default value |
public withCondition($condition):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a condition if the setting should be visible or not.
Name |
Type |
Description |
|
Condition if the related form element should be visible or not. |
public withName($name):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set the name of the setting.
Name |
Type |
Description |
|
The label of the setting |
public withOption($key, $value):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set an option for the setting.
Name |
Type |
Description |
|
The option key |
|
|
The option value |
public withTooltip($tooltip):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Set a tooltip text for this input
Name |
Type |
Description |
|
An additional description of the setting |
public withTooltipPlacement($tooltipPlacement):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Define the tooltip placement. Possible values are 'bottom', 'top', 'left' or 'right', default is 'top'
Name |
Type |
Description |
|
public withList($min, $max):Plenty\Modules\ContentBuilder\Factories\Settings\BaseSettingFactoryReturn type: BaseSettingFactory
Determines whether the declaration is used to render a list of the specified form field.
Name |
Type |
Description |
|
Minimum number of entries. |
|
|
Maximum number of entries. If not set or smaller than 0, unlimited entries might be added by the user. |
public toArray():arrayGet all data as array
ValueListFactory
Create a list of values to be used by settings with multiple predefined values.
Namespace
Plenty\Modules\ShopBuilder\Factories\Settings
Methods
public static make():Plenty\Modules\ContentBuilder\Factories\Settings\ValueListFactoryReturn type: ValueListFactory
Create a new factory instance.
public addEntry($value, $caption):Plenty\Modules\ContentBuilder\Factories\Settings\ValueListFactoryReturn type: ValueListFactory
Add an entry to the list of values
Name |
Type |
Description |
|
||
|
public addEntryWithCondition($value, $caption, $condition):Plenty\Modules\ContentBuilder\Factories\Settings\ValueListFactoryReturn type: ValueListFactory
Add an entry to the list that will be shown if a condition is met
Name |
Type |
Description |
|
||
|
||
|
public toArray():voidGet all values.