Plentymarkets interface documentation

MyView

Contracts

PresetContainerContract

This container contains presets registered at boot time

Namespace

Plenty\Modules\MyView\Contracts

Methods
public registerPresets($presets):void

Register an array of presets

Parameters

Name

Type

Description

$presets

array

public getAll():array

Returns an array of preset-container collections

public getPresetsForMyViewKey($myViewKey):array

Get all presets for a given my-view key

Parameters

Name

Type

Description

$myViewKey

string

ViewSetNameRepositoryContract

This interface provides a method to update ViewSetNames

Namespace

Plenty\Modules\MyView\Contracts

Methods
public updateViewSetName($name, $id):void

Update given view set name.

Parameters

Name

Type

Description

$name

string

$id

int

ViewSetPermissionContract

This interface provides methods to create, get, update and delete ViewSets

Namespace

Plenty\Modules\MyView\Contracts

Methods

Search permissions

Parameters

Name

Type

Description

$searchParams

array

public save($data):bool

Save permissions

Parameters

Name

Type

Description

$data

array

public updateDefaultViewSetRelation($relations, $key):void

Update given default view set relations.

Parameters

Name

Type

Description

$relations

array

$key

string

public updateViewSetRelation($relations, $viewSetId):void

Update given view set relations.

Parameters

Name

Type

Description

$relations

array

$viewSetId

int

ViewSetRepositoryContract

This interface provides methods to create, get, update and delete ViewSets

Namespace

Plenty\Modules\MyView\Contracts

Methods

Search the list of view sets.

Parameters

Name

Type

Description

$searchParams

array

public get($id):void

Get given view set.

Parameters

Name

Type

Description

$id

int

public create($data):void

Create given view set.

Parameters

Name

Type

Description

$data

array

public update($id, $data):void

Update given view set.

Parameters

Name

Type

Description

$id

int

$data

array

public delete($id):void

Delete given view set.

Parameters

Name

Type

Description

$id

int

public setActive($userId, $viewSetId, $viewSetKey):void

Set the given view set active by user id

Parameters

Name

Type

Description

$userId

int

$viewSetId

int

$viewSetKey

string