Completed
Push — master-3 ( 911075...e0a0a2 )
by Krzysztof
11:33
created

AbstractORMCriteriaBuilder::join()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 20
Code Lines 13

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 3.0123

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 20
ccs 8
cts 9
cp 0.8889
rs 9.4285
cc 3
eloc 13
nc 3
nop 4
crap 3.0123
1
<?php
2
3
namespace KGzocha\Searcher\CriteriaBuilder\Doctrine;
4
5
use Doctrine\ORM\Query\Expr\Join;
6
use Doctrine\ORM\QueryBuilder;
7
use KGzocha\Searcher\Context\Doctrine\QueryBuilderSearchingContext;
8
use KGzocha\Searcher\Context\SearchingContextInterface;
9
use KGzocha\Searcher\CriteriaBuilder\CriteriaBuilderInterface;
10
11
/**
12
 * Abstract CriteriaBuilder that can be used in builders that supports
13
 * only ODMBuilderSearchingContext.
14
 * Extra feature is join() method which will add another join only
15
 * if there is not such join already.
16
 *
17
 *@author Krzysztof Gzocha <[email protected]>
18
 */
19
abstract class AbstractORMCriteriaBuilder implements
20
    CriteriaBuilderInterface
21
{
22
    /**
23
     * {@inheritdoc}
24
     */
25 2
    public function supportsSearchingContext(
26
        SearchingContextInterface $searchingContext
27
    ) {
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(QueryBuilder $queryBuilder, $join, $alias, $joinType)
45
    {
46 2
        list($entity) = explode('.', $join);
47
48 2
        $joinParts = $queryBuilder->getDQLPart('join');
49 2
        if (!array_key_exists($entity, $joinParts)) {
50 1
            if (Join::LEFT_JOIN === $joinType) {
51 1
                return $queryBuilder->leftJoin($join, $alias);
52
            }
53
            return $queryBuilder->join($join, $alias);
54
        }
55
56 1
        return $this->filterExistingJoins(
57
            $queryBuilder,
58 1
            $joinParts[$entity],
59
            $alias,
60
            $join,
61
            $joinType
62
        );
63
    }
64
65
    /**
66
     * @param QueryBuilder $queryBuilder
67
     * @param array        $joinParts
68
     * @param string       $alias
69
     * @param string       $join
70
     * @param string       $joinType
71
     *
72
     * @return QueryBuilder
73
     */
74 7
    protected function filterExistingJoins(
75
        QueryBuilder $queryBuilder,
76
        $joinParts,
77
        $alias,
78
        $join,
79
        $joinType
80
    ) {
81 7
        $existingJoin = array_filter(
82
            $joinParts,
83 7
            function(Join $joinObj) use ($alias, $join, $joinType) {
84 7
                return $joinObj->getJoinType() == $joinType
85 7
                    && $joinObj->getAlias() == $alias
86 7
                    && $joinObj->getJoin() == $join;
87 7
            }
88
        );
89
90 7
        if ([] != $existingJoin) {
91 2
            return $queryBuilder;
92
        }
93
94 5
        if (Join::LEFT_JOIN === $joinType) {
95 3
            return $queryBuilder->leftJoin($join, $alias);
96
        }
97
98 2
        return $queryBuilder->join($join, $alias);
99
    }
100
}
101