Allow to show all parts of all categories in a single KiCad category by setting EDA_KICAD_CATEGORY_DEPTH to -1

This commit is contained in:
Jan Böhmer 2023-12-03 15:03:00 +01:00
parent 459ae163da
commit 6926f6b233
3 changed files with 40 additions and 14 deletions

1
.env
View file

@ -165,6 +165,7 @@ PROVIDER_MOUSER_SEARCH_WITH_SIGNUP_LANGUAGE='true'
# This value determines the depth of the category tree, that is visible inside KiCad # This value determines the depth of the category tree, that is visible inside KiCad
# 0 means that only the top level categories are visible. Set to a value > 0 to show more levels. # 0 means that only the top level categories are visible. Set to a value > 0 to show more levels.
# Set to -1, to show all parts of Part-DB inside a single category in KiCad
EDA_KICAD_CATEGORY_DEPTH=0 EDA_KICAD_CATEGORY_DEPTH=0
################################################################################### ###################################################################################

View file

@ -62,9 +62,13 @@ class KiCadApiController extends AbstractController
} }
#[Route('/parts/category/{category}.json', name: 'kicad_api_category')] #[Route('/parts/category/{category}.json', name: 'kicad_api_category')]
public function categoryParts(Category $category): Response public function categoryParts(?Category $category): Response
{ {
$this->denyAccessUnlessGranted('read', $category); if ($category) {
$this->denyAccessUnlessGranted('read', $category);
} else {
$this->denyAccessUnlessGranted('@categories.read');
}
$this->denyAccessUnlessGranted('@parts.read'); $this->denyAccessUnlessGranted('@parts.read');
return $this->json($this->kiCADHelper->getCategoryParts($category)); return $this->json($this->kiCADHelper->getCategoryParts($category));

View file

@ -28,6 +28,7 @@ use App\Entity\Parts\Part;
use App\Services\Cache\ElementCacheTagGenerator; use App\Services\Cache\ElementCacheTagGenerator;
use App\Services\Trees\NodesListBuilder; use App\Services\Trees\NodesListBuilder;
use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface; use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Contracts\Cache\ItemInterface; use Symfony\Contracts\Cache\ItemInterface;
use Symfony\Contracts\Cache\TagAwareCacheInterface; use Symfony\Contracts\Cache\TagAwareCacheInterface;
@ -43,11 +44,9 @@ class KiCadHelper
private readonly ElementCacheTagGenerator $tagGenerator, private readonly ElementCacheTagGenerator $tagGenerator,
private readonly UrlGeneratorInterface $urlGenerator, private readonly UrlGeneratorInterface $urlGenerator,
private readonly TranslatorInterface $translator, private readonly TranslatorInterface $translator,
/** The maximum level of the shown categories. 0 Means only the top level categories are shown. -1 means only a single one containing */
private readonly int $category_depth, private readonly int $category_depth,
) { ) {
if ($this->category_depth < 0) {
throw new \InvalidArgumentException('The category depth must be greater than or equal to 0');
}
} }
/** /**
@ -64,6 +63,18 @@ class KiCadHelper
$secure_class_name = $this->tagGenerator->getElementTypeCacheTag(Category::class); $secure_class_name = $this->tagGenerator->getElementTypeCacheTag(Category::class);
$item->tag($secure_class_name); $item->tag($secure_class_name);
//If the category depth is smaller than 1, create only one dummy category
if ($this->category_depth < 1) {
return [
[
'id' => '0',
'name' => 'Part-DB',
]
];
}
//Otherwise just get the categories and filter them
$categories = $this->nodesListBuilder->typeToNodesList(Category::class); $categories = $this->nodesListBuilder->typeToNodesList(Category::class);
$repo = $this->em->getRepository(Category::class); $repo = $this->em->getRepository(Category::class);
$result = []; $result = [];
@ -101,25 +112,35 @@ class KiCadHelper
/** /**
* Returns an array of objects containing all parts for the given category in the format required by KiCAD. * Returns an array of objects containing all parts for the given category in the format required by KiCAD.
* The result is cached for performance and invalidated on category or part changes. * The result is cached for performance and invalidated on category or part changes.
* @param Category $category * @param Category|null $category
* @return array * @return array
*/ */
public function getCategoryParts(Category $category): array public function getCategoryParts(?Category $category): array
{ {
return $this->kicadCache->get('kicad_category_parts_'.$category->getID() . '_' . $this->category_depth, return $this->kicadCache->get('kicad_category_parts_'.($category?->getID() ?? 0) . '_' . $this->category_depth,
function (ItemInterface $item) use ($category) { function (ItemInterface $item) use ($category) {
$item->tag([ $item->tag([
$this->tagGenerator->getElementTypeCacheTag(Category::class), $this->tagGenerator->getElementTypeCacheTag(Category::class),
$this->tagGenerator->getElementTypeCacheTag(Part::class) $this->tagGenerator->getElementTypeCacheTag(Part::class)
]); ]);
$category_repo = $this->em->getRepository(Category::class); if ($this->category_depth >= 0) {
if ($category->getLevel() >= $this->category_depth) { //Ensure that the category is set
//Get all parts for the category and its children if (!$category) {
$parts = $category_repo->getPartsRecursive($category); throw new NotFoundHttpException('Category must be set, if category_depth is greater than 1!');
}
$category_repo = $this->em->getRepository(Category::class);
if ($category->getLevel() >= $this->category_depth) {
//Get all parts for the category and its children
$parts = $category_repo->getPartsRecursive($category);
} else {
//Get only direct parts for the category (without children), as the category is not collapsed
$parts = $category_repo->getParts($category);
}
} else { } else {
//Get only direct parts for the category (without children), as the category is not collapsed //Get all parts
$parts = $category_repo->getParts($category); $parts = $this->em->getRepository(Part::class)->findAll();
} }
$result = []; $result = [];