Completed
Push — abstract-criteria-builder-join ( 79425c )
by Krzysztof
03:08
created

AbstractORMCriteriaBuilder::join()   B

Complexity

Conditions 3
Paths 3

Size

Total Lines 24
Code Lines 18

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 3.0123

Importance

Changes 0
Metric Value
dl 0
loc 24
ccs 8
cts 9
cp 0.8889
rs 8.9713
c 0
b 0
f 0
cc 3
eloc 18
nc 3
nop 4
crap 3.0123
1
<?php
2
declare(strict_types=1);
3
4
namespace KGzocha\Searcher\CriteriaBuilder\Doctrine;
5
6
use Doctrine\ORM\Query\Expr\Join;
7
use Doctrine\ORM\QueryBuilder;
8
use KGzocha\Searcher\Context\Doctrine\QueryBuilderSearchingContext;
9
use KGzocha\Searcher\Context\SearchingContextInterface;
10
use KGzocha\Searcher\CriteriaBuilder\CriteriaBuilderInterface;
11
12
/**
13
 * Abstract CriteriaBuilder that can be used in builders that supports
14
 * only ODMBuilderSearchingContext.
15
 * Extra feature is join() method which will add another join only
16
 * if there is not such join already.
17
 *
18
 *@author Krzysztof Gzocha <[email protected]>
19
 */
20
abstract class AbstractORMCriteriaBuilder implements CriteriaBuilderInterface
21
{
22
    /**
23
     * {@inheritdoc}
24
     */
25 2
    public function supportsSearchingContext(
26
        SearchingContextInterface $searchingContext
27
    ): bool {
28 2
        return $searchingContext instanceof QueryBuilderSearchingContext;
29
    }
30
31
    /**
32
     * Will do JOIN only if there is no such join already.
33
     * For any other more advanced join strategies please use unique aliases.
34
     * Remember: for performance reasons you should keep number of joins as low as possible
35
     * Example usage: $this->join($qb, 'p.house', 'h', Join::LEFT_JOIN).
36
     *
37
     * @param QueryBuilder $queryBuilder
38
     * @param string       $join
39
     * @param string       $alias
40
     * @param string       $joinType
41
     *
42
     * @return QueryBuilder
43
     */
44 2
    protected function join(
45
        QueryBuilder $queryBuilder,
46
        string $join,
47
        string $alias,
48
        string $joinType
49
    ): QueryBuilder {
50 2
        list($entity) = explode('.', $join);
51
52 2
        $joinParts = $queryBuilder->getDQLPart('join');
53 2
        if (!array_key_exists($entity, $joinParts)) {
54 1
            if (Join::LEFT_JOIN === $joinType) {
55 1
                return $queryBuilder->leftJoin($join, $alias);
56
            }
57
            return $queryBuilder->join($join, $alias);
58
        }
59
60 1
        return $this->filterExistingJoins(
61
            $queryBuilder,
62 1
            $joinParts[$entity],
63
            $alias,
64
            $join,
65
            $joinType
66
        );
67
    }
68
69
    /**
70
     * @param QueryBuilder $queryBuilder
71
     * @param array        $joinParts
72
     * @param string       $alias
73
     * @param string       $join
74
     * @param string       $joinType
75
     *
76
     * @return QueryBuilder
77
     */
78 7
    protected function filterExistingJoins(
79
        QueryBuilder $queryBuilder,
80
        array $joinParts,
81
        string $alias,
82
        string $join,
83
        string $joinType
84
    ): QueryBuilder {
85 7
        $existingJoin = array_filter(
86
            $joinParts,
87 7
            function (Join $joinObj) use ($alias, $join, $joinType) {
88 7
                return $joinObj->getJoinType() == $joinType
89 7
                    && $joinObj->getAlias() == $alias
90 7
                    && $joinObj->getJoin() == $join;
91 7
            }
92
        );
93
94 7
        if ([] != $existingJoin) {
95 2
            return $queryBuilder;
96
        }
97
98 5
        if (Join::LEFT_JOIN === $joinType) {
99 3
            return $queryBuilder->leftJoin($join, $alias);
100
        }
101
102 2
        return $queryBuilder->join($join, $alias);
103
    }
104
}
105