Documentation

SubmitAnswer

Use case for submitting an answer during review.

Updates word status and session progress.

Tags
since
3.0.0

Table of Contents

Properties

$repository  : ReviewRepositoryInterface
$sessionManager  : SessionStateManager

Methods

__construct()  : mixed
Constructor.
execute()  : array{success: bool, oldStatus: int, newStatus: int, oldScore: int, newScore: int, statusChange: int, progress: array{total: int, wrong: int, correct: int, remaining: int}, error?: string}
Submit answer with explicit new status.
executeWithChange()  : array<string|int, mixed>
Submit answer with relative status change.
calculateNewStatus()  : int
Calculate new status based on change direction.
calculateStatusChange()  : int
Calculate status change direction.
isValidStatus()  : bool
Check if status is valid.
updateSessionProgress()  : array{total: int, wrong: int, correct: int, remaining: int}
Update session progress after answer.

Properties

Methods

execute()

Submit answer with explicit new status.

public execute(int $wordId, int $newStatus) : array{success: bool, oldStatus: int, newStatus: int, oldScore: int, newScore: int, statusChange: int, progress: array{total: int, wrong: int, correct: int, remaining: int}, error?: string}
Parameters
$wordId : int

Word ID

$newStatus : int

New status (1-5, 98, 99)

Return values
array{success: bool, oldStatus: int, newStatus: int, oldScore: int, newScore: int, statusChange: int, progress: array{total: int, wrong: int, correct: int, remaining: int}, error?: string}

executeWithChange()

Submit answer with relative status change.

public executeWithChange(int $wordId, int $change) : array<string|int, mixed>
Parameters
$wordId : int

Word ID

$change : int

Change amount (+1 or -1)

Return values
array<string|int, mixed>

Same as execute()

calculateNewStatus()

Calculate new status based on change direction.

private calculateNewStatus(int $currentStatus, int $change) : int
Parameters
$currentStatus : int

Current status

$change : int

Change amount

Return values
int

New status

calculateStatusChange()

Calculate status change direction.

private calculateStatusChange(int $oldStatus, int $newStatus) : int
Parameters
$oldStatus : int

Old status

$newStatus : int

New status

Return values
int

-1, 0, or 1

isValidStatus()

Check if status is valid.

private isValidStatus(int $status) : bool
Parameters
$status : int

Status value

Return values
bool

updateSessionProgress()

Update session progress after answer.

private updateSessionProgress(int $statusChange) : array{total: int, wrong: int, correct: int, remaining: int}
Parameters
$statusChange : int

Status change direction

Return values
array{total: int, wrong: int, correct: int, remaining: int}

        
On this page

Search results