Skip to content

Implement advanced search #1406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
d-buchmann wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Implement advanced search #1406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
950cf6d
Implement advanced search
d-buchmann Apr 24, 2026
c21c6fe
Add tests
d-buchmann Jun 9, 2026
85998ea
Restructure query buildup
d-buchmann Jun 9, 2026
3702c07
Update tests
d-buchmann Jun 9, 2026
2a1c985
Move options from Settings to localStorage
d-buchmann Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Controller/PartListsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,8 @@ private function searchRequestToFilter(Request $request): PartSearchFilter


$filter->setRegex($request->query->getBoolean('regex'));
$filter->setExtensive($request->query->getBoolean('extensive'));
$filter->setWildcard($request->query->getBoolean('wildcard'));

return $filter;
}
Expand Down
127 changes: 100 additions & 27 deletions src/DataTables/Filters/PartSearchFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,22 @@
*/
namespace App\DataTables\Filters;
use App\DataTables\Filters\Constraints\AbstractConstraint;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\QueryBuilder;
use Doctrine\ORM\Query\Parameter;
use Doctrine\DBAL\ParameterType;

class PartSearchFilter implements FilterInterface
{

/** @var boolean Whether to use regex for searching */
protected bool $regex = false;

/** @var boolean Whether to use extensive matching for searching */
protected bool $extensive = false;

/** @var boolean Whether to use wildcards for searching */
protected bool $wildcard = false;

/** @var bool Use name field for searching */
protected bool $name = true;
Expand Down Expand Up @@ -70,11 +78,14 @@ class PartSearchFilter implements FilterInterface
/** @var bool Use Internal Part number for searching */
protected bool $ipn = true;

/** @var int array_map iteration helper variable */
protected int $it = 0;

public function __construct(
/** @var string The string to query for */
protected string $keyword
)
{
) {

}

protected function getFieldsToSearch(): array
Expand Down Expand Up @@ -124,52 +135,90 @@ protected function getFieldsToSearch(): array
public function apply(QueryBuilder $queryBuilder): void
{
$fields_to_search = $this->getFieldsToSearch();
$is_numeric = preg_match('/^\d+$/', $this->keyword) === 1;
$is_numeric = preg_match('/^\d+$/', trim($this->keyword)) === 1;

// Add exact ID match only when the keyword is numeric
$search_dbId = $is_numeric && (bool)$this->dbId;

//If we have nothing to search for, do nothing
if (($fields_to_search === [] && !$search_dbId) || $this->keyword === '') {
$tokens = [];
if ($this->extensive) {
//Transform keyword and trim excess spaces
$this->keyword = trim(str_replace('+', ' ', $this->keyword));
//Split keyword on spaces, but limit token count to 5
$tokens = explode(' ', $this->keyword, 5);
//Throw away array elements which are null or have zero length
$tokens = array_filter($tokens, fn($x) => (strlen($x) > 0));
}
else {
//Pass the whole keyword into the (empty) tokens array as is,
//retaining the original search behavior
$tokens[] = $this->keyword;
}

//If we have nothing to search for...
if (($fields_to_search === [] && !$search_dbId) || $this->keyword === '' || empty($tokens)) {
// ...enforce returning no results
$queryBuilder->add('where','1 = 0');
return;
}

$expressions = [];

if($fields_to_search !== []) {
//Convert the fields to search to a list of expressions
$expressions = array_map(function (string $field): string {
if ($this->regex) {
return sprintf("REGEXP(%s, :search_query) = TRUE", $field);
}
$expressions2 = [];
$params = [];

return sprintf("ILIKE(%s, :search_query) = TRUE", $field);
}, $fields_to_search);

//For regex, we pass the query as is, for like we add % to the start and end as wildcards
//Search in selected fields, either based on regex or on tokenized keyword
if ($fields_to_search !== []) {
//For regex, we pass the query as is
if ($this->regex) {
$queryBuilder->setParameter('search_query', $this->keyword);
//Convert the fields to search to a list of expressions
$expressions = array_merge($expressions, array_map(function (string $field): string {
return sprintf("REGEXP(%s, :search_query) = TRUE", $field);
}, $fields_to_search));
$params[] = new Parameter('search_query', $this->keyword);
} else {
//Escape % and _ characters in the keyword
$this->keyword = str_replace(['%', '_'], ['\%', '\_'], $this->keyword);
$queryBuilder->setParameter('search_query', '%' . $this->keyword . '%');
//Add a new expression and parameter set to the query for each token
foreach ($tokens as $i => $token) {
//Conditionally escape % and _ characters
if (!$this->wildcard)
$token = str_replace(['%', '_'], ['\%', '\_'], $token);

//Convert the fields to search to a list of expressions
$tmp = array_fill_keys($fields_to_search, $i);
$expressions2 = array_map(function (string $field, int $idx): string {
return sprintf("ILIKE(%s, :search_query%u) = TRUE", $field, $idx);
}, array_keys($tmp), array_values($tmp));

//Aggregate the parameters for consolidated commission at the end
//For like, we add % to the start and end as wildcards
$params[] = new Parameter('search_query' . $i, '%' . $token . '%');

//Guard condition
if (!empty($expressions2)) {
//Add Or concatenation of the expressions to our query
$queryBuilder->andWhere(
$queryBuilder->expr()->orX(...$expressions2)
);
}
}
}
}

//Use equal expression to just search for exact numeric matches
if ($search_dbId) {
$expressions[] = $queryBuilder->expr()->eq('part.id', ':id_exact');
$queryBuilder->setParameter('id_exact', (int) $this->keyword,
ParameterType::INTEGER);
}

//Guard condition
if (!empty($expressions)) {
//Add Or concatenation of the expressions to our query
$queryBuilder->andWhere(
$queryBuilder->expr()->orX(...$expressions)
);
}
//Use equal expression to search for exact numeric matches
if ($search_dbId) {
$queryBuilder->orWhere($queryBuilder->expr()->eq('part.id', ':id_exact'));
$params[] = new Parameter('id_exact', (int)$this->keyword,
ParameterType::INTEGER);
}
$queryBuilder->setParameters(
new ArrayCollection($params)
);
}

public function getKeyword(): string
Expand All @@ -194,6 +243,30 @@ public function setRegex(bool $regex): PartSearchFilter
return $this;
}

public function isExtensive(): bool
{
return $this->extensive;
}

public function setExtensive(bool $extensive): PartSearchFilter
{
$this->extensive = $extensive;
return $this;
}


public function isWildcard(): bool
{
return $this->wildcard;
}

public function setWildcard(bool $wildcard): PartSearchFilter
{
$this->wildcard = $wildcard;
return $this;
}


public function isName(): bool
{
return $this->name;
Expand Down
14 changes: 11 additions & 3 deletions templates/components/search.macro.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% macro settings_drodown(show_label_instead_icon = true) %}
{% macro settings_dropdown(show_label_instead_icon = true) %}

<div class="dropdown">
<button class="btn dropdown-toggle my-2" type="button" id="navbar-search-options" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false" data-bs-auto-close="true">
Expand Down Expand Up @@ -70,6 +70,14 @@
<input type="checkbox" class="form-check-input" id="regex" name="regex" value="1" {{ stimulus_controller('elements/localStorage_checkbox') }}>
<label for="regex" class="form-check-label justify-content-start">{% trans %}search.regexmatching{% endtrans %}</label>
</div>
<div class="form-check">
<input type="checkbox" class="form-check-input" id="extensive" name="extensive" value="0" {{ stimulus_controller('elements/localStorage_checkbox') }}>
<label for="extensive" class="form-check-label justify-content-start">{% trans %}search.extensivematching{% endtrans %}</label>
</div>
<div class="form-check">
<input type="checkbox" class="form-check-input" id="wildcard" name="wildcard" value="0" {{ stimulus_controller('elements/localStorage_checkbox') }}>
<label for="wildcard" class="form-check-label justify-content-start">{% trans %}search.permitwildcards{% endtrans %}</label>
</div>
</div>
</div>
</div>
Expand All @@ -85,7 +93,7 @@

{# Show the options left in navbar #}
{% if is_navbar %}
{{ _self.settings_drodown(is_navbar) }}
{{ _self.settings_dropdown(is_navbar) }}
{% endif %}

<div {{ stimulus_controller('elements/part_search') }}
Expand All @@ -103,7 +111,7 @@

{# And right in the standalone mode #}
{% if not is_navbar %}
{{ _self.settings_drodown(is_navbar) }}
{{ _self.settings_dropdown(is_navbar) }}
{% endif %}
</form>
{% endmacro %}
8 changes: 8 additions & 0 deletions templates/parts/lists/search_list.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@
<input type="checkbox" class="form-check-input" disabled {% if searchFilter.regex %}checked{% endif %}>
<label for="regex" class="form-check-label justify-content-start">{% trans %}search.regexmatching{% endtrans %}</label>
</div>
<div class="form-check">
<input type="checkbox" class="form-check-input" disabled {% if searchFilter.extensive %}checked{% endif %}>
<label for="extensive" class="form-check-label justify-content-start">{% trans %}search.extensivematching{% endtrans %}</label>
</div>
<div class="form-check">
<input type="checkbox" class="form-check-input" disabled {% if searchFilter.extensive %}checked{% endif %}>
<label for="wildcard" class="form-check-label justify-content-start">{% trans %}search.permitwildcards{% endtrans %}</label>
</div>
</div>
</div>
</div>
Expand Down
Loading
Loading