Configuration

The package works with zero host configuration. The published config/query-builder.php in full:

return [
    'parameters' => [
        'filter' => 'filter',   // filter[<name>]=<value>
        'sort'   => 'sort',     // sort=-created_at,name
    ],

    'pagination' => [
        'page_name'        => 'page',
        'per_page_name'    => 'per_page',
        'default_per_page' => 20,
        'max_per_page'     => 100,
    ],

    'mode' => [
        'unknown_filter' => 'reject',
        'unknown_sort'   => 'reject',
    ],

    'limits' => [
        'max_filter_values' => 50,   // most comma/array items per filter value
        'max_value_length'  => 255,  // most characters per individual value
        'max_sorts'         => 5,    // most allow-listed sort columns applied
    ],
];

Every key

Notes

• parameters.* — the shipped defaults are the frozen wire contract; change them only if your front end changes too.
• Every key is read strictly: a key that is not set — absent, null or blank (a host’s KEY=) — takes its default, and any other invalid value throws package-toolkit’s InvalidConfigurationException naming the key. Parameter names must be strings, limits and page sizes whole numbers of at least 1.
• mode.* — exactly reject or ignore. A typo throws rather than quietly falling back to reject.
• limits.* — excess items are dropped and over-long values truncated; the request is never rejected for it. A junk limit throws instead of being cast and clamped to 1.
• There are no env variables — override values by publishing the config file.