TermStatusApiHandler
in package
Handler for term status API operations.
Provides endpoints for:
- Updating single term status
- Incrementing/decrementing status
- Bulk status updates
- Getting status list
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructor.
- bulkUpdateStatus() : array{count: int, error?: string}
- Bulk update status for multiple terms.
- formatBulkStatus() : array<string|int, mixed>
- Alias for formatBulkUpdateStatus (for API compatibility).
- formatBulkUpdateStatus() : array<string|int, mixed>
- Format response for bulk status update.
-
formatGetStatuses()
: array{statuses: array
- Format response for getting all statuses.
- formatIncrementStatus() : array<string|int, mixed>
- Format response for incrementing status.
- formatIncrementStatusHtml() : array{increment?: string, error?: string}
- Format response for incrementing term status (with HTML controls).
- formatSetStatus() : array{set: int}
- Format response for setting term status.
- formatUpdateStatus() : array<string|int, mixed>
- Format response for updating status.
- getNewStatus() : int
- Check the consistency of the new status.
- incrementStatus() : array{success: bool, status?: int, error?: string}
- Increment or decrement term status.
- incrementTermStatus() : string
- Do a word status change.
- setWordStatus() : int
- Force a term to get a new status.
- updateStatus() : array{success: bool, status?: int, error?: string}
- Update term status.
- updateWordStatus() : string|null
- Save the new word status to the database, return the controls.
Properties
$facade
private
VocabularyFacade
$facade
Methods
__construct()
Constructor.
public
__construct([VocabularyFacade|null $facade = null ]) : mixed
Parameters
- $facade : VocabularyFacade|null = null
-
Vocabulary facade
bulkUpdateStatus()
Bulk update status for multiple terms.
public
bulkUpdateStatus(array<string|int, int> $termIds, int $status) : array{count: int, error?: string}
Parameters
- $termIds : array<string|int, int>
-
Term IDs
- $status : int
-
New status
Return values
array{count: int, error?: string}formatBulkStatus()
Alias for formatBulkUpdateStatus (for API compatibility).
public
formatBulkStatus(array<string|int, int> $termIds, int $status) : array<string|int, mixed>
Parameters
- $termIds : array<string|int, int>
-
Term IDs
- $status : int
-
New status
Return values
array<string|int, mixed>formatBulkUpdateStatus()
Format response for bulk status update.
public
formatBulkUpdateStatus(array<string|int, int> $termIds, int $status) : array<string|int, mixed>
Parameters
- $termIds : array<string|int, int>
-
Term IDs
- $status : int
-
New status
Return values
array<string|int, mixed>formatGetStatuses()
Format response for getting all statuses.
public
formatGetStatuses() : array{statuses: array}
Return values
array{statuses: arrayformatIncrementStatus()
Format response for incrementing status.
public
formatIncrementStatus(int $termId, bool $up) : array<string|int, mixed>
Parameters
- $termId : int
-
Term ID
- $up : bool
-
True to increment, false to decrement
Return values
array<string|int, mixed>formatIncrementStatusHtml()
Format response for incrementing term status (with HTML controls).
public
formatIncrementStatusHtml(int $termId, bool $statusUp) : array{increment?: string, error?: string}
Parameters
- $termId : int
-
Term ID
- $statusUp : bool
-
Whether to increment (true) or decrement (false)
Return values
array{increment?: string, error?: string}formatSetStatus()
Format response for setting term status.
public
formatSetStatus(int $termId, int $status) : array{set: int}
Parameters
- $termId : int
-
Term ID
- $status : int
-
New status
Return values
array{set: int}formatUpdateStatus()
Format response for updating status.
public
formatUpdateStatus(int $termId, int $status) : array<string|int, mixed>
Parameters
- $termId : int
-
Term ID
- $status : int
-
New status
Return values
array<string|int, mixed>getNewStatus()
Check the consistency of the new status.
public
getNewStatus(int $oldstatus, bool $up) : int
Parameters
- $oldstatus : int
-
Old status
- $up : bool
-
True if status should incremented, false if decrementation needed
Return values
int —New status in the good number range (1-5, 98, or 99)
incrementStatus()
Increment or decrement term status.
public
incrementStatus(int $termId, bool $up) : array{success: bool, status?: int, error?: string}
Parameters
- $termId : int
-
Term ID
- $up : bool
-
True to increment, false to decrement
Return values
array{success: bool, status?: int, error?: string}incrementTermStatus()
Do a word status change.
public
incrementTermStatus(int $wid, bool $up) : string
Parameters
- $wid : int
-
Word ID
- $up : bool
-
Should the status be incremeted or decremented
Return values
string —HTML-formatted string for increments
setWordStatus()
Force a term to get a new status.
public
setWordStatus(int $wid, int $status) : int
Parameters
- $wid : int
-
ID of the word to edit
- $status : int
-
New status to set
Return values
int —Number of affected rows
updateStatus()
Update term status.
public
updateStatus(int $termId, int $status) : array{success: bool, status?: int, error?: string}
Parameters
- $termId : int
-
Term ID
- $status : int
-
New status
Return values
array{success: bool, status?: int, error?: string}updateWordStatus()
Save the new word status to the database, return the controls.
public
updateWordStatus(int $wid, int $currstatus) : string|null
Parameters
- $wid : int
-
Word ID
- $currstatus : int
-
Current status in the good value range.
Return values
string|null —HTML-formatted string with plus/minus controls if a success.