TextPositionApiHandler
in package
Handler for text position, audio, display mode, and bulk status operations.
Table of Contents
Properties
Methods
- __construct() : mixed
- formatMarkAllIgnored() : array{count: int, words?: array}
- Format response for marking all words as ignored.
- formatMarkAllWellKnown() : array{count: int, words?: array}
- Format response for marking all words as well-known.
- formatSetAudioPosition() : array{audio: string}
- Format response for setting audio position.
- formatSetDisplayMode() : array{updated: bool, error?: string}
- Format response for setting display mode.
- formatSetTextPosition() : array{text: string}
- Format response for setting text position.
- markAllIgnored() : array{count: int, words?: array}
- Mark all unknown words in a text as ignored.
- markAllWellKnown() : array{count: int, words?: array}
- Mark all unknown words in a text as well-known.
- saveAudioPosition() : void
- Save the audio position in the text.
- saveTextPosition() : void
- Save the reading position of the text.
- setDisplayMode() : array{updated: bool, error?: string}
- Set display mode settings for a text.
Properties
$discoveryService
private
WordDiscoveryService
$discoveryService
Methods
__construct()
public
__construct([WordDiscoveryService|null $discoveryService = null ]) : mixed
Parameters
- $discoveryService : WordDiscoveryService|null = null
formatMarkAllIgnored()
Format response for marking all words as ignored.
public
formatMarkAllIgnored(int $textId) : array{count: int, words?: array}
Parameters
- $textId : int
-
Text ID
Return values
array{count: int, words?: array}formatMarkAllWellKnown()
Format response for marking all words as well-known.
public
formatMarkAllWellKnown(int $textId) : array{count: int, words?: array}
Parameters
- $textId : int
-
Text ID
Return values
array{count: int, words?: array}formatSetAudioPosition()
Format response for setting audio position.
public
formatSetAudioPosition(int $textId, int $position) : array{audio: string}
Parameters
- $textId : int
-
Text ID
- $position : int
-
Audio position
Return values
array{audio: string}formatSetDisplayMode()
Format response for setting display mode.
public
formatSetDisplayMode(int $textId, array<string|int, mixed> $params) : array{updated: bool, error?: string}
Parameters
- $textId : int
-
Text ID
- $params : array<string|int, mixed>
-
Display mode parameters
Return values
array{updated: bool, error?: string}formatSetTextPosition()
Format response for setting text position.
public
formatSetTextPosition(int $textId, int $position) : array{text: string}
Parameters
- $textId : int
-
Text ID
- $position : int
-
Position
Return values
array{text: string}markAllIgnored()
Mark all unknown words in a text as ignored.
public
markAllIgnored(int $textId) : array{count: int, words?: array}
Parameters
- $textId : int
-
Text ID
Return values
array{count: int, words?: array}markAllWellKnown()
Mark all unknown words in a text as well-known.
public
markAllWellKnown(int $textId) : array{count: int, words?: array}
Parameters
- $textId : int
-
Text ID
Return values
array{count: int, words?: array}saveAudioPosition()
Save the audio position in the text.
public
saveAudioPosition(int $textid, int $audioposition) : void
Parameters
- $textid : int
-
Text ID
- $audioposition : int
-
Audio position
saveTextPosition()
Save the reading position of the text.
public
saveTextPosition(int $textid, int $position) : void
Parameters
- $textid : int
-
Text ID
- $position : int
-
Position in text to save
setDisplayMode()
Set display mode settings for a text.
public
setDisplayMode(int $textId, int|null $annotations, bool|null $romanization, bool|null $translation) : array{updated: bool, error?: string}
Parameters
- $textId : int
-
Text ID
- $annotations : int|null
-
Annotation mode (0=none, 1=translations, 2=romanization, 3=both)
- $romanization : bool|null
-
Whether to show romanization
- $translation : bool|null
-
Whether to show translation