mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-12-24 03:49:31 +00:00
Fixed coding style.
This commit is contained in:
Jan Böhmer
parent
0a94689d98
commit
f2ff77a8b3
44 changed files with 435 additions and 387 deletions
|
|
@ -1,4 +1,7 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
||||
*
|
||||
|
|
@ -34,35 +37,72 @@ use Symfony\Component\OptionsResolver\OptionsResolver;
|
|||
* Similar to ORMAdapter this class allows to access objects from the doctrine ORM.
|
||||
* Unlike the default ORMAdapter supports Fetch Joins (additional entites are fetched from DB via joins) using
|
||||
* the Doctrine Paginator.
|
||||
*
|
||||
* @author Jan Böhmer
|
||||
*/
|
||||
class FetchJoinORMAdapter extends ORMAdapter
|
||||
{
|
||||
protected $use_simple_total;
|
||||
|
||||
public function configure(array $options)
|
||||
public function configure(array $options): void
|
||||
{
|
||||
parent::configure($options);
|
||||
$this->use_simple_total = $options['simple_total_query'];
|
||||
}
|
||||
|
||||
protected function configureOptions(OptionsResolver $resolver)
|
||||
public function getResults(AdapterQuery $query): \Traversable
|
||||
{
|
||||
$builder = $query->get('qb');
|
||||
$state = $query->getState();
|
||||
|
||||
// Apply definitive view state for current 'page' of the table
|
||||
foreach ($state->getOrderBy() as [$column, $direction]) {
|
||||
/** @var AbstractColumn $column */
|
||||
if ($column->isOrderable()) {
|
||||
$builder->addOrderBy($column->getOrderField(), $direction);
|
||||
}
|
||||
}
|
||||
if ($state->getLength() > 0) {
|
||||
$builder
|
||||
->setFirstResult($state->getStart())
|
||||
->setMaxResults($state->getLength());
|
||||
}
|
||||
|
||||
$query = $builder->getQuery();
|
||||
$event = new ORMAdapterQueryEvent($query);
|
||||
$state->getDataTable()->getEventDispatcher()->dispatch($event, ORMAdapterEvents::PRE_QUERY);
|
||||
|
||||
//Use Doctrine paginator for result iteration
|
||||
$paginator = new Paginator($query);
|
||||
|
||||
foreach ($paginator->getIterator() as $result) {
|
||||
yield $result;
|
||||
$this->manager->detach($result);
|
||||
}
|
||||
}
|
||||
|
||||
public function getCount(QueryBuilder $queryBuilder, $identifier)
|
||||
{
|
||||
$paginator = new Paginator($queryBuilder);
|
||||
|
||||
return $paginator->count();
|
||||
}
|
||||
|
||||
protected function configureOptions(OptionsResolver $resolver): void
|
||||
{
|
||||
parent::configureOptions($resolver);
|
||||
|
||||
//Enforce object hydration mode (fetch join only works for objects)
|
||||
$resolver->addAllowedValues('hydrate', Query::HYDRATE_OBJECT);
|
||||
|
||||
/**
|
||||
/*
|
||||
* Add the possibility to replace the query for total entity count through a very simple one, to improve performance.
|
||||
* You can only use this option, if you did not apply any criteria to your total count.
|
||||
*/
|
||||
$resolver->setDefault('simple_total_query', false);
|
||||
|
||||
return $resolver;
|
||||
}
|
||||
|
||||
protected function prepareQuery(AdapterQuery $query)
|
||||
protected function prepareQuery(AdapterQuery $query): void
|
||||
{
|
||||
$state = $query->getState();
|
||||
$query->set('qb', $builder = $this->createQueryBuilder($state));
|
||||
|
|
@ -96,43 +136,6 @@ class FetchJoinORMAdapter extends ORMAdapter
|
|||
$query->setIdentifierPropertyPath($this->mapFieldToPropertyPath($identifier, $aliases));
|
||||
}
|
||||
|
||||
public function getResults(AdapterQuery $query): \Traversable
|
||||
{
|
||||
$builder = $query->get('qb');
|
||||
$state = $query->getState();
|
||||
|
||||
// Apply definitive view state for current 'page' of the table
|
||||
foreach ($state->getOrderBy() as list($column, $direction)) {
|
||||
/** @var AbstractColumn $column */
|
||||
if ($column->isOrderable()) {
|
||||
$builder->addOrderBy($column->getOrderField(), $direction);
|
||||
}
|
||||
}
|
||||
if ($state->getLength() > 0) {
|
||||
$builder
|
||||
->setFirstResult($state->getStart())
|
||||
->setMaxResults($state->getLength());
|
||||
}
|
||||
|
||||
$query = $builder->getQuery();
|
||||
$event = new ORMAdapterQueryEvent($query);
|
||||
$state->getDataTable()->getEventDispatcher()->dispatch($event, ORMAdapterEvents::PRE_QUERY);
|
||||
|
||||
//Use Doctrine paginator for result iteration
|
||||
$paginator = new Paginator($query);
|
||||
|
||||
foreach ($paginator->getIterator() as $result) {
|
||||
yield $result;
|
||||
$this->manager->detach($result);
|
||||
}
|
||||
}
|
||||
|
||||
public function getCount(QueryBuilder $queryBuilder, $identifier)
|
||||
{
|
||||
$paginator = new Paginator($queryBuilder);
|
||||
return $paginator->count();
|
||||
}
|
||||
|
||||
protected function getSimpleTotalCount(QueryBuilder $queryBuilder)
|
||||
{
|
||||
/** The paginator count queries can be rather slow, so when query for total count (100ms or longer),
|
||||
|
|
@ -140,6 +143,7 @@ class FetchJoinORMAdapter extends ORMAdapter
|
|||
*/
|
||||
/** @var Query\Expr\From $from_expr */
|
||||
$from_expr = $queryBuilder->getDQLPart('from')[0];
|
||||
|
||||
return $this->manager->getRepository($from_expr->getFrom())->count([]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -37,28 +37,27 @@ use Symfony\Component\OptionsResolver\OptionsResolver;
|
|||
*/
|
||||
class ORMAdapter extends AbstractAdapter
|
||||
{
|
||||
/** @var ManagerRegistry */
|
||||
private $registry;
|
||||
|
||||
/** @var EntityManager */
|
||||
protected $manager;
|
||||
|
||||
/** @var \Doctrine\ORM\Mapping\ClassMetadata */
|
||||
protected $metadata;
|
||||
|
||||
/** @var QueryBuilderProcessorInterface[] */
|
||||
protected $criteriaProcessors;
|
||||
/** @var ManagerRegistry */
|
||||
private $registry;
|
||||
|
||||
/** @var int */
|
||||
private $hydrationMode;
|
||||
|
||||
/** @var QueryBuilderProcessorInterface[] */
|
||||
private $queryBuilderProcessors;
|
||||
|
||||
/** @var QueryBuilderProcessorInterface[] */
|
||||
protected $criteriaProcessors;
|
||||
|
||||
/**
|
||||
* DoctrineAdapter constructor.
|
||||
*/
|
||||
public function __construct(ManagerRegistry $registry = null)
|
||||
public function __construct(?ManagerRegistry $registry = null)
|
||||
{
|
||||
if (null === $registry) {
|
||||
throw new MissingDependencyException('Install doctrine/doctrine-bundle to use the ORMAdapter');
|
||||
|
|
@ -68,10 +67,7 @@ class ORMAdapter extends AbstractAdapter
|
|||
$this->registry = $registry;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function configure(array $options)
|
||||
public function configure(array $options): void
|
||||
{
|
||||
$resolver = new OptionsResolver();
|
||||
$this->configureOptions($resolver);
|
||||
|
|
@ -92,15 +88,12 @@ class ORMAdapter extends AbstractAdapter
|
|||
$this->criteriaProcessors = $options['criteria'];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $processor
|
||||
*/
|
||||
public function addCriteriaProcessor($processor)
|
||||
public function addCriteriaProcessor($processor): void
|
||||
{
|
||||
$this->criteriaProcessors[] = $this->normalizeProcessor($processor);
|
||||
}
|
||||
|
||||
protected function prepareQuery(AdapterQuery $query)
|
||||
protected function prepareQuery(AdapterQuery $query): void
|
||||
{
|
||||
$state = $query->getState();
|
||||
$query->set('qb', $builder = $this->createQueryBuilder($state));
|
||||
|
|
@ -150,7 +143,7 @@ class ORMAdapter extends AbstractAdapter
|
|||
continue;
|
||||
}
|
||||
|
||||
list($origin, $target) = explode('.', $join->getJoin());
|
||||
[$origin, $target] = explode('.', $join->getJoin());
|
||||
|
||||
$mapping = $aliases[$origin][1]->getAssociationMapping($target);
|
||||
$aliases[$join->getAlias()] = [$join->getJoin(), $this->manager->getMetadataFactory()->getMetadataFor($mapping['targetEntity'])];
|
||||
|
|
@ -160,9 +153,6 @@ class ORMAdapter extends AbstractAdapter
|
|||
return $aliases;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function mapPropertyPath(AdapterQuery $query, AbstractColumn $column)
|
||||
{
|
||||
return $this->mapFieldToPropertyPath($column->getField(), $query->get('aliases'));
|
||||
|
|
@ -175,7 +165,7 @@ class ORMAdapter extends AbstractAdapter
|
|||
$state = $query->getState();
|
||||
|
||||
// Apply definitive view state for current 'page' of the table
|
||||
foreach ($state->getOrderBy() as list($column, $direction)) {
|
||||
foreach ($state->getOrderBy() as [$column, $direction]) {
|
||||
/** @var AbstractColumn $column */
|
||||
if ($column->isOrderable()) {
|
||||
$builder->addOrderBy($column->getOrderField(), $direction);
|
||||
|
|
@ -200,7 +190,7 @@ class ORMAdapter extends AbstractAdapter
|
|||
}
|
||||
}
|
||||
|
||||
protected function buildCriteria(QueryBuilder $queryBuilder, DataTableState $state)
|
||||
protected function buildCriteria(QueryBuilder $queryBuilder, DataTableState $state): void
|
||||
{
|
||||
foreach ($this->criteriaProcessors as $provider) {
|
||||
$provider->process($queryBuilder, $state);
|
||||
|
|
@ -222,6 +212,7 @@ class ORMAdapter extends AbstractAdapter
|
|||
|
||||
/**
|
||||
* @param $identifier
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
protected function getCount(QueryBuilder $queryBuilder, $identifier)
|
||||
|
|
@ -230,21 +221,21 @@ class ORMAdapter extends AbstractAdapter
|
|||
|
||||
$qb->resetDQLPart('orderBy');
|
||||
$gb = $qb->getDQLPart('groupBy');
|
||||
if (empty($gb) || !$this->hasGroupByPart($identifier, $gb)) {
|
||||
if (empty($gb) || ! $this->hasGroupByPart($identifier, $gb)) {
|
||||
$qb->select($qb->expr()->count($identifier));
|
||||
|
||||
return (int) $qb->getQuery()->getSingleScalarResult();
|
||||
} else {
|
||||
$qb->resetDQLPart('groupBy');
|
||||
$qb->select($qb->expr()->countDistinct($identifier));
|
||||
|
||||
return (int) $qb->getQuery()->getSingleScalarResult();
|
||||
}
|
||||
$qb->resetDQLPart('groupBy');
|
||||
$qb->select($qb->expr()->countDistinct($identifier));
|
||||
|
||||
return (int) $qb->getQuery()->getSingleScalarResult();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $identifier
|
||||
* @param Query\Expr\GroupBy[] $gbList
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function hasGroupByPart($identifier, array $gbList)
|
||||
|
|
@ -260,6 +251,7 @@ class ORMAdapter extends AbstractAdapter
|
|||
|
||||
/**
|
||||
* @param string $field
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function mapFieldToPropertyPath($field, array $aliases = [])
|
||||
|
|
@ -268,25 +260,25 @@ class ORMAdapter extends AbstractAdapter
|
|||
if (count($parts) < 2) {
|
||||
throw new InvalidConfigurationException(sprintf("Field name '%s' must consist at least of an alias and a field separated with a period", $field));
|
||||
}
|
||||
list($origin, $target) = $parts;
|
||||
[$origin, $target] = $parts;
|
||||
|
||||
$path = [$target];
|
||||
$current = $aliases[$origin][0];
|
||||
|
||||
while (null !== $current) {
|
||||
list($origin, $target) = explode('.', $current);
|
||||
[$origin, $target] = explode('.', $current);
|
||||
$path[] = $target;
|
||||
$current = $aliases[$origin][0];
|
||||
}
|
||||
|
||||
if (Query::HYDRATE_ARRAY === $this->hydrationMode) {
|
||||
return '[' . implode('][', array_reverse($path)) . ']';
|
||||
} else {
|
||||
return implode('.', array_reverse($path));
|
||||
return '['.implode('][', array_reverse($path)).']';
|
||||
}
|
||||
|
||||
return implode('.', array_reverse($path));
|
||||
}
|
||||
|
||||
protected function configureOptions(OptionsResolver $resolver)
|
||||
protected function configureOptions(OptionsResolver $resolver): void
|
||||
{
|
||||
$providerNormalizer = function (Options $options, $value) {
|
||||
return array_map([$this, 'normalizeProcessor'], (array) $value);
|
||||
|
|
@ -294,12 +286,12 @@ class ORMAdapter extends AbstractAdapter
|
|||
|
||||
$resolver
|
||||
->setDefaults([
|
||||
'hydrate' => Query::HYDRATE_OBJECT,
|
||||
'query' => [],
|
||||
'criteria' => function (Options $options) {
|
||||
return [new SearchCriteriaProvider()];
|
||||
},
|
||||
])
|
||||
'hydrate' => Query::HYDRATE_OBJECT,
|
||||
'query' => [],
|
||||
'criteria' => function (Options $options) {
|
||||
return [new SearchCriteriaProvider()];
|
||||
},
|
||||
])
|
||||
->setRequired('entity')
|
||||
->setAllowedTypes('entity', ['string'])
|
||||
->setAllowedTypes('hydrate', 'int')
|
||||
|
|
@ -312,6 +304,7 @@ class ORMAdapter extends AbstractAdapter
|
|||
|
||||
/**
|
||||
* @param callable|QueryBuilderProcessorInterface $provider
|
||||
*
|
||||
* @return QueryBuilderProcessorInterface
|
||||
*/
|
||||
private function normalizeProcessor($provider)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue