Documentation

TermQueryMethods

Query methods for MySqlTermRepository.

Provides find/search/pagination methods that read term data from the database without modifying it.

Tags
since
3.0.0

Table of Contents

Methods

findByLemma()  : array<string|int, Term>
Find all terms sharing a lemma in a language (word family).
findByStatus()  : array<string|int, mixed>
{@inheritdoc}
findForReview()  : array<string|int, mixed>
{@inheritdoc}
findIgnored()  : array<string|int, mixed>
{@inheritdoc}
findKnown()  : array<string|int, mixed>
{@inheritdoc}
findLearning()  : array<string|int, mixed>
{@inheritdoc}
findMultiWord()  : array<string|int, mixed>
{@inheritdoc}
findPaginated()  : array<string|int, mixed>
{@inheritdoc}
findRecent()  : array<string|int, mixed>
{@inheritdoc}
findRecentlyChanged()  : array<string|int, Term>
Find terms with status changed recently.
findSingleWord()  : array<string|int, Term>
Find single-word terms (word count = 1).
findWithoutTranslation()  : array<string|int, Term>
Find terms without translation.
getBasicInfo()  : array{id: int, text: string, language_id: int, status: int, has_translation: bool}|null
Get basic term info (minimal data for lists).
getForSelect()  : array<int, array{id: int, text: string, language_id: int}>
Get terms formatted for select dropdown options.
searchByText()  : array<string|int, mixed>
{@inheritdoc}
searchByTranslation()  : array<string|int, Term>
Search terms by translation.
mapToEntity()  : Term
Map a database row to a Term entity.
query()  : QueryBuilder
Get a query builder for this repository's table.

Methods

findByLemma()

Find all terms sharing a lemma in a language (word family).

public findByLemma(int $languageId, string $lemmaLc) : array<string|int, Term>
Parameters
$languageId : int

Language ID

$lemmaLc : string

Lowercase lemma

Return values
array<string|int, Term>

findByStatus()

{@inheritdoc}

public findByStatus(int $status[, int|null $languageId = null ]) : array<string|int, mixed>
Parameters
$status : int
$languageId : int|null = null
Return values
array<string|int, mixed>

findForReview()

{@inheritdoc}

public findForReview([int|null $languageId = null ][, float $scoreThreshold = 0.0 ][, int $limit = 100 ]) : array<string|int, mixed>
Parameters
$languageId : int|null = null
$scoreThreshold : float = 0.0
$limit : int = 100
Return values
array<string|int, mixed>

findIgnored()

{@inheritdoc}

public findIgnored([int|null $languageId = null ]) : array<string|int, mixed>
Parameters
$languageId : int|null = null
Return values
array<string|int, mixed>

findKnown()

{@inheritdoc}

public findKnown([int|null $languageId = null ]) : array<string|int, mixed>
Parameters
$languageId : int|null = null
Return values
array<string|int, mixed>

findLearning()

{@inheritdoc}

public findLearning([int|null $languageId = null ]) : array<string|int, mixed>
Parameters
$languageId : int|null = null
Return values
array<string|int, mixed>

findMultiWord()

{@inheritdoc}

public findMultiWord([int|null $languageId = null ]) : array<string|int, mixed>
Parameters
$languageId : int|null = null
Return values
array<string|int, mixed>

findPaginated()

{@inheritdoc}

public findPaginated([int $languageId = 0 ][, int $page = 1 ][, int $perPage = 20 ][, string $orderBy = 'WoText' ][, string $direction = 'ASC' ]) : array<string|int, mixed>
Parameters
$languageId : int = 0
$page : int = 1
$perPage : int = 20
$orderBy : string = 'WoText'
$direction : string = 'ASC'
Return values
array<string|int, mixed>

findRecent()

{@inheritdoc}

public findRecent([int|null $languageId = null ][, int $limit = 50 ]) : array<string|int, mixed>
Parameters
$languageId : int|null = null
$limit : int = 50
Return values
array<string|int, mixed>

findRecentlyChanged()

Find terms with status changed recently.

public findRecentlyChanged([int|null $languageId = null ][, int $days = 7 ][, int $limit = 50 ]) : array<string|int, Term>
Parameters
$languageId : int|null = null

Language ID (null for all)

$days : int = 7

Number of days to look back

$limit : int = 50

Maximum results

Return values
array<string|int, Term>

findSingleWord()

Find single-word terms (word count = 1).

public findSingleWord([int|null $languageId = null ]) : array<string|int, Term>
Parameters
$languageId : int|null = null

Language ID (null for all)

Return values
array<string|int, Term>

findWithoutTranslation()

Find terms without translation.

public findWithoutTranslation([int|null $languageId = null ]) : array<string|int, Term>
Parameters
$languageId : int|null = null

Language ID (null for all)

Return values
array<string|int, Term>

getBasicInfo()

Get basic term info (minimal data for lists).

public getBasicInfo(int $termId) : array{id: int, text: string, language_id: int, status: int, has_translation: bool}|null
Parameters
$termId : int

Term ID

Return values
array{id: int, text: string, language_id: int, status: int, has_translation: bool}|null

getForSelect()

Get terms formatted for select dropdown options.

public getForSelect([int $languageId = 0 ][, int $maxNameLength = 40 ]) : array<int, array{id: int, text: string, language_id: int}>
Parameters
$languageId : int = 0

Language ID (0 for all languages)

$maxNameLength : int = 40

Maximum text length before truncation

Return values
array<int, array{id: int, text: string, language_id: int}>

searchByText()

{@inheritdoc}

public searchByText(string $query[, int|null $languageId = null ][, int $limit = 50 ]) : array<string|int, mixed>
Parameters
$query : string
$languageId : int|null = null
$limit : int = 50
Return values
array<string|int, mixed>

searchByTranslation()

Search terms by translation.

public searchByTranslation(string $query[, int|null $languageId = null ][, int $limit = 50 ]) : array<string|int, Term>
Parameters
$query : string

Search query

$languageId : int|null = null

Language ID (null for all)

$limit : int = 50

Maximum results

Return values
array<string|int, Term>

mapToEntity()

Map a database row to a Term entity.

protected abstract mapToEntity(array<string, mixed> $row) : Term
Parameters
$row : array<string, mixed>

Database row

Return values
Term

        
On this page

Search results