TextDisplayService
in package
Service class for displaying annotated texts.
Handles data retrieval for improved text display views.
Tags
Table of Contents
Methods
- getAnnotatedText() : string
- Get annotated text content.
- getAudioUri() : string|null
- Get audio URI for a text.
- getHeaderData() : array{title: string, audio: string, sourceUri: string|null}|null
- Get header data for a text.
- getTextDisplaySettings() : array{textSize: int, rtlScript: bool}|null
- Get text display settings (text size, RTL).
- getWordRomanization() : string
- Get word romanization by ID.
- parseAnnotationItem() : array{type: int, text: string, trans: string, rom: string}|null
- Parse annotation item into display data.
- parseAnnotations() : array<string|int, mixed>
- Parse all annotations from annotated text.
- saveCurrentText() : void
- Save current text ID to settings.
Methods
getAnnotatedText()
Get annotated text content.
public
getAnnotatedText(int $textId) : string
Parameters
- $textId : int
-
Text ID
Return values
string —Annotated text
getAudioUri()
Get audio URI for a text.
public
getAudioUri(int $textId) : string|null
Parameters
- $textId : int
-
Text ID
Return values
string|null —Audio URI or null
getHeaderData()
Get header data for a text.
public
getHeaderData(int $textId) : array{title: string, audio: string, sourceUri: string|null}|null
Parameters
- $textId : int
-
Text ID
Return values
array{title: string, audio: string, sourceUri: string|null}|nullgetTextDisplaySettings()
Get text display settings (text size, RTL).
public
getTextDisplaySettings(int $textId) : array{textSize: int, rtlScript: bool}|null
Parameters
- $textId : int
-
Text ID
Return values
array{textSize: int, rtlScript: bool}|nullgetWordRomanization()
Get word romanization by ID.
public
getWordRomanization(int $wordId) : string
Parameters
- $wordId : int
-
Word ID
Return values
string —Romanization or empty string
parseAnnotationItem()
Parse annotation item into display data.
public
parseAnnotationItem(string $item) : array{type: int, text: string, trans: string, rom: string}|null
Parameters
- $item : string
-
Annotation item (tab-separated values)
Return values
array{type: int, text: string, trans: string, rom: string}|nullparseAnnotations()
Parse all annotations from annotated text.
public
parseAnnotations(string $annotatedText) : array<string|int, mixed>
Parameters
- $annotatedText : string
-
Raw annotated text
Return values
array<string|int, mixed> —Array of parsed annotation items
saveCurrentText()
Save current text ID to settings.
public
saveCurrentText(int $textId) : void
Parameters
- $textId : int
-
Text ID