Part-DB.Part-DB-server/src/Repository/LabelProfileRepository.php

87 lines
3.2 KiB
PHP
Raw Normal View History

<?php
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2020 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/>.
*/
namespace App\Repository;
use App\Entity\LabelSystem\LabelOptions;
use App\Entity\LabelSystem\LabelProfile;
use App\Helpers\Trees\TreeViewNode;
use Symfony\Contracts\Translation\TranslatorInterface;
class LabelProfileRepository extends NamedDBElementRepository
{
/**
* Find the profiles that are shown in the dropdown for the given type.
* You should maybe use the cached version of this in LabelProfileDropdownHelper
* @param string $type
* @return array
*/
public function getDropdownProfiles(string $type): array
{
//TODO: Improve this, when we have a 'showInDropdown' flag for profiles.
return $this->findForSupportedElement($type);
}
/**
* Gets a tree of TreeViewNode elements. The root elements has $parent as parent.
* The treeview is generic, that means the href are null and ID values are set.
*
* @return TreeViewNode[]
*/
public function getGenericNodeTree(): array
{
$result = [];
foreach (LabelOptions::SUPPORTED_ELEMENTS as $type) {
$type_children = [];
$entities = $this->findForSupportedElement($type);
foreach ($entities as $entity) {
/** @var LabelProfile $entity */
$node = new TreeViewNode($entity->getName(), null, null);
$node->setId($entity->getID());
$type_children[] = $node;
}
if (!empty($type_children)) {
//Use default label e.g. 'part_label'. $$ marks that it will be translated in TreeViewGenerator
$tmp = new TreeViewNode('$$' . $type . '.label', null, $type_children);
$result[] = $tmp;
}
}
return $result;
}
/**
* Find all LabelProfiles that can be used with the given type
* @param string $type See LabelOptions::SUPPORTED_ELEMENTS for valid values.
* @param array $order_by The way the results should be sorted. By default ordered by
* @return array
*/
public function findForSupportedElement(string $type, array $order_by = ['name' => 'ASC']): array
{
if (!in_array($type, LabelOptions::SUPPORTED_ELEMENTS)) {
throw new \InvalidArgumentException('Invalid supported_element type given.');
}
return $this->findBy(['options.supported_element' => $type], $order_by);
}
}