groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-01-22 01:59:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

added docstring and comments

Browse source
This commit is contained in:
jona 2024-12-21 11:55:07 +01:00 • committed by Jan Böhmer
parent 0ba9cb8919
commit 358b66e62d
1 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/Controller/InfoProviderController.php
View file

@ -29,7 +29,6 @@ use App\Form\InfoProviderSystem\PartSearchType;
use App\Services\InfoProviderSystem\PartInfoRetriever; use App\Services\InfoProviderSystem\PartInfoRetriever;
use App\Services\InfoProviderSystem\ProviderRegistry; use App\Services\InfoProviderSystem\ProviderRegistry;
use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\QueryBuilder;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use Symfony\Bridge\Doctrine\Attribute\MapEntity; use Symfony\Bridge\Doctrine\Attribute\MapEntity;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@ -62,12 +61,26 @@ class InfoProviderController extends AbstractController
]); ]);
} }
/**
* Looks for parts in the local database that match the results from the info provider, so the user doesn't
* accidentally add a duplicate
*
* @param array $partsList Array of Arrays. Outer Array contains one entry per search result from the info Provider
* Inner array contains one entry "dto" for the dto from the info provider
* and one entry "localPart" where the local Part will be put if it exists
* Form: [["dto" => dto from provider, "localPart" => null]["dto" => dto from provider, "localPart" => null]]
* This function might modify the original array, not sure
* @return array Same format as the input array, but for parts that exist locally null will be replaced by a Part
*/
private function matchResultsToKnownParts(array $partsList): array private function matchResultsToKnownParts(array $partsList): array
{ {
//we need a manufacturer object to look for a manufacturer
$manufacturerQb = $this->em->getRepository(Manufacturer::class)->createQueryBuilder("manufacturer"); $manufacturerQb = $this->em->getRepository(Manufacturer::class)->createQueryBuilder("manufacturer");
$manufacturerQb->where($manufacturerQb->expr()->like("LOWER(manufacturer.name)", "LOWER(:manufacturer_name)")); $manufacturerQb->where($manufacturerQb->expr()->like("LOWER(manufacturer.name)", "LOWER(:manufacturer_name)"));
//check if both manufacturer and Manufacturer part namber matches. If so, it must be the same part
//use LOWER to make the search independent of case
$mpnQb = $this->em->getRepository(Part::class)->createQueryBuilder("part"); $mpnQb = $this->em->getRepository(Part::class)->createQueryBuilder("part");
$mpnQb->where($mpnQb->expr()->like("LOWER(part.manufacturer_product_number)", "LOWER(:mpn)")); $mpnQb->where($mpnQb->expr()->like("LOWER(part.manufacturer_product_number)", "LOWER(:mpn)"));
$mpnQb->andWhere($mpnQb->expr()->eq("part.manufacturer", ":manufacturer")); $mpnQb->andWhere($mpnQb->expr()->eq("part.manufacturer", ":manufacturer"));
@ -85,6 +98,7 @@ class InfoProviderController extends AbstractController
if(!$localParts) { if(!$localParts) {
continue; continue;
} }
//We only use the first matching part. If a user already has duplicate parts they will get a random one
$partsList[$index]["localPart"] = $localParts[0]; $partsList[$index]["localPart"] = $localParts[0];
} }
return $partsList; return $partsList;
@ -119,6 +133,9 @@ class InfoProviderController extends AbstractController
//Log the exception //Log the exception
$exceptionLogger->error('Error during info provider search: ' . $e->getMessage(), ['exception' => $e]); $exceptionLogger->error('Error during info provider search: ' . $e->getMessage(), ['exception' => $e]);
} }
// modify the array to an array of arrays that has a field for a matching local Part
// the advantage to use that format even when we don't look for local parts is that we
// always work with the same interface
$results = array_map(function ($result) {return ["dto" => $result,"localPart" => null];}, $results); $results = array_map(function ($result) {return ["dto" => $result,"localPart" => null];}, $results);
if(!$update_target) { if(!$update_target) {
$results = $this->matchResultsToKnownParts($results); $results = $this->matchResultsToKnownParts($results);