StringCorrectionApi
extends AbstractApi
in package
Use API to manage string corrections in Source Text Review workflow
Table of Contents
Methods
- create() : StringCorrection|null
- Add Correction
- delete() : mixed
- Delete Correction
- deleteAll() : mixed
- Delete Corrections
- get() : StringCorrection|null
- Get Correction
- list() : ModelCollection
- List Corrections
- restore() : StringCorrection|null
- Restore Correction
Methods
create()
Add Correction
public
create(int $projectId, array<string|int, mixed> $data) : StringCorrection|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
integer $data[stringId] required
string $data[text] required
string $data[pluralCategoryName]
Tags
Return values
StringCorrection|nulldelete()
Delete Correction
public
delete(int $projectId, int $correctionId) : mixed
Parameters
- $projectId : int
- $correctionId : int
Tags
deleteAll()
Delete Corrections
public
deleteAll(int $projectId, int $stringId) : mixed
Parameters
- $projectId : int
- $stringId : int
Tags
get()
Get Correction
public
get(int $projectId, int $correctionId[, array<string|int, mixed> $params = [] ]) : StringCorrection|null
Parameters
- $projectId : int
- $correctionId : int
- $params : array<string|int, mixed> = []
-
integer $params[denormalizePlaceholders] default: 0
Tags
Return values
StringCorrection|nulllist()
List Corrections
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
integer $params[stringId] required
integer $params[limit] default: 25
integer $params[offset] default: 0
string $params[orderBy]
integer $params[denormalizePlaceholders]
Tags
Return values
ModelCollectionrestore()
Restore Correction
public
restore(int $projectId, int $correctionId) : StringCorrection|null
Parameters
- $projectId : int
- $correctionId : int