mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-21 01:25:55 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

added support for configuring columns in part table which are enabled by default as well as their order.

Browse source
This commit is contained in:
misaz 2023-10-04 21:14:57 +02:00
parent 39009a71d5
commit 9d54001f89
5 changed files with 419 additions and 296 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.docker/symfony.conf
View file

@ -35,7 +35,7 @@
PassEnv DEMO_MODE NO_URL_REWRITE_AVAILABLE FIXER_API_KEY BANNER PassEnv DEMO_MODE NO_URL_REWRITE_AVAILABLE FIXER_API_KEY BANNER
# In old version the SAML sp private key env, was wrongly named SAMLP_SP_PRIVATE_KEY, keep it for backward compatibility # In old version the SAML sp private key env, was wrongly named SAMLP_SP_PRIVATE_KEY, keep it for backward compatibility
PassEnv SAML_ENABLED SAML_ROLE_MAPPING SAML_UPDATE_GROUP_ON_LOGIN SAML_IDP_ENTITY_ID SAML_IDP_SINGLE_SIGN_ON_SERVICE SAML_IDP_SINGLE_LOGOUT_SERVICE SAML_IDP_X509_CERT SAML_SP_ENTITY_ID SAML_SP_X509_CERT SAML_SP_PRIVATE_KEY SAMLP_SP_PRIVATE_KEY PassEnv SAML_ENABLED SAML_ROLE_MAPPING SAML_UPDATE_GROUP_ON_LOGIN SAML_IDP_ENTITY_ID SAML_IDP_SINGLE_SIGN_ON_SERVICE SAML_IDP_SINGLE_LOGOUT_SERVICE SAML_IDP_X509_CERT SAML_SP_ENTITY_ID SAML_SP_X509_CERT SAML_SP_PRIVATE_KEY SAMLP_SP_PRIVATE_KEY
PassEnv TABLE_DEFAULT_PAGE_SIZE PassEnv TABLE_DEFAULT_PAGE_SIZE TABLE_PART_DEFAULT_COLUMNS
PassEnv PROVIDER_DIGIKEY_CLIENT_ID PROVIDER_DIGIKEY_SECRET PROVIDER_DIGIKEY_CURRENCY PROVIDER_DIGIKEY_LANGUAGE PROVIDER_DIGIKEY_COUNTRY PassEnv PROVIDER_DIGIKEY_CLIENT_ID PROVIDER_DIGIKEY_SECRET PROVIDER_DIGIKEY_CURRENCY PROVIDER_DIGIKEY_LANGUAGE PROVIDER_DIGIKEY_COUNTRY
PassEnv PROVIDER_ELEMENT14_KEY PROVIDER_ELEMENT14_STORE_ID PassEnv PROVIDER_ELEMENT14_KEY PROVIDER_ELEMENT14_STORE_ID

3
config/parameters.yaml
View file

@ -53,7 +53,8 @@ parameters:
###################################################################################################################### ######################################################################################################################
# Table settings # Table settings
###################################################################################################################### ######################################################################################################################
partdb.table.default_page_size: '%env(int:TABLE_DEFAULT_PAGE_SIZE)%' # The default number of entries shown per page in tables partdb.table.default_page_size: '%env(int:TABLE_DEFAULT_PAGE_SIZE)%' # The default number of entries shown per page in tables
partdb.table.default_part_columns: '%env(trim:string:TABLE_PART_DEFAULT_COLUMNS)%' # The default columns in part tables and their order
###################################################################################################################### ######################################################################################################################
# Sidebar # Sidebar

6
config/services.yaml
View file

@ -211,6 +211,12 @@ services:
arguments: arguments:
$saml_enabled: '%partdb.saml.enabled%' $saml_enabled: '%partdb.saml.enabled%'
####################################################################################################################
# Table settings
####################################################################################################################
App\DataTables\PartsDataTable:
arguments:
$default_part_columns: '%partdb.table.default_part_columns%'
#################################################################################################################### ####################################################################################################################
# Label system # Label system

1
docs/configuration.md
View file

@ -46,6 +46,7 @@ The following configuration options can only be changed by the server administra
### Table related settings ### Table related settings
* `TABLE_DEFAULT_PAGE_SIZE`: The default page size for tables. This is the number of rows which are shown per page. Set to `-1` to disable pagination and show all rows at once. * `TABLE_DEFAULT_PAGE_SIZE`: The default page size for tables. This is the number of rows which are shown per page. Set to `-1` to disable pagination and show all rows at once.
* `TABLE_PART_DEFAULT_COLUMNS`: The default columns in part tables loading table for first time. Also specify default order of the columns. Specify as comma separated string. Available columns are: `name`, `id`, `ipn`, `description`, `category`, `footprint`, `manufacturer`, `storelocation`, `amount`, `minamount`, `partUnit`, `addedDate`, `lastModified`, `needs_review`, `favorite`, `manufacturing_status`, `manufacturer_product_number`, `mass`, `tags`, `attachments`, `edit`.
### History/Eventlog related settings ### History/Eventlog related settings
The following options are used to configure, which (and how much) data is written to the system log: The following options are used to configure, which (and how much) data is written to the system log:

703
src/DataTables/PartsDataTable.php
View file

@ -33,6 +33,7 @@ use Doctrine\ORM\Query;
use Doctrine\ORM\Tools\Pagination\Paginator; use Doctrine\ORM\Tools\Pagination\Paginator;
use Omines\DataTablesBundle\Adapter\Doctrine\Event\ORMAdapterQueryEvent; use Omines\DataTablesBundle\Adapter\Doctrine\Event\ORMAdapterQueryEvent;
use Omines\DataTablesBundle\Adapter\Doctrine\ORMAdapterEvents; use Omines\DataTablesBundle\Adapter\Doctrine\ORMAdapterEvents;
use Psr\Log\LoggerInterface;
use Symfony\Bundle\SecurityBundle\Security; use Symfony\Bundle\SecurityBundle\Security;
use App\Entity\Parts\Storelocation; use App\Entity\Parts\Storelocation;
use App\DataTables\Column\EntityColumn; use App\DataTables\Column\EntityColumn;
@ -62,129 +63,161 @@ use Symfony\Contracts\Translation\TranslatorInterface;
final class PartsDataTable implements DataTableTypeInterface final class PartsDataTable implements DataTableTypeInterface
{ {
public function __construct(private readonly EntityURLGenerator $urlGenerator, private readonly TranslatorInterface $translator, private readonly AmountFormatter $amountFormatter, private readonly PartDataTableHelper $partDataTableHelper, private readonly Security $security) public function __construct(private readonly EntityURLGenerator $urlGenerator, private readonly TranslatorInterface $translator, private readonly AmountFormatter $amountFormatter, private readonly PartDataTableHelper $partDataTableHelper, private readonly Security $security, private readonly string $default_part_columns, protected LoggerInterface $logger)
{ {
} }
public function configureOptions(OptionsResolver $optionsResolver): void public function configureOptions(OptionsResolver $optionsResolver): void
{ {
$optionsResolver->setDefaults([ $optionsResolver->setDefaults([
'filter' => null, 'filter' => null,
'search' => null 'search' => null
]); ]);
$optionsResolver->setAllowedTypes('filter', [PartFilter::class, 'null']); $optionsResolver->setAllowedTypes('filter', [PartFilter::class, 'null']);
$optionsResolver->setAllowedTypes('search', [PartSearchFilter::class, 'null']); $optionsResolver->setAllowedTypes('search', [PartSearchFilter::class, 'null']);
} }
public function configure(DataTable $dataTable, array $options): void public function configure(DataTable $dataTable, array $options): void
{ {
$resolver = new OptionsResolver(); $resolver = new OptionsResolver();
$this->configureOptions($resolver); $this->configureOptions($resolver);
$options = $resolver->resolve($options); $options = $resolver->resolve($options);
$dataTable $dataTable
//Color the table rows depending on the review and favorite status //Color the table rows depending on the review and favorite status
->add('dont_matter', RowClassColumn::class, [ ->add('dont_matter', RowClassColumn::class, [
'render' => function ($value, Part $context): string { 'render' => function ($value, Part $context): string {
if ($context->isNeedsReview()) { if ($context->isNeedsReview()) {
return 'table-secondary'; return 'table-secondary';
} }
if ($context->isFavorite()) { if ($context->isFavorite()) {
return 'table-info'; return 'table-info';
} }
return ''; //Default coloring otherwise return ''; //Default coloring otherwise
}, },
]) ])
->add('select', SelectColumn::class) ->add('select', SelectColumn::class)
->add('picture', TextColumn::class, [ ->add('picture', TextColumn::class, [
'label' => '', 'label' => '',
'className' => 'no-colvis', 'className' => 'no-colvis',
'render' => fn($value, Part $context) => $this->partDataTableHelper->renderPicture($context), 'render' => fn($value, Part $context) => $this->partDataTableHelper->renderPicture($context),
]) ]);
->add('name', TextColumn::class, [
'label' => $this->translator->trans('part.table.name'),
'render' => fn($value, Part $context) => $this->partDataTableHelper->renderName($context),
])
->add('id', TextColumn::class, [
'label' => $this->translator->trans('part.table.id'),
'visible' => false,
])
->add('ipn', TextColumn::class, [
'label' => $this->translator->trans('part.table.ipn'),
'visible' => false,
])
->add('description', MarkdownColumn::class, [
'label' => $this->translator->trans('part.table.description'),
]);
if ($this->security->isGranted('@categories.read')) {
$dataTable->add('category', EntityColumn::class, [
'label' => $this->translator->trans('part.table.category'),
'property' => 'category',
]);
}
if ($this->security->isGranted('@footprints.read')) { // internal array of $dataTable->add(...) parameters. Parameters will be later passed to the method
$dataTable->add('footprint', EntityColumn::class, [ // after sorting columns according to TABLE_PART_DEFAULT_COLUMNS option.
'property' => 'footprint', $columns = [];
'label' => $this->translator->trans('part.table.footprint'),
]);
}
if ($this->security->isGranted('@manufacturers.read')) {
$dataTable->add('manufacturer', EntityColumn::class, [
'property' => 'manufacturer',
'label' => $this->translator->trans('part.table.manufacturer'),
]);
}
if ($this->security->isGranted('@storelocations.read')) {
$dataTable->add('storelocation', TextColumn::class, [
'label' => $this->translator->trans('part.table.storeLocations'),
'orderField' => 'storelocations.name',
'render' => function ($value, Part $context): string {
$tmp = [];
foreach ($context->getPartLots() as $lot) {
//Ignore lots without storelocation
if (!$lot->getStorageLocation() instanceof Storelocation) {
continue;
}
$tmp[] = sprintf(
'<a href="%s" title="%s">%s</a>',
$this->urlGenerator->listPartsURL($lot->getStorageLocation()),
htmlspecialchars($lot->getStorageLocation()->getFullPath()),
htmlspecialchars($lot->getStorageLocation()->getName())
);
}
return implode('<br>', $tmp); $columns['name'] = [
}, 'name', TextColumn::class,
]); [
} 'label' => $this->translator->trans('part.table.name'),
'render' => fn($value, Part $context) => $this->partDataTableHelper->renderName($context),
]
];
$columns['id'] = [
'id', TextColumn::class,
[
'label' => $this->translator->trans('part.table.id'),
'visible' => false,
]
];
$columns['ipn'] = [
'ipn', TextColumn::class,
[
'label' => $this->translator->trans('part.table.ipn'),
'visible' => false,
]
];
$columns['description'] = [
'description', MarkdownColumn::class,
[
'label' => $this->translator->trans('part.table.description'),
]
];
$dataTable->add('amount', TextColumn::class, [ if ($this->security->isGranted('@categories.read')) {
'label' => $this->translator->trans('part.table.amount'), $columns['category'] = [
'render' => function ($value, Part $context) { 'category', EntityColumn::class,
$amount = $context->getAmountSum(); [
$expiredAmount = $context->getExpiredAmountSum(); 'label' => $this->translator->trans('part.table.category'),
'property' => 'category',
]
];
}
$ret = ''; if ($this->security->isGranted('@footprints.read')) {
$columns['footprint'] = [
'footprint', EntityColumn::class,
[
'property' => 'footprint',
'label' => $this->translator->trans('part.table.footprint'),
]
];
}
if ($this->security->isGranted('@manufacturers.read')) {
$columns['manufacturer'] = [
'manufacturer', EntityColumn::class,
[
'property' => 'manufacturer',
'label' => $this->translator->trans('part.table.manufacturer'),
]
];
}
if ($this->security->isGranted('@storelocations.read')) {
$columns['storelocation'] = [
'storelocation', TextColumn::class,
[
'label' => $this->translator->trans('part.table.storeLocations'),
'orderField' => 'storelocations.name',
'render' => function ($value, Part $context): string {
$tmp = [];
foreach ($context->getPartLots() as $lot) {
//Ignore lots without storelocation
if (!$lot->getStorageLocation() instanceof Storelocation) {
continue;
}
$tmp[] = sprintf(
'<a href="%s" title="%s">%s</a>',
$this->urlGenerator->listPartsURL($lot->getStorageLocation()),
htmlspecialchars($lot->getStorageLocation()->getFullPath()),
htmlspecialchars($lot->getStorageLocation()->getName())
);
}
if ($context->isAmountUnknown()) { return implode('<br>', $tmp);
//When all amounts are unknown, we show a question mark },
if ($amount === 0.0) { ]
$ret .= sprintf('<b class="text-primary" title="%s">?</b>', ];
$this->translator->trans('part_lots.instock_unknown')); }
} else { //Otherwise mark it with greater equal and the (known) amount
$ret .= sprintf('<b class="text-primary" title="%s">≥</b>', $columns['amount'] = [
$this->translator->trans('part_lots.instock_unknown') 'amount', TextColumn::class,
); [
$ret .= htmlspecialchars($this->amountFormatter->format($amount, $context->getPartUnit())); 'label' => $this->translator->trans('part.table.amount'),
} 'render' => function ($value, Part $context) {
} else { $amount = $context->getAmountSum();
$ret .= htmlspecialchars($this->amountFormatter->format($amount, $context->getPartUnit())); $expiredAmount = $context->getExpiredAmountSum();
}
$ret = '';
if ($context->isAmountUnknown()) {
//When all amounts are unknown, we show a question mark
if ($amount === 0.0) {
$ret .= sprintf('<b class="text-primary" title="%s">?</b>',
$this->translator->trans('part_lots.instock_unknown'));
} else { //Otherwise mark it with greater equal and the (known) amount
$ret .= sprintf('<b class="text-primary" title="%s">≥</b>',
$this->translator->trans('part_lots.instock_unknown')
);
$ret .= htmlspecialchars($this->amountFormatter->format($amount, $context->getPartUnit()));
}
} else {
$ret .= htmlspecialchars($this->amountFormatter->format($amount, $context->getPartUnit()));
}
//If we have expired lots, we show them in parentheses behind //If we have expired lots, we show them in parentheses behind
if ($expiredAmount > 0) { if ($expiredAmount > 0) {
@ -200,214 +233,296 @@ final class PartsDataTable implements DataTableTypeInterface
$ret); $ret);
} }
return $ret; return $ret;
}, },
'orderField' => 'amountSum' 'orderField' => 'amountSum'
]) ]
->add('minamount', TextColumn::class, [ ];
'label' => $this->translator->trans('part.table.minamount'), $columns['minamount'] = [
'visible' => false, 'minamount', TextColumn::class,
'render' => fn($value, Part $context): string => htmlspecialchars($this->amountFormatter->format($value, $context->getPartUnit())), [
]); 'label' => $this->translator->trans('part.table.minamount'),
'visible' => false,
'render' => fn($value, Part $context): string => htmlspecialchars($this->amountFormatter->format($value, $context->getPartUnit())),
]
];
if ($this->security->isGranted('@footprints.read')) { if ($this->security->isGranted('@footprints.read')) {
$dataTable->add('partUnit', TextColumn::class, [ $columns['partUnit'] = [
'field' => 'partUnit.name', 'partUnit', TextColumn::class,
'label' => $this->translator->trans('part.table.partUnit'), [
'visible' => false, 'field' => 'partUnit.name',
]); 'label' => $this->translator->trans('part.table.partUnit'),
} 'visible' => false,
]
];
}
$dataTable->add('addedDate', LocaleDateTimeColumn::class, [ $columns['addedDate'] = [
'label' => $this->translator->trans('part.table.addedDate'), 'addedDate', LocaleDateTimeColumn::class,
'visible' => false, [
]) 'label' => $this->translator->trans('part.table.addedDate'),
->add('lastModified', LocaleDateTimeColumn::class, [ 'visible' => false,
'label' => $this->translator->trans('part.table.lastModified'), ]
'visible' => false, ];
]) $columns['lastModified'] = [
->add('needs_review', PrettyBoolColumn::class, [ 'lastModified', LocaleDateTimeColumn::class,
'label' => $this->translator->trans('part.table.needsReview'), [
'visible' => false, 'label' => $this->translator->trans('part.table.lastModified'),
]) 'visible' => false,
->add('favorite', PrettyBoolColumn::class, [ ]
'label' => $this->translator->trans('part.table.favorite'), ];
'visible' => false, $columns['needs_review'] = [
]) 'needs_review', PrettyBoolColumn::class,
->add('manufacturing_status', EnumColumn::class, [ [
'label' => $this->translator->trans('part.table.manufacturingStatus'), 'label' => $this->translator->trans('part.table.needsReview'),
'visible' => false, 'visible' => false,
'class' => ManufacturingStatus::class, ]
'render' => function(?ManufacturingStatus $status, Part $context): string { ];
if (!$status) { $columns['favorite'] = [
return ''; 'favorite', PrettyBoolColumn::class,
} [
'label' => $this->translator->trans('part.table.favorite'),
'visible' => false,
]
];
$columns['manufacturing_status'] = [
'manufacturing_status', EnumColumn::class,
[
'label' => $this->translator->trans('part.table.manufacturingStatus'),
'visible' => false,
'class' => ManufacturingStatus::class,
'render' => function(?ManufacturingStatus $status, Part $context): string {
if (!$status) {
return '';
}
return $this->translator->trans($status->toTranslationKey()); return $this->translator->trans($status->toTranslationKey());
} , } ,
]) ]
->add('manufacturer_product_number', TextColumn::class, [ ];
'label' => $this->translator->trans('part.table.mpn'), $columns['manufacturer_product_number'] = [
'visible' => false, 'manufacturer_product_number', TextColumn::class,
]) [
->add('mass', SIUnitNumberColumn::class, [ 'label' => $this->translator->trans('part.table.mpn'),
'label' => $this->translator->trans('part.table.mass'), 'visible' => false,
'visible' => false, ]
'unit' => 'g' ];
]) $columns['mass'] = [
->add('tags', TagsColumn::class, [ 'mass', SIUnitNumberColumn::class,
'label' => $this->translator->trans('part.table.tags'), [
'visible' => false, 'label' => $this->translator->trans('part.table.mass'),
]) 'visible' => false,
->add('attachments', PartAttachmentsColumn::class, [ 'unit' => 'g'
'label' => $this->translator->trans('part.table.attachments'), ]
'visible' => false, ];
]) $columns['tags'] = [
->add('edit', IconLinkColumn::class, [ 'tags', TagsColumn::class,
'label' => $this->translator->trans('part.table.edit'), [
'visible' => false, 'label' => $this->translator->trans('part.table.tags'),
'href' => fn($value, Part $context) => $this->urlGenerator->editURL($context), 'visible' => false,
'disabled' => fn($value, Part $context) => !$this->security->isGranted('edit', $context), ]
'title' => $this->translator->trans('part.table.edit.title'), ];
]) $columns['attachments'] = [
'attachments', PartAttachmentsColumn::class,
[
'label' => $this->translator->trans('part.table.attachments'),
'visible' => false,
]
];
$columns['edit'] = [
'edit', IconLinkColumn::class,
[
'label' => $this->translator->trans('part.table.edit'),
'visible' => false,
'href' => fn($value, Part $context) => $this->urlGenerator->editURL($context),
'disabled' => fn($value, Part $context) => !$this->security->isGranted('edit', $context),
'title' => $this->translator->trans('part.table.edit.title'),
]
];
->addOrderBy('name') $visible_columns_ids = array_map("trim", explode(",", $this->default_part_columns));
->createAdapter(TwoStepORMAdapater::class, [ $allowed_configurable_columns_ids = ["name", "id", "ipn", "description", "category", "footprint", "manufacturer",
'filter_query' => $this->getFilterQuery(...), "storelocation", "amount", "minamount", "partUnit", "addedDate", "lastModified", "needs_review", "favorite",
'detail_query' => $this->getDetailQuery(...), "manufacturing_status", "manufacturer_product_number", "mass", "tags", "attachments", "edit"
'entity' => Part::class, ];
'hydrate' => Query::HYDRATE_OBJECT, $processed_columns = [];
'criteria' => [
function (QueryBuilder $builder) use ($options): void { foreach ($visible_columns_ids as $col_id) {
$this->buildCriteria($builder, $options); if (!in_array($col_id, $allowed_configurable_columns_ids) || !isset($columns[$col_id])) {
}, $this->logger->warning("Configuration option TABLE_PART_DEFAULT_COLUMNS specify invalid column '$col_id'. Collumn is skipped.");
new SearchCriteriaProvider(), continue;
], }
]);
} if (in_array($col_id, $processed_columns)) {
$this->logger->warning("Configuration option TABLE_PART_DEFAULT_COLUMNS specify column '$col_id' multiple time. Only first occurence is used.");
continue;
}
$options = [];
if (count($columns[$col_id]) >= 3) {
$options = $columns[$col_id][2];
}
$options["visible"] = true;
$dataTable->add($col_id, $columns[$col_id][1], $options);
$processed_columns[] = $col_id;
}
// add remaining non-visible columns
foreach ($allowed_configurable_columns_ids as $col_id) {
if (in_array($col_id, $processed_columns)) {
// column already processed
continue;
}
$options = [];
if (count($columns[$col_id]) >= 3) {
$options = $columns[$col_id][2];
}
$options["visible"] = false;
$dataTable->add($col_id, $columns[$col_id][1], $options);
$processed_columns[] = $col_id;
}
$dataTable->addOrderBy('name')
->createAdapter(TwoStepORMAdapater::class, [
'filter_query' => $this->getFilterQuery(...),
'detail_query' => $this->getDetailQuery(...),
'entity' => Part::class,
'hydrate' => Query::HYDRATE_OBJECT,
'criteria' => [
function (QueryBuilder $builder) use ($options): void {
$this->buildCriteria($builder, $options);
},
new SearchCriteriaProvider(),
],
]);
}
private function getFilterQuery(QueryBuilder $builder): void private function getFilterQuery(QueryBuilder $builder): void
{ {
/* In the filter query we only select the IDs. The fetching of the full entities is done in the detail query. /* In the filter query we only select the IDs. The fetching of the full entities is done in the detail query.
* We only need to join the entities here, so we can filter by them. * We only need to join the entities here, so we can filter by them.
* The filter conditions are added to this QB in the buildCriteria method. * The filter conditions are added to this QB in the buildCriteria method.
*/ */
$builder $builder
->select('part.id') ->select('part.id')
->addSelect('part.minamount AS HIDDEN minamount') ->addSelect('part.minamount AS HIDDEN minamount')
//Calculate amount sum using a subquery, so we can filter and sort by it //Calculate amount sum using a subquery, so we can filter and sort by it
->addSelect( ->addSelect(
'( '(
SELECT IFNULL(SUM(partLot.amount), 0.0) SELECT IFNULL(SUM(partLot.amount), 0.0)
FROM '. PartLot::class. ' partLot FROM '. PartLot::class. ' partLot
WHERE partLot.part = part.id WHERE partLot.part = part.id
AND partLot.instock_unknown = false AND partLot.instock_unknown = false
AND (partLot.expiration_date IS NULL OR partLot.expiration_date > CURRENT_DATE()) AND (partLot.expiration_date IS NULL OR partLot.expiration_date > CURRENT_DATE())
) AS HIDDEN amountSum' ) AS HIDDEN amountSum'
) )
->from(Part::class, 'part') ->from(Part::class, 'part')
->leftJoin('part.category', 'category') ->leftJoin('part.category', 'category')
->leftJoin('part.master_picture_attachment', 'master_picture_attachment') ->leftJoin('part.master_picture_attachment', 'master_picture_attachment')
->leftJoin('part.partLots', 'partLots') ->leftJoin('part.partLots', 'partLots')
->leftJoin('partLots.storage_location', 'storelocations') ->leftJoin('partLots.storage_location', 'storelocations')
->leftJoin('part.footprint', 'footprint') ->leftJoin('part.footprint', 'footprint')
->leftJoin('footprint.master_picture_attachment', 'footprint_attachment') ->leftJoin('footprint.master_picture_attachment', 'footprint_attachment')
->leftJoin('part.manufacturer', 'manufacturer') ->leftJoin('part.manufacturer', 'manufacturer')
->leftJoin('part.orderdetails', 'orderdetails') ->leftJoin('part.orderdetails', 'orderdetails')
->leftJoin('orderdetails.supplier', 'suppliers') ->leftJoin('orderdetails.supplier', 'suppliers')
->leftJoin('part.attachments', 'attachments') ->leftJoin('part.attachments', 'attachments')
->leftJoin('part.partUnit', 'partUnit') ->leftJoin('part.partUnit', 'partUnit')
->leftJoin('part.parameters', 'parameters') ->leftJoin('part.parameters', 'parameters')
//This must be the only group by, or the paginator will not work correctly //This must be the only group by, or the paginator will not work correctly
->addGroupBy('part.id') ->addGroupBy('part.id')
; ;
} }
private function getDetailQuery(QueryBuilder $builder, array $filter_results): void private function getDetailQuery(QueryBuilder $builder, array $filter_results): void
{ {
$ids = array_map(fn($row) => $row['id'], $filter_results); $ids = array_map(fn($row) => $row['id'], $filter_results);
/* /*
* In this query we take the IDs which were filtered, paginated and sorted in the filter query, and fetch the * In this query we take the IDs which were filtered, paginated and sorted in the filter query, and fetch the
* full entities. * full entities.
* We can do complex fetch joins, as we do not need to filter or sort here (which would kill the performance). * We can do complex fetch joins, as we do not need to filter or sort here (which would kill the performance).
* The only condition should be for the IDs. * The only condition should be for the IDs.
* It is important that elements are ordered the same way, as the IDs are passed, or ordering will be wrong. * It is important that elements are ordered the same way, as the IDs are passed, or ordering will be wrong.
*/ */
$builder $builder
->select('part') ->select('part')
->addSelect('category') ->addSelect('category')
->addSelect('footprint') ->addSelect('footprint')
->addSelect('manufacturer') ->addSelect('manufacturer')
->addSelect('partUnit') ->addSelect('partUnit')
->addSelect('master_picture_attachment') ->addSelect('master_picture_attachment')
->addSelect('footprint_attachment') ->addSelect('footprint_attachment')
->addSelect('partLots') ->addSelect('partLots')
->addSelect('orderdetails') ->addSelect('orderdetails')
->addSelect('attachments') ->addSelect('attachments')
->addSelect('storelocations') ->addSelect('storelocations')
//Calculate amount sum using a subquery, so we can filter and sort by it //Calculate amount sum using a subquery, so we can filter and sort by it
->addSelect( ->addSelect(
'( '(
SELECT IFNULL(SUM(partLot.amount), 0.0) SELECT IFNULL(SUM(partLot.amount), 0.0)
FROM '. PartLot::class. ' partLot FROM '. PartLot::class. ' partLot
WHERE partLot.part = part.id WHERE partLot.part = part.id
AND partLot.instock_unknown = false AND partLot.instock_unknown = false
AND (partLot.expiration_date IS NULL OR partLot.expiration_date > CURRENT_DATE()) AND (partLot.expiration_date IS NULL OR partLot.expiration_date > CURRENT_DATE())
) AS HIDDEN amountSum' ) AS HIDDEN amountSum'
) )
->from(Part::class, 'part') ->from(Part::class, 'part')
->leftJoin('part.category', 'category') ->leftJoin('part.category', 'category')
->leftJoin('part.master_picture_attachment', 'master_picture_attachment') ->leftJoin('part.master_picture_attachment', 'master_picture_attachment')
->leftJoin('part.partLots', 'partLots') ->leftJoin('part.partLots', 'partLots')
->leftJoin('partLots.storage_location', 'storelocations') ->leftJoin('partLots.storage_location', 'storelocations')
->leftJoin('part.footprint', 'footprint') ->leftJoin('part.footprint', 'footprint')
->leftJoin('footprint.master_picture_attachment', 'footprint_attachment') ->leftJoin('footprint.master_picture_attachment', 'footprint_attachment')
->leftJoin('part.manufacturer', 'manufacturer') ->leftJoin('part.manufacturer', 'manufacturer')
->leftJoin('part.orderdetails', 'orderdetails') ->leftJoin('part.orderdetails', 'orderdetails')
->leftJoin('orderdetails.supplier', 'suppliers') ->leftJoin('orderdetails.supplier', 'suppliers')
->leftJoin('part.attachments', 'attachments') ->leftJoin('part.attachments', 'attachments')
->leftJoin('part.partUnit', 'partUnit') ->leftJoin('part.partUnit', 'partUnit')
->leftJoin('part.parameters', 'parameters') ->leftJoin('part.parameters', 'parameters')
->where('part.id IN (:ids)') ->where('part.id IN (:ids)')
->setParameter('ids', $ids) ->setParameter('ids', $ids)
//We have to group by all elements, or only the first sub elements of an association is fetched! (caused issue #190) //We have to group by all elements, or only the first sub elements of an association is fetched! (caused issue #190)
->addGroupBy('part') ->addGroupBy('part')
->addGroupBy('partLots') ->addGroupBy('partLots')
->addGroupBy('category') ->addGroupBy('category')
->addGroupBy('master_picture_attachment') ->addGroupBy('master_picture_attachment')
->addGroupBy('storelocations') ->addGroupBy('storelocations')
->addGroupBy('footprint') ->addGroupBy('footprint')
->addGroupBy('footprint_attachment') ->addGroupBy('footprint_attachment')
->addGroupBy('manufacturer') ->addGroupBy('manufacturer')
->addGroupBy('orderdetails') ->addGroupBy('orderdetails')
->addGroupBy('suppliers') ->addGroupBy('suppliers')
->addGroupBy('attachments') ->addGroupBy('attachments')
->addGroupBy('partUnit') ->addGroupBy('partUnit')
->addGroupBy('parameters') ->addGroupBy('parameters')
; ;
//Get the results in the same order as the IDs were passed //Get the results in the same order as the IDs were passed
FieldHelper::addOrderByFieldParam($builder, 'part.id', 'ids'); FieldHelper::addOrderByFieldParam($builder, 'part.id', 'ids');
} }
private function buildCriteria(QueryBuilder $builder, array $options): void private function buildCriteria(QueryBuilder $builder, array $options): void
{ {
//Apply the search criterias first //Apply the search criterias first
if ($options['search'] instanceof PartSearchFilter) { if ($options['search'] instanceof PartSearchFilter) {
$search = $options['search']; $search = $options['search'];
$search->apply($builder); $search->apply($builder);
} }
//We do the most stuff here in the filter class //We do the most stuff here in the filter class
if ($options['filter'] instanceof PartFilter) { if ($options['filter'] instanceof PartFilter) {
$filter = $options['filter']; $filter = $options['filter'];
$filter->apply($builder); $filter->apply($builder);
} }
} }
} }