Documentation Index
Fetch the complete documentation index at: https://docs.fiquela.io/llms.txt
Use this file to discover all available pages before exploring further.
Utility functions cover a wide range of operations: array manipulation, type casting, date arithmetic, conditional logic, and more.
Array
Type
Date/time
Conditional
Other
Array functions
| Fluent API method | FQL function | Description |
|---|
arrayCombine($keys, $values) | ARRAY_COMBINE(keys, values) | Combine a keys array and a values array into an associative array |
arrayFilter($field) | ARRAY_FILTER(field) | Remove empty/null entries from an array |
arraySearch($field, $needle) | ARRAY_SEARCH(field, needle) | Return the key of the first matching value |
arrayMerge($field1, $field2) | ARRAY_MERGE(field1, field2) | Merge two arrays into one |
colSplit($field, $format, $key) | COL_SPLIT(field, format, key) | Expand an array field into separate columns |
$query
->arrayCombine('fieldWithKeys', 'fieldWithValues')->as('combined')
->arrayFilter('tags')->as('cleanTags')
->arraySearch('categories', 'electronics')->as('catKey')
->arrayMerge('list1', 'list2')->as('merged')
->colSplit('items', 'item_%index', 'id');
Type functions
| Fluent API method | FQL function | Description |
|---|
cast($field, Type $type) | CAST(field AS type) | Cast a value to the specified type |
coalesce(...$fields) | COALESCE(...) | Return the first non-null value |
coalesceNotEmpty(...$fields) | COALESCE_NE(...) | Return the first non-empty value |
\FQL\Enum\Type): INT, DOUBLE, STRING, BOOLEAN, ARRAY, OBJECT.use FQL\Enum\Type;
$query
->cast('price', Type::FLOAT)->as('priceFloat')
->coalesce('nickname', 'username', 'email')->as('displayName')
->coalesceNotEmpty('shortDesc', 'description')->as('desc');
Date and time functions
| Fluent API method | FQL function | Description |
|---|
formatDate($field, $format) | DATE_FORMAT(field, format) | Format a date value as a string |
fromUnixTime($field, $format) | FROM_UNIXTIME(field, format) | Convert a Unix timestamp to a formatted date |
strToDate($field, $format) | STR_TO_DATE(field, format) | Parse a date string using a format mask |
dateDiff($field1, $field2) | DATE_DIFF(field1, field2) | Number of days between two dates |
dateAdd($field, $interval) | DATE_ADD(field, interval) | Add a date/time interval to a date |
dateSub($field, $interval) | DATE_SUB(field, interval) | Subtract a date/time interval from a date |
year($field) | YEAR(field) | Extract the year from a date |
month($field) | MONTH(field) | Extract the month from a date |
day($field) | DAY(field) | Extract the day of the month from a date |
now(bool $numeric) | NOW() | Current datetime as Y-m-d H:i:s string (or YmdHis integer when $numeric = true) |
currentTimestamp() | CURRENT_TIMESTAMP() | Current Unix timestamp (integer) |
currentDate() | CURDATE() | Current date |
currentTime() | CURTIME() | Current time |
$query
->formatDate('createdAt', 'Y-m-d')->as('date')
->fromUnixTime('publishedAt', 'Y-m-d H:i:s')->as('published')
->strToDate('dateString', '%Y-%m-%d')->as('parsed')
->dateDiff('endDate', 'startDate')->as('daysDiff')
->dateAdd('startDate', '+1 month')->as('nextMonth')
->dateSub('endDate', '+7 days')->as('weekBefore')
->year('createdAt')->as('yr')
->month('createdAt')->as('mo')
->day('createdAt')->as('dy')
->now()->as('currentDateTime')
->currentTimestamp()->as('ts')
->currentDate()->as('today')
->currentTime()->as('nowTime');
Conditional functions
| Fluent API method | FQL function | Description |
|---|
if($condition, $true, $false) | IF(condition, trueVal, falseVal) | Return one of two values based on a condition |
ifNull($field, $default) | IFNULL(field, default) | Return $default when the field is null |
isNull($field) | ISNULL(field) | Return true if the field is null |
case()->whenCase()->elseCase()->endCase() | CASE WHEN ... THEN ... ELSE ... END | Multi-branch conditional expression |
$query
->if('`stock` > 0', 'in stock', 'out of stock')->as('availability')
->ifNull('nickname', 'Anonymous')->as('displayName')
->isNull('deletedAt')->as('isActive')
->case()
->whenCase('stock > 100', 'plentiful')
->whenCase('stock > 10', 'low')
->whenCase('stock > 0', 'critical')
->elseCase('out of stock')
->endCase()->as('stockLabel');
CASE WHEN syntax
The CASE expression evaluates conditions in order and returns the value of the first matching WHEN branch. The optional ELSE branch provides a fallback for when no condition matches; if omitted and nothing matches, the result is null.Prior to FiQueLa 3.0.1, IF(...) returned null on every row when the condition referenced a backtick-chained path such as IF(`info`.`invoiceNumber` IS ARRAY, '', info.invoiceNumber). Upgrade to 3.0.1 or later to use backtick-escaped paths inside IF conditions.
Other utility functions
| Fluent API method | FQL function | Description |
|---|
length($field) | LENGTH(field) | Length of a string, count of an array, or 0 for null |
randomBytes($length) | RANDOM_BYTES(length) | Cryptographically secure random bytes |
uuid() | UUID() | Generate a random UUID v4 |
$query
->length('description')->as('descLength')
->length('tags')->as('tagCount')
->randomBytes(16)->as('nonce')
->uuid()->as('rowId');
LENGTH is context-aware: it returns the character count for strings, the element count for arrays, and 0 for null.