Documentation

WordListFilterBuilder

Builds SQL filter conditions for word list queries.

Handles language, status, query text, and tag filter construction for the word list display and export features.

Tags
category

Lwt

author

HugoFara hugo.farajallah@protonmail.com

license

Unlicense http://unlicense.org/

link
https://hugofara.github.io/lwt/developer/api
since
3.0.0

Table of Contents

Methods

buildLangCondition()  : string
Build query condition for language filter.
buildQueryCondition()  : string
Build query condition for search query with prepared statement parameters.
buildStatusCondition()  : string
Build query condition for status filter.
buildTagCondition()  : string
Build tag filter condition.
validateRegexPattern()  : bool
Validate a regex pattern.

Methods

buildLangCondition()

Build query condition for language filter.

public buildLangCondition(string $langId[, array<string|int, mixed>|null &$params = null ]) : string
Parameters
$langId : string

Language ID

$params : array<string|int, mixed>|null = null

Optional: Reference to params array for prepared statements

Return values
string

SQL condition

buildQueryCondition()

Build query condition for search query with prepared statement parameters.

public buildQueryCondition(string $query, string $queryMode, string $regexMode[, array<string|int, mixed>|null &$params = null ]) : string

NOTE: When upgrading calling code, pass a $params array by reference to get parameterized queries. For backward compatibility, if $params is null, this returns old-style SQL with embedded values (using mysqli_real_escape_string).

Parameters
$query : string

Search query

$queryMode : string

Query mode (term, rom, transl, etc.)

$regexMode : string

Regex mode ('' or 'r')

$params : array<string|int, mixed>|null = null

Optional: Reference to params array for prepared statements

Return values
string

SQL condition (with ? placeholders if $params provided, or embedded values if not)

buildStatusCondition()

Build query condition for status filter.

public buildStatusCondition(string $status) : string
Parameters
$status : string

Status code

Return values
string

SQL condition

buildTagCondition()

Build tag filter condition.

public buildTagCondition(string $tag1, string $tag2, string $tag12[, array<string|int, mixed>|null &$params = null ]) : string
Parameters
$tag1 : string

First tag ID (must be numeric or empty)

$tag2 : string

Second tag ID (must be numeric or empty)

$tag12 : string

Tag logic (0=OR, 1=AND)

$params : array<string|int, mixed>|null = null

Optional: Reference to params array for prepared statements

Return values
string

SQL HAVING clause

validateRegexPattern()

Validate a regex pattern.

public validateRegexPattern(string $pattern) : bool
Parameters
$pattern : string

The regex pattern to validate

Return values
bool

True if valid, false otherwise


        
On this page

Search results