MultiWordApiHandler
in package
Handler for multi-word expression API operations.
Provides endpoints for:
- Getting multi-word expression data for editing
- Creating new multi-word expressions
- Updating existing multi-word expressions
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructor.
- createMultiWordTerm() : array{term_id?: int, term_lc?: string, hex?: string, error?: string}
- Create a new multi-word expression.
- getMultiWordForEdit() : array<string|int, mixed>
- Get multi-word expression data for editing.
- updateMultiWordTerm() : array{success?: bool, status?: int, error?: string}
- Update an existing multi-word expression.
Properties
$contextService
private
WordContextService
$contextService
$multiWordService
private
MultiWordService
$multiWordService
Methods
__construct()
Constructor.
public
__construct([MultiWordService|null $multiWordService = null ][, WordContextService|null $contextService = null ]) : mixed
Parameters
- $multiWordService : MultiWordService|null = null
-
Multi-word service
- $contextService : WordContextService|null = null
-
Context service
createMultiWordTerm()
Create a new multi-word expression.
public
createMultiWordTerm(array<string|int, mixed> $data) : array{term_id?: int, term_lc?: string, hex?: string, error?: string}
Parameters
- $data : array<string|int, mixed>
-
Multi-word data:
- textId: Text ID
- position: Position in text
- text: Multi-word text
- wordCount: Number of words
- translation: Translation
- romanization: Romanization
- sentence: Example sentence
- notes: Notes (optional)
- status: Status (1-5)
Return values
array{term_id?: int, term_lc?: string, hex?: string, error?: string}getMultiWordForEdit()
Get multi-word expression data for editing.
public
getMultiWordForEdit(int $textId, int $position[, string|null $text = null ][, int|null $wordId = null ]) : array<string|int, mixed>
Parameters
- $textId : int
-
Text ID
- $position : int
-
Position in text
- $text : string|null = null
-
Multi-word text (for new expressions)
- $wordId : int|null = null
-
Word ID (for existing expressions)
Return values
array<string|int, mixed> —Multi-word data or error
updateMultiWordTerm()
Update an existing multi-word expression.
public
updateMultiWordTerm(int $termId, array<string|int, mixed> $data) : array{success?: bool, status?: int, error?: string}
Parameters
- $termId : int
-
Term ID
- $data : array<string|int, mixed>
-
Multi-word data (translation, romanization, sentence, notes, status)