Skip to main content

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.

​
Requirements

​
Required PHP extensions

The following extensions must be enabled in your PHP installation:
ExtensionPurpose
fileinfoFile type detection
jsonJSON encoding and decoding
mbstringMultibyte string handling
xmlreaderStreaming XML parsing
simplexmlSimpleXML parsing
libxmlUnderlying XML support
iconvCharacter encoding conversion
These extensions ship with most PHP distributions and are typically enabled by default.

​
Install

1

Require the package

Add FiQueLa to your project with Composer:
composer require 1biot/fiquela
2

Verify the installation

Confirm the package is present in your vendor/ directory and that autoloading is configured:
composer show 1biot/fiquela
3

Include the autoloader

Require Composer’s autoloader at the entry point of your script or application:
require __DIR__ . '/vendor/autoload.php';

​
Optional format dependencies

Several formats require additional Composer packages. Install only the ones you need:
PackageFormats enabled
halaxa/json-machineJSON streaming (JsonStream, NDJson)
symfony/yamlYAML
nette/neonNEON
openspout/openspoutXLSX and ODS
As of FiQueLa 3.0, CSV is read and written with native PHP fgetcsv / fputcsv — the previous league/csv dependency has been dropped. halaxa/json-machine, symfony/yaml, nette/neon, and openspout/openspout are bundled as required dependencies in composer.json, so they are installed automatically with composer require 1biot/fiquela. The table above reflects which package enables which format.

​
Optional dev dependency

For debugging and benchmarking queries during development, install tracy/tracy: 
composer require --dev tracy/tracy
This enables the Query\Debugger helper, which provides inspectQuery, inspectSql, benchmarkQuery, and explain output.
tracy/tracy is only needed in development environments. Do not install it in production unless you have a specific use case.