From 69b563948de3b293fee47f60bde3f63d512b13c5 Mon Sep 17 00:00:00 2001 From: Kevin Decherf Date: Sun, 2 Sep 2018 17:32:32 +0200 Subject: [PATCH 1/4] AnnotationRepository: rename getBuilderByUser We rename getBuilderByUser to getSortedQueryBuilderByUser as long as the method currently returns a QueryBuilder with an orderBy() Signed-off-by: Kevin Decherf --- .../AnnotationBundle/Repository/AnnotationRepository.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Wallabag/AnnotationBundle/Repository/AnnotationRepository.php b/src/Wallabag/AnnotationBundle/Repository/AnnotationRepository.php index b44f7e647..0de5c934e 100644 --- a/src/Wallabag/AnnotationBundle/Repository/AnnotationRepository.php +++ b/src/Wallabag/AnnotationBundle/Repository/AnnotationRepository.php @@ -21,7 +21,7 @@ class AnnotationRepository extends EntityRepository public function getBuilderForAllByUser($userId) { return $this - ->getBuilderByUser($userId) + ->getSortedQueryBuilderByUser($userId) ; } @@ -133,7 +133,7 @@ class AnnotationRepository extends EntityRepository * * @return QueryBuilder */ - private function getBuilderByUser($userId) + private function getSortedQueryBuilderByUser($userId) { return $this->createQueryBuilder('a') ->leftJoin('a.user', 'u') From b7c5fda512f29c99db69cb090fafb6f79abf6004 Mon Sep 17 00:00:00 2001 From: Kevin Decherf Date: Sun, 2 Sep 2018 17:34:30 +0200 Subject: [PATCH 2/4] EntryRepository: refactor getBuilderByUser We refactor getBuilderByUser to separate QueryBuilder getter and the orderBy(). The previous code of getBuilderByUser() has been moved to getSortedQueryBuilderByUser(). getBuildByUser() now returns a QueryBuilder without the call to orderBy(). A new method named sortQueryBuilder() returns a given QueryBuilder with an orderBy() call using given sort parameters. Signed-off-by: Kevin Decherf --- .../CoreBundle/Repository/EntryRepository.php | 50 ++++++++++++++----- 1 file changed, 38 insertions(+), 12 deletions(-) diff --git a/src/Wallabag/CoreBundle/Repository/EntryRepository.php b/src/Wallabag/CoreBundle/Repository/EntryRepository.php index 38a3026d4..749d2338c 100644 --- a/src/Wallabag/CoreBundle/Repository/EntryRepository.php +++ b/src/Wallabag/CoreBundle/Repository/EntryRepository.php @@ -21,7 +21,7 @@ class EntryRepository extends EntityRepository public function getBuilderForAllByUser($userId) { return $this - ->getBuilderByUser($userId) + ->getSortedQueryBuilderByUser($userId) ; } @@ -35,7 +35,7 @@ class EntryRepository extends EntityRepository public function getBuilderForUnreadByUser($userId) { return $this - ->getBuilderByUser($userId) + ->getSortedQueryBuilderByUser($userId) ->andWhere('e.isArchived = false') ; } @@ -50,7 +50,7 @@ class EntryRepository extends EntityRepository public function getBuilderForArchiveByUser($userId) { return $this - ->getBuilderByUser($userId) + ->getSortedQueryBuilderByUser($userId) ->andWhere('e.isArchived = true') ; } @@ -65,7 +65,7 @@ class EntryRepository extends EntityRepository public function getBuilderForStarredByUser($userId) { return $this - ->getBuilderByUser($userId, 'starredAt', 'desc') + ->getSortedQueryBuilderByUser($userId, 'starredAt', 'desc') ->andWhere('e.isStarred = true') ; } @@ -82,7 +82,7 @@ class EntryRepository extends EntityRepository public function getBuilderForSearchByUser($userId, $term, $currentRoute) { $qb = $this - ->getBuilderByUser($userId); + ->getSortedQueryBuilderByUser($userId); if ('starred' === $currentRoute) { $qb->andWhere('e.isStarred = true'); @@ -111,7 +111,7 @@ class EntryRepository extends EntityRepository public function getBuilderForUntaggedByUser($userId) { return $this - ->getBuilderByUser($userId) + ->getSortedQueryBuilderByUser($userId) ->andWhere('size(e.tags) = 0'); } @@ -260,7 +260,7 @@ class EntryRepository extends EntityRepository */ public function removeTag($userId, Tag $tag) { - $entries = $this->getBuilderByUser($userId) + $entries = $this->getSortedQueryBuilderByUser($userId) ->innerJoin('e.tags', 't') ->andWhere('t.id = :tagId')->setParameter('tagId', $tag->getId()) ->getQuery() @@ -296,7 +296,7 @@ class EntryRepository extends EntityRepository */ public function findAllByTagId($userId, $tagId) { - return $this->getBuilderByUser($userId) + return $this->getSortedQueryBuilderByUser($userId) ->innerJoin('e.tags', 't') ->andWhere('t.id = :tagId')->setParameter('tagId', $tagId) ->getQuery() @@ -414,7 +414,20 @@ class EntryRepository extends EntityRepository } /** - * Return a query builder to used by other getBuilderFor* method. + * Return a query builder to be used by other getBuilderFor* method. + * + * @param int $userId + * + * @return QueryBuilder + */ + private function getQueryBuilderByUser($userId) + { + return $this->createQueryBuilder('e') + ->andWhere('e.user = :userId')->setParameter('userId', $userId); + } + + /** + * Return a sorted query builder to be used by other getBuilderFor* method. * * @param int $userId * @param string $sortBy @@ -422,10 +435,23 @@ class EntryRepository extends EntityRepository * * @return QueryBuilder */ - private function getBuilderByUser($userId, $sortBy = 'createdAt', $direction = 'desc') + private function getSortedQueryBuilderByUser($userId, $sortBy = 'createdAt', $direction = 'desc') { - return $this->createQueryBuilder('e') - ->andWhere('e.user = :userId')->setParameter('userId', $userId) + return $this->sortQueryBuilder($this->getQueryBuilderByUser($userId)); + } + + /** + * Return the given QueryBuilder with an orderBy() call + * + * @param QueryBuilder $qb + * @param string $sortBy + * @param string $direction + * + * @return QueryBuilder + */ + private function sortQueryBuilder(QueryBuilder $qb, $sortBy = 'createdAt', $direction = 'desc') + { + return $qb ->orderBy(sprintf('e.%s', $sortBy), $direction); } } From 0636697289b7ad50bfaa33c93ce4593543d435b5 Mon Sep 17 00:00:00 2001 From: Kevin Decherf Date: Sun, 2 Sep 2018 17:44:19 +0200 Subject: [PATCH 3/4] EntryRepository: refactor getBuilderForUntaggedByUser Improve SQL performance by replacing size(e.tags) with a left join and a null condition Move the QueryBuilder logic into getRawBuilderForUntaggedByUser Signed-off-by: Kevin Decherf --- .../CoreBundle/Repository/EntryRepository.php | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/src/Wallabag/CoreBundle/Repository/EntryRepository.php b/src/Wallabag/CoreBundle/Repository/EntryRepository.php index 749d2338c..a31f97b5a 100644 --- a/src/Wallabag/CoreBundle/Repository/EntryRepository.php +++ b/src/Wallabag/CoreBundle/Repository/EntryRepository.php @@ -102,7 +102,7 @@ class EntryRepository extends EntityRepository } /** - * Retrieves untagged entries for a user. + * Retrieve a sorted list of untagged entries for a user. * * @param int $userId * @@ -111,8 +111,21 @@ class EntryRepository extends EntityRepository public function getBuilderForUntaggedByUser($userId) { return $this - ->getSortedQueryBuilderByUser($userId) - ->andWhere('size(e.tags) = 0'); + ->sortQueryBuilder($this->getRawBuilderForUntaggedByUser($userId)); + } + + /** + * Retrieve untagged entries for a user. + * + * @param int $userId + * + * @return QueryBuilder + */ + public function getRawBuilderForUntaggedByUser($userId) + { + return $this->getQueryBuilderByUser($userId) + ->leftJoin('e.tags', 't') + ->andWhere('t.id is null'); } /** From b8115ff46b15a28021612b695de8785456f8b7a6 Mon Sep 17 00:00:00 2001 From: Kevin Decherf Date: Sun, 2 Sep 2018 18:36:04 +0200 Subject: [PATCH 4/4] php-cs-fixer Signed-off-by: Kevin Decherf --- .../CoreBundle/Repository/EntryRepository.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Wallabag/CoreBundle/Repository/EntryRepository.php b/src/Wallabag/CoreBundle/Repository/EntryRepository.php index a31f97b5a..34123eea6 100644 --- a/src/Wallabag/CoreBundle/Repository/EntryRepository.php +++ b/src/Wallabag/CoreBundle/Repository/EntryRepository.php @@ -116,9 +116,9 @@ class EntryRepository extends EntityRepository /** * Retrieve untagged entries for a user. - * + * * @param int $userId - * + * * @return QueryBuilder */ public function getRawBuilderForUntaggedByUser($userId) @@ -429,7 +429,7 @@ class EntryRepository extends EntityRepository /** * Return a query builder to be used by other getBuilderFor* method. * - * @param int $userId + * @param int $userId * * @return QueryBuilder */ @@ -454,11 +454,11 @@ class EntryRepository extends EntityRepository } /** - * Return the given QueryBuilder with an orderBy() call - * + * Return the given QueryBuilder with an orderBy() call. + * * @param QueryBuilder $qb - * @param string $sortBy - * @param string $direction + * @param string $sortBy + * @param string $direction * * @return QueryBuilder */