jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

refactored repositories and DB queries (#5026)

Browse Source 
* removed unused teams from export order
* added new paginator for query instead of querybuilder
* added field hydrate enums
* hide PARTIAL deprecation
* never log deprecations in production
* replaced InvoiceLoader with native Doctrine feature
* prevent excessive permission queries
* support loading customers of team
* improved findByIds
* internalized API
* fix null string deprecations
This commit is contained in:
Kevin Papst
2024-08-27 10:11:19 +02:00
committed by GitHub
parent 9e3d243b4b
commit 9d933f62c0
81 changed files with 1648 additions and 1436 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
src/Repository/ProjectRepository.php
View File

@@ -17,16 +17,18 @@ use App\Entity\Team;
use App\Entity\Timesheet;
use App\Entity\User;
use App\Repository\Loader\ProjectLoader;
use App\Repository\Paginator\LoaderPaginator;
use App\Repository\Paginator\LoaderQueryPaginator;
use App\Repository\Paginator\PaginatorInterface;
use App\Repository\Query\ProjectFormTypeQuery;
use App\Repository\Query\ProjectQuery;
use App\Repository\Query\ProjectQueryHydrate;
use App\Utils\Pagination;
use DateTime;
use Doctrine\DBAL\ParameterType;
use Doctrine\DBAL\Types\Types;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Exception\ORMException;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Query;
use Doctrine\ORM\Query\Expr\Andx;
use Doctrine\ORM\QueryBuilder;
@@ -40,30 +42,31 @@ class ProjectRepository extends EntityRepository
/**
* @param int[] $projectIds
* @return Project[]
* @return array<Project>
*/
public function findByIds(array $projectIds): array
{
$ids = array_filter(
array_unique($projectIds),
function ($value) {
return $value > 0;
}
);
if (\count($ids) === 0) {
return [];
}
$qb = $this->createQueryBuilder('p');
$qb
->where($qb->expr()->in('p.id', ':id'))
->setParameter('id', $projectIds)
->setParameter('id', $ids)
;
$projects = $qb->getQuery()->getResult();
$loader = new ProjectLoader($qb->getEntityManager(), true);
$loader->loadResults($projects);
return $projects;
return $this->getProjects($this->prepareProjectQuery($qb->getQuery()));
}
/**
* @param Project $project
* @throws ORMException
* @throws \Doctrine\ORM\OptimisticLockException
*/
public function saveProject(Project $project)
public function saveProject(Project $project): void
{
$entityManager = $this->getEntityManager();
$entityManager->persist($project);
@@ -71,13 +74,12 @@ class ProjectRepository extends EntityRepository
}
/**
* @param null|bool $visible
* @return int
* @return int<0, max>
*/
public function countProject($visible = null): int
public function countProject(?bool $visible = null): int
{
if (null !== $visible) {
return $this->count(['visible' => (bool) $visible]);
return $this->count(['visible' => $visible]);
}
return $this->count([]);
@@ -91,7 +93,7 @@ class ProjectRepository extends EntityRepository
}
}
public function getPermissionCriteria(QueryBuilder $qb, ?User $user = null, array $teams = []): Andx
private function getPermissionCriteria(QueryBuilder $qb, ?User $user = null, array $teams = []): Andx
{
$andX = $qb->expr()->andX();
@@ -140,8 +142,7 @@ class ProjectRepository extends EntityRepository
/**
* Returns a query builder that is used for ProjectType and your own 'query_builder' option.
*
* @param ProjectFormTypeQuery $query
* @return QueryBuilder
* @internal
*/
public function getQueryBuilderForFormType(ProjectFormTypeQuery $query): QueryBuilder
{
@@ -213,6 +214,10 @@ class ProjectRepository extends EntityRepository
->leftJoin('p.customer', 'c')
;
if (\count($query->getProjectIds()) > 0) {
$qb->andWhere($qb->expr()->in('p.id', ':id'))->setParameter('id', $query->getProjectIds());
}
foreach ($query->getOrderGroups() as $orderBy => $order) {
switch ($orderBy) {
case 'customer':
@@ -332,6 +337,9 @@ class ProjectRepository extends EntityRepository
return $and;
}
/**
* @return int<0, max>
*/
public function countProjectsForQuery(ProjectQuery $query): int
{
$qb = $this->getQueryBuilderForQuery($query);
@@ -342,7 +350,7 @@ class ProjectRepository extends EntityRepository
->select($qb->expr()->countDistinct('p.id'))
;
return (int) $qb->getQuery()->getSingleScalarResult();
return (int) $qb->getQuery()->getSingleScalarResult(); // @phpstan-ignore-line
}
public function getPagerfantaForQuery(ProjectQuery $query): Pagination
@@ -350,34 +358,41 @@ class ProjectRepository extends EntityRepository
return new Pagination($this->getPaginatorForQuery($query), $query);
}
private function getPaginatorForQuery(ProjectQuery $query): PaginatorInterface
/**
* @return PaginatorInterface<Project>
*/
private function getPaginatorForQuery(ProjectQuery $projectQuery): PaginatorInterface
{
$counter = $this->countProjectsForQuery($query);
$qb = $this->getQueryBuilderForQuery($query);
$counter = $this->countProjectsForQuery($projectQuery);
$query = $this->createProjectQuery($projectQuery);
return new LoaderPaginator(new ProjectLoader($qb->getEntityManager()), $qb, $counter);
return new LoaderQueryPaginator(new ProjectLoader($this->getEntityManager(), false, true), $query, $counter);
}
/**
* @param ProjectQuery $query
* @return Project[]
*/
public function getProjectsForQuery(ProjectQuery $query): iterable
public function getProjectsForQuery(ProjectQuery $query): array
{
$qb = $this->getQueryBuilderForQuery($query);
$results = $qb->getQuery()->execute();
$loader = new ProjectLoader($qb->getEntityManager());
$loader->loadResults($results);
return $results;
return $this->getProjects($this->createProjectQuery($query));
}
/**
* @param Project $delete
* @param Project|null $replace
* @throws \Doctrine\ORM\Exception\ORMException
* @param Query<Project> $query
* @return Project[]
*/
public function deleteProject(Project $delete, ?Project $replace = null)
public function getProjects(Query $query): array
{
/** @var array<Project> $projects */
$projects = $query->execute();
$loader = new ProjectLoader($this->getEntityManager(), false, true);
$loader->loadResults($projects);
return $projects;
}
public function deleteProject(Project $delete, ?Project $replace = null): void
{
$em = $this->getEntityManager();
$em->beginTransaction();
@@ -429,17 +444,58 @@ class ProjectRepository extends EntityRepository
return $qb->getQuery()->getResult();
}
public function saveComment(ProjectComment $comment)
public function saveComment(ProjectComment $comment): void
{
$entityManager = $this->getEntityManager();
$entityManager->persist($comment);
$entityManager->flush();
}
public function deleteComment(ProjectComment $comment)
public function deleteComment(ProjectComment $comment): void
{
$entityManager = $this->getEntityManager();
$entityManager->remove($comment);
$entityManager->flush();
}
/**
* @return Query<Project>
*/
private function createProjectQuery(ProjectQuery $projectQuery): Query
{
$query = $this->getQueryBuilderForQuery($projectQuery)->getQuery();
$query = $this->prepareProjectQuery($query);
foreach ($projectQuery->getHydrate() as $hydrate) {
switch ($hydrate) {
case ProjectQueryHydrate::TEAMS:
// does not yet work, see https://github.com/doctrine/orm/pull/8391
// $query->setFetchMode(Project::class, 'teams', ClassMetadata::FETCH_EAGER);
break;
case ProjectQueryHydrate::TEAM_MEMBER:
// does not yet work, see https://github.com/doctrine/orm/issues/11254
// $query->setFetchMode(Project::class, 'teams', ClassMetadata::FETCH_EAGER);
// $query->setFetchMode(Team::class, 'members', ClassMetadata::FETCH_EAGER);
// $query->setFetchMode(TeamMember::class, 'user', ClassMetadata::FETCH_EAGER);
break;
}
}
return $query;
}
/**
* @param Query<Project> $query
* @return Query<Project>
*/
public function prepareProjectQuery(Query $query): Query
{
$this->getEntityManager()->getConfiguration()->setEagerFetchBatchSize(300);
$query->setFetchMode(Project::class, 'meta', ClassMetadata::FETCH_EAGER);
$query->setFetchMode(Project::class, 'customer', ClassMetadata::FETCH_EAGER);
return $query;
}
}