Catalog

DataProviders

BaseDataProvider

To be written

Namespace

Plenty\Modules\Catalog\DataProviders

Methods

public getRows():array

KeyDataProvider

To be written

Namespace

Plenty\Modules\Catalog\DataProviders

Methods

public getKey():string
public getRows():array

Contracts

CatalogExportFilterServiceContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public applyFilters(DocumentSearch
 $documentSearch, array $config):void
Parameters
DocumentSearch $documentSearch
array $config

CatalogRepositoryContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public create(array $data):Catalog
Parameters
array $data
public get(string $id):Catalog
Parameters
string $id
public delete(string $id):bool
Parameters
string $id
public all(int $page = 1, int $perPage = 25):PaginatedResult
Parameters
int $page
int $perPage
public setFilters(array $filters = []):void

Sets the filter array.

Parameters
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.

TemplateContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public getName():string
public getType():string
public getMappings():array
public addMapping(array $mapping):void
Parameters
array $mapping
public addMutator(callable $callback):void
Parameters
callable $callback
public getFilter():array
public addFilter(array $filter):void
Parameters
array $filter
public getIdentifier():string
public getMutators():array
public setSkuCallback(callable $callback):void
Parameters
callable $callback
public getSkuCallback():callable
public addSetting(array $setting):void
Parameters
array $setting
public getSettings():array
public setMetaInfo(array $meta):void
Parameters
array $meta
public getMetaInfo():array
public toArray():array

Get the instance as an array.

public jsonSerialize():void

TemplateContainerContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public register(string $name, string $type):TemplateContract
Parameters
string $name
string $type
public getTemplates():array
public getTemplate(string $identifier):TemplateContract
Parameters
string $identifier

CatalogExportServiceContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public setAdditionalFields(array $additionalFields):void
Parameters
array $additionalFields
public setSettings(array $settings):void
Parameters
array $settings
public setNumberOfDocumentsPerShard(int $numberOfDocumentsPerShard):void
Parameters
int $numberOfDocumentsPerShard
public setUpdatedSince(Carbon
 $timestamp):void
Parameters
Carbon $timestamp
public getResult():CatalogExportResult

DataProviderContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public getData(string $query = ""):array
Parameters
string $query

CatalogContentRepositoryContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public get(string $id):array
Parameters
string $id
public update(string $id, array $data):array
Parameters
string $id
array $data

CatalogExportRepositoryContract

To be written

Namespace

Plenty\Modules\Catalog\Contracts

Methods

public exportById(string $id):CatalogExportServiceContract
Parameters
string $id

Models

Catalog

The catalog model

Namespace

Plenty\Modules\Catalog\Models

Properties

Type Name Description
array data
string name
string template
string id

Methods

public toArray()

Returns this model as an array.

CatalogExportResult

To be written

Namespace

Plenty\Modules\Catalog\Models

Methods

public toArray()

Returns this model as an array.

Templates

Template

foo

Namespace

Plenty\Modules\Catalog\Templates

Methods

public getMappings():array
public addMapping(array $section):void
Parameters
array $section
public addMutator(callable $callback):void
Parameters
callable $callback
public getFilter():array
public addFilter(array $filter):void
Parameters
array $filter
public getMutators():array
public setSkuCallback(callable $callback):void
Parameters
callable $callback
public getSkuCallback():callable
public addSetting(array $setting):void
Parameters
array $setting
public getSettings():array
public setMetaInfo(array $meta):void
Parameters
array $meta
public getMetaInfo():void
public getName():string
public getType():string
public toArray():void
public jsonSerialize():void
public getIdentifier():string