Plentymarkets interface documentation

AuditLog

Contracts

AuditLogArchiveRepositoryContract

manage the audit log archive data

Namespace

Plenty\Modules\AuditLog\Contracts

Methods

Search for available archive files.

Parameters

Name

Type

Description

$page

int

$perPage

int

$filters

array

 
public count($filters = []):int

Get the number of found archives, restricted by filters.

Parameters

Name

Type

Description

$filters

array

 
public restore($key):void

Restore an audit log archive and make it downloadable for approximately 2 days. There may be costs.

Parameters

Name

Type

Description

$key

string

 
public getSignedUrl($key):string

Get a signed url of an archive to download it.

Parameters

Name

Type

Description

$key

string

AuditLogEntitiesRepositoryContract

Get possible auditLog entities

Namespace

Plenty\Modules\AuditLog\Contracts

Methods
public getGroups():array

Get list of entity groups

public getEntities():array

Get list of entities

AuditLogExportRepositoryContract

get audit log files

Namespace

Plenty\Modules\AuditLog\Contracts

Methods
public all():array

Get all available files

public getSignedUrl($key):string

Get a signed url of an archive to download it.

Parameters

Name

Type

Description

$key

string

AuditLogSystemConfigRepositoryContract

Configure the audit log configuration

Namespace

Plenty\Modules\AuditLog\Contracts

Methods
public save($systemConfig):Plenty\Modules\AuditLog\Models\SystemConfig
Return type: SystemConfig

Save a audit log system config

Parameters

Name

Type

Description

$systemConfig

SystemConfig

 
public get():Plenty\Modules\AuditLog\Models\SystemConfig
Return type: SystemConfig

Get the current audit log system config

Models

Archive

Contains informations about one archive file

Namespace

Plenty\Modules\AuditLog\Models

Properties
Name Type Description

file

string

The file name of the archive

month

int

The month of the archive

year

int

The year of the archive

size

int

The size of the archive

status

string

The status of the file. Possible values are: accessible, restore_in_progress, archived

estimatedDeletionDate

Carbon

The date this file will be estimated deleted from the archive

accessibleUntil

Carbon

The date this file is not available anymore
Methods
public toArray()

Returns this model as an array.

Entity

Contains the information about one audit log entity

Namespace

Plenty\Modules\AuditLog\Models

Properties
Name Type Description

key

string

The audit log entity

requiredForCertificate

bool

Is the entity required for the IDW PS 880 certificate

alwaysActive

bool

Is the entity always active and can not be deactivated

free

bool

Is the entity free of charge
Methods
public toArray()

Returns this model as an array.

EntityGroup

Contains the entities depending to a group

Namespace

Plenty\Modules\AuditLog\Models

Properties
Name Type Description

name

string

The group name

entities

array

The entities depending to this group
Methods
public toArray()

Returns this model as an array.

File

Contains informations about one file

Namespace

Plenty\Modules\AuditLog\Models

Properties
Name Type Description

file

string

The file name of the file

month

int

The month of the file

year

int

The year of the file

day

int

The day of the file

size

int

The size of the file

estimatedDeletionDate

Carbon

The date this file will be estimated deleted
Methods
public toArray()

Returns this model as an array.

SystemConfig

Contains entries, which should be saved

Namespace

Plenty\Modules\AuditLog\Models

Properties
Name Type Description

entries

array

List of SystemConfigEntries

archiveActive

bool

Is the Archive activated
Methods
public toArray()

Returns this model as an array.

SystemConfigEntry

Contains the configuration for one audit log entity

Namespace

Plenty\Modules\AuditLog\Models

Properties
Name Type Description

entity

string

The audit log entity

active

bool

Should the entity be logged
Methods
public toArray()

Returns this model as an array.