Plentymarkets interface documentation
DataExchange
Contracts
CSVGenerator
generator for csv content
Namespace
Plenty\Modules\DataExchange\Contracts
Methods
public setDelimiter($delimiter):void
Name |
Type |
Description |
|
public setEnclosure($enclosure):void
Name |
Type |
Description |
|
public addCSVContent($data):void
Name |
Type |
Description |
|
public addBulkCSVContent($data):void
Name |
Type |
Description |
|
public addContent($content):void
Name |
Type |
Description |
|
public generateContent($resultData, $formatSettings = []):void
Name |
Type |
Description |
|
||
|
CSVPluginGenerator
generator for csv content
Namespace
Plenty\Modules\DataExchange\Contracts
Methods
public setDelimiter($delimiter):void
Name |
Type |
Description |
|
public setEnclosure($enclosure):void
Name |
Type |
Description |
|
public addCSVContent($data):void
Name |
Type |
Description |
|
public addBulkCSVContent($data):void
Name |
Type |
Description |
|
public addContent($content):void
Name |
Type |
Description |
|
public generatePluginContent($resultData, $formatSettings = [], $filter = []):void
Name |
Type |
Description |
|
||
|
||
|
ExportRepositoryContract
Namespace
Plenty\Modules\DataExchange\Contracts
Methods
public create($data):Plenty\Modules\DataExchange\Models\Export
Return type: Export
Name |
Type |
Description |
|
public update($data, $exportId):Plenty\Modules\DataExchange\Models\Export
Return type: Export
Name |
Type |
Description |
|
||
|
public delete($exportId):bool
Name |
Type |
Description |
|
public search($params = [], $with = [], $columns = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult
Name |
Type |
Description |
|
||
|
||
|
public findById($exportId, $with = []):Plenty\Modules\DataExchange\Models\Export
Filters
Filters
Namespace
Plenty\Modules\DataExchange\Contracts
Methods
public generateFilters($formatSettings = []):array
Name |
Type |
Description |
|
ResultFields
ResultFields
Namespace
Plenty\Modules\DataExchange\Contracts
Methods
public generateResultFields($formatSettings = []):array
Name |
Type |
Description |
|
public setGroupByList($groupByList):void
Name |
Type |
Description |
|
public setOrderByList($orderByList):void
Name |
Type |
Description |
|
XMLGenerator
generator for xml content
Namespace
Plenty\Modules\DataExchange\Contracts
Name | Type | Description |
---|---|---|
version |
||
encoding |
||
formatOutput |
||
preserveWhiteSpace |
Methods
public init($rootName):void
Initializes the xml document and the root element.
Name |
Type |
Description |
|
public root():\DOMElement
public build():void
Build the XML.
public createElement($name, $value = null):\DOMElement
Create an XML element.
Name |
Type |
Description |
|
||
|
public createCDATASection($data):\DOMCdataSection
Create a CDATA section.
Name |
Type |
Description |
|
public createAttribute($name, $value = null):\DOMAttr
Create an XML attribute.
Name |
Type |
Description |
|
||
|
public createTextNode($content):\DOMText
Create new text node.
Name |
Type |
Description |
|
public addContent($content):void
Name |
Type |
Description |
|
public generateContent($resultData, $formatSettings = []):void
Name |
Type |
Description |
|
||
|
XMLPluginGenerator
generator for xml content
Namespace
Plenty\Modules\DataExchange\Contracts
Name | Type | Description |
---|---|---|
version |
||
encoding |
||
formatOutput |
||
preserveWhiteSpace |
Methods
public init($rootName):void
Initializes the xml document and the root element.
Name |
Type |
Description |
|
public root():\DOMElement
public build():void
Build the XML.
public createElement($name, $value = null):\DOMElement
Create an XML element.
Name |
Type |
Description |
|
||
|
public createCDATASection($data):\DOMCdataSection
Create a CDATA section.
Name |
Type |
Description |
|
public createAttribute($name, $value = null):\DOMAttr
Create an XML attribute.
Name |
Type |
Description |
|
||
|
public createTextNode($content):\DOMText
Create new text node.
Name |
Type |
Description |
|
public addContent($content):void
Name |
Type |
Description |
|
public generatePluginContent($resultData, $formatSettings = [], $filter = []):void
Name |
Type |
Description |
|
||
|
||
|
Models
Export
Export model
Namespace
Plenty\Modules\DataExchange\Models
Name | Type | Description |
---|---|---|
id |
export id |
|
name |
export name |
|
type |
export type |
|
limit |
maximum number of entries |
|
createdAt |
created at date timestamp |
|
updatedAt |
last update date timestamp |
|
formatKey |
the format key |
|
outputType |
the output type |
|
generateCache |
if cache should be generated |
|
filters |
list of filters defined by backend users |
|
outputParams |
list of output params |
|
formatSettings |
list of format settings |
Methods
public toArray()
Returns this model as an array.
Filter
export filter
Namespace
Plenty\Modules\DataExchange\Models
Name | Type | Description |
---|---|---|
id |
filter id |
|
createdAt |
created at date timestamp |
|
updatedAt |
last update date timestamp |
|
exportId |
depending export id |
|
key |
filter key |
|
value |
filter value |
Methods
public toArray()
Returns this model as an array.
FormatSetting
format setting
Namespace
Plenty\Modules\DataExchange\Models
Name | Type | Description |
---|---|---|
id |
format setting id |
|
createdAt |
created at date timestamp |
|
updatedAt |
last update date timestamp |
|
exportId |
depending export id |
|
key |
format setting key |
|
value |
format setting value |
Methods
public toArray()
Returns this model as an array.
OutputParam
output params
Namespace
Plenty\Modules\DataExchange\Models
Name | Type | Description |
---|---|---|
id |
output param id |
|
createdAt |
created at date timestamp |
|
updatedAt |
last update date timestamp |
|
exportId |
depending export id |
|
key |
output param key |
|
value |
output param value |
Methods
public toArray()
Returns this model as an array.
Services
ExportPresetContainer
Register export presets
Namespace
Plenty\Modules\DataExchange\Services
Methods
public add($exportKey, $resultFieldsClass, $generatorClass, $filterClass = "", $isPlugin = false, $generatorExecute = false, $exportType = "item", $restrictRows = true):void
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Resource
Contracts
ResourceLoaderContract
Repository Contract for ResourceLoader
Namespace
Plenty\Modules\DataExchange\Resource\Contracts
Methods
public getResource($sourceOptions):void
Name |
Type |
Description |
|
public getResourceBag($sourceOptions):Plenty\Modules\DataExchange\Resource\Models\ResourceBag
Return type: ResourceBag
Name |
Type |
Description |
|
public validateSourceOptions($sourceOptions):void
Name |
Type |
Description |
|
public archiveFile($sourceOptions):void
Name |
Type |
Description |
|
public getLoaderType():string
Factories
ResourceLoaderFactory
Namespace
Plenty\Modules\DataExchange\Resource\Factories
Methods
public getResourceLoaderByType($type):Plenty\Modules\DataExchange\Resource\Contracts\ResourceLoaderContract
Return type: ResourceLoaderContract
Name |
Type |
Description |
|
public addLoader($loader):void
Name |
Type |
Description |
|
ResourceParserFactory
Namespace
Plenty\Modules\DataExchange\Resource\Factories
Methods
public getResourceParserByType($type):Plenty\Modules\DataExchange\Resource\Contracts\ResourceParserContract
Return type: ResourceParserContract
Name |
Type |
Description |
|
public addParser($parser):void
Name |
Type |
Description |
|