Laravel Query Builder Laravel Package

title: Multi value delimiter weight: 4

Sometimes values to filter for could include commas. You can change the delimiter used to split array values by setting the delimiter key in the query-builder config file.

// config/query-builder.php

return [
    'delimiter' => '|',
];

With this configuration, a request like GET /api/endpoint?filter[voltage]=12,4V|4,7V|2,1V would be parsed as:

// filters: [ 'voltage' => [ '12,4V', '4,7V', '2,1V' ]]

Note that this applies to ALL values for filters, includes and sorts.

To disable splitting entirely for all parameters, set the global delimiter to an empty string:

// config/query-builder.php

return [
    'delimiter' => '',
];

Per filter delimiter

You can override the delimiter for a specific filter using the delimiter() method. This is useful when a filter value may contain the default delimiter character.

// GET /api/endpoint?filter[voltage]=12,4V|4,7V|2,1V&filter[name]=John,Jane

QueryBuilder::for(Model::class)
    ->allowedFilters(
        AllowedFilter::exact('voltage')->delimiter('|'),
        AllowedFilter::exact('name'), // still uses the default comma delimiter
    )
    ->get();

To disable splitting entirely for a filter, set the delimiter to an empty string:

AllowedFilter::exact('external_id')->delimiter('')