DatasetManager
FinalYes
Table of Contents
Constants
- EVENT_ON_AFTER_ADD_DATASET = 'onAfterAddDataset'
- EVENT_ON_AFTER_DELETE_DATASET = 'onAfterDeleteDataset'
Methods
- add() : Result
- Adds new dataset with field and settings
- delete() : Result
- Deletes dataset with fields and settings
- getById() : ExternalDataset|null
- Gets dataset data
- getDatasetFieldsById() : ExternalDatasetFieldCollection
- Gets fields by dataset id
- getDatasetSettingsById() : ExternalDatasetFieldFormatCollection
- Gets settings by dataset id
- getList() : ExternalDatasetCollection
- Gets list of datasets
- update() : Result
- Updates dataset with field and settings
Constants
EVENT_ON_AFTER_ADD_DATASET
public
mixed
EVENT_ON_AFTER_ADD_DATASET
= 'onAfterAddDataset'
EVENT_ON_AFTER_DELETE_DATASET
public
mixed
EVENT_ON_AFTER_DELETE_DATASET
= 'onAfterDeleteDataset'
Methods
add()
Adds new dataset with field and settings
public
static add(array<string|int, mixed> $dataset, array<string|int, mixed> $fields, array<string|int, mixed> $settings[, int|null $sourceId = null ]) : Result
Parameters
- $dataset : array<string|int, mixed>
- $fields : array<string|int, mixed>
- $settings : array<string|int, mixed>
- $sourceId : int|null = null
Return values
Resultdelete()
Deletes dataset with fields and settings
public
static delete(int $id) : Result
Parameters
- $id : int
Return values
ResultgetById()
Gets dataset data
public
static getById(int $id) : ExternalDataset|null
Parameters
- $id : int
Return values
ExternalDataset|nullgetDatasetFieldsById()
Gets fields by dataset id
public
static getDatasetFieldsById(int $id) : ExternalDatasetFieldCollection
Parameters
- $id : int
Return values
ExternalDatasetFieldCollectiongetDatasetSettingsById()
Gets settings by dataset id
public
static getDatasetSettingsById(int $id) : ExternalDatasetFieldFormatCollection
Parameters
- $id : int
Return values
ExternalDatasetFieldFormatCollectiongetList()
Gets list of datasets
public
static getList([array<string|int, mixed> $filter = [] ]) : ExternalDatasetCollection
Parameters
- $filter : array<string|int, mixed> = []
Return values
ExternalDatasetCollectionupdate()
Updates dataset with field and settings
public
static update(int $id[, array<string|int, mixed> $dataset = [] ][, array<string|int, mixed> $fields = [] ][, array<string|int, mixed> $settings = [] ]) : Result
Parameters
- $id : int
- $dataset : array<string|int, mixed> = []
- $fields : array<string|int, mixed> = []
- $settings : array<string|int, mixed> = []