Added basic search system in info providers

This commit is contained in:
Jan Böhmer 2023-07-09 17:55:41 +02:00
parent e0301f096f
commit 93a170a893
6 changed files with 222 additions and 2 deletions

View file

@ -23,8 +23,11 @@ declare(strict_types=1);
namespace App\Controller; namespace App\Controller;
use App\Form\InfoProviderSystem\PartSearchType;
use App\Services\InfoProviderSystem\PartInfoRetriever;
use App\Services\InfoProviderSystem\ProviderRegistry; use App\Services\InfoProviderSystem\ProviderRegistry;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route; use Symfony\Component\Routing\Annotation\Route;
@ -42,8 +45,23 @@ class InfoProviderController extends AbstractController
} }
#[Route('/search', name: 'info_providers_search')] #[Route('/search', name: 'info_providers_search')]
public function search(): Response public function search(Request $request, PartInfoRetriever $infoRetriever): Response
{ {
$form = $this->createForm(PartSearchType::class);
$form->handleRequest($request);
$results = null;
if ($form->isSubmitted() && $form->isValid()) {
$keyword = $form->get('keyword')->getData();
$providers = $form->get('providers')->getData();
$results = $infoRetriever->searchByKeyword(keyword: $keyword, providers: $providers);
}
return $this->render('info_providers/search/part_search.html.twig', [
'form' => $form,
'results' => $results,
]);
} }
} }

View file

@ -0,0 +1,39 @@
<?php
/*
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace App\Form\InfoProviderSystem;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\SearchType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
use Symfony\Component\Form\FormBuilderInterface;
class PartSearchType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('keyword', SearchType::class);
$builder->add('providers', ProviderSelectType::class);
$builder->add('submit', SubmitType::class);
}
}

View file

@ -0,0 +1,57 @@
<?php
/*
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace App\Form\InfoProviderSystem;
use App\Services\InfoProviderSystem\ProviderRegistry;
use App\Services\InfoProviderSystem\Providers\InfoProviderInterface;
use Hoa\Compiler\Llk\Rule\Choice;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\ChoiceList\ChoiceList;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\OptionsResolver\OptionsResolver;
class ProviderSelectType extends AbstractType
{
public function __construct(private readonly ProviderRegistry $providerRegistry)
{
}
public function getParent(): string
{
return ChoiceType::class;
}
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
'choices' => $this->providerRegistry->getActiveProviders(),
'choice_label' => ChoiceList::label($this, fn (?InfoProviderInterface $choice) => $choice?->getProviderInfo()['name']),
'choice_value' => ChoiceList::value($this, fn(?InfoProviderInterface $choice) => $choice?->getProviderKey()),
'multiple' => true,
]);
}
}

View file

@ -0,0 +1,60 @@
<?php
/*
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace App\Services\InfoProviderSystem;
use App\Services\InfoProviderSystem\DTOs\SearchResultDTO;
use App\Services\InfoProviderSystem\Providers\InfoProviderInterface;
class PartInfoRetriever
{
public function __construct(private readonly ProviderRegistry $provider_registry)
{
}
/**
* Search for a keyword in the given providers
* @param string[]|InfoProviderInterface[] $providers A list of providers to search in, either as provider keys or as provider instances
* @param string $keyword The keyword to search for
* @return SearchResultDTO[] The search results
*/
public function searchByKeyword(string $keyword, array $providers): array
{
$results = [];
foreach ($providers as $provider) {
if (is_string($provider)) {
$provider = $this->provider_registry->getProviderByKey($provider);
}
if (!$provider instanceof InfoProviderInterface) {
throw new \InvalidArgumentException("The provider must be either a provider key or a provider instance!");
}
/** @noinspection SlowArrayOperationsInLoopInspection */
$results = array_merge($results, $provider->searchByKeyword($keyword));
}
return $results;
}
}

View file

@ -43,7 +43,7 @@ class TestProvider implements InfoProviderInterface
public function isActive(): bool public function isActive(): bool
{ {
return false; return true;
} }
public function searchByKeyword(string $keyword): array public function searchByKeyword(string $keyword): array

View file

@ -0,0 +1,46 @@
{% extends "main_card.html.twig" %}
{% import "info_providers/providers.macro.html.twig" as providers_macro %}
{% import "helper.twig" as helper %}
{% block title %}{% trans %}info_providers.providers_list.title{% endtrans %}{% endblock %}
{% block card_title %}
<i class="fas fa-cloud-arrow-down"></i> {% trans %}info_providers.providers_list.title{% endtrans %}
{% endblock %}
{% block card_content %}
{{ form(form) }}
{% if results is not null %}
<table class="table table-striped table-hover">
<thead>
<tr>
<th></th>
<th>Name</th>
<th>Description</th>
<th>Manufactuer</th>
<th>MPN</th>
<th>Status</th>
<th>Provider</th>
</tr>
</thead>
<tbody>
{% for result in results %}
<tr>
<td><img style="width: 40px;" src="{{ result.preview_image_url }}"></td>
<td>{{ result.name }}</td>
<td>{{ result.description }}</td>
<td>{{ result.manufacturer ?? '' }}</td>
<td>{{ result.mpn ?? '' }}</td>
<td>{{ helper.m_status_to_badge(result.manufacturing_status) }}</td>
<td><a href="{{ result.provider_url ?? '#' }}">{{ result.provider_key }}: {{ result.provider_id }}</a></td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% endblock %}