AbstractORMCriteriaBuilder::join()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 21

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 11
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 21
ccs 11
cts 11
cp 1
rs 9.584
c 0
b 0
f 0
cc 2
nc 2
nop 4
crap 2
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
            return $this->makeJoin($queryBuilder, $join, $alias, $joinType);
55
        }
56
57 1
        return $this->filterExistingJoins(
58 1
            $queryBuilder,
59 1
            $joinParts[$entity],
60 1
            $alias,
61 1
            $join,
62 1
            $joinType
63
        );
64
    }
65
66
    /**
67
     * @param QueryBuilder $queryBuilder
68
     * @param array        $joinParts
69
     * @param string       $alias
70
     * @param string       $join
71
     * @param string       $joinType
72
     *
73
     * @return QueryBuilder
74
     */
75 7
    protected function filterExistingJoins(
76
        QueryBuilder $queryBuilder,
77
        array $joinParts,
78
        string $alias,
79
        string $join,
80
        string $joinType
81
    ): QueryBuilder {
82 7
        $existingJoin = array_filter(
83 7
            $joinParts,
84 7
            function (Join $joinObj) use ($alias, $join, $joinType) {
85 7
                return $joinObj->getJoinType() == $joinType
86 7
                    && $joinObj->getAlias() == $alias
87 7
                    && $joinObj->getJoin() == $join;
88 7
            }
89
        );
90
91 7
        if ([] != $existingJoin) {
92 2
            return $queryBuilder;
93
        }
94
95 5
        return $this->makeJoin($queryBuilder, $join, $alias, $joinType);
96
    }
97
98
    /**
99
     * @param QueryBuilder $queryBuilder
100
     * @param string $join
101
     * @param string $alias
102
     * @param string $joinType
103
     * @return QueryBuilder
104
     */
105 6
    private function makeJoin(QueryBuilder $queryBuilder, string $join, string $alias, string $joinType): QueryBuilder
106
    {
107 6
        if (Join::LEFT_JOIN === $joinType) {
108 4
            return $queryBuilder->leftJoin($join, $alias);
109
        }
110
111 2
        return $queryBuilder->join($join, $alias);
112
    }
113
}
114