JoinTrait - Code Metrics - phuria/under-query - Measure and Improve Code Quality continuously with Scrutinizer

JoinTrait A
last analyzed 2016-12-22 14:17 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	10
c	0
b	0
f	0
lcom	1
cbo	3
dl	0
loc	121
ccs	25
cts	25
cp	1
rs	10

9 Methods

Rating	Name	Size	Complexity
	createTable()	1	?
A	doJoin()	17	3
A	join()	4	1
A	straightJoin()	4	1
A	crossJoin()	4	1
A	leftJoin()	4	1
A	rightJoin()	4	1
A	innerJoin()	4	1
A	getJoinTables()	4	1

<?php

/**
 * This file is part of UnderQuery package.
 *
 * Copyright (c) 2016 Beniamin Jonatan Šimko
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Phuria\UnderQuery\QueryBuilder\Clause;

use Phuria\UnderQuery\JoinType;
use Phuria\UnderQuery\Language\Expression\RelativeClause;
use Phuria\UnderQuery\Table\JoinMetadata;
use Phuria\UnderQuery\Table\TableInterface;

/**
 * @author Beniamin Jonatan Šimko <[email protected]>
 */
trait JoinTrait
{
    /**
     * @var array $joinTables
     */
    private $joinTables = [];

    /**
     * @param mixed       $table
     * @param string|null $alias
     *
     * @return TableInterface
     */
    abstract public function createTable($table, $alias = null);

    /**
     * @param string      $joinType
     * @param mixed       $table
     * @param string|null $alias
     * @param string|null $joinOn
     *
     * @return TableInterface
     */
    public function doJoin($joinType, $table, $alias = null, $joinOn = null)
    {
        $this->joinTables[] = $tableObject = $this->createTable($table, $alias);

        $joinMetadata = new JoinMetadata();
        $joinMetadata->setJoinType($joinType);

        if ($joinOn) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $relativeOn = new RelativeClause($tableObject, $joinOn, RelativeClause::SELF_DIRECTIVE);
            $joinMetadata->setJoinOn($relativeOn);
        }

        $tableObject->setJoinMetadata($joinMetadata);
        is_callable($table) && $table($tableObject, $joinMetadata);

        return $tableObject;
    }

    /**
     * @param mixed       $table
     * @param string|null $alias
     * @param string|null $joinOn
     *
     * @return TableInterface
     */
    public function join($table, $alias = null, $joinOn = null)
    {
        return $this->doJoin(JoinType::JOIN, $table, $alias, $joinOn);
    }

    /**
     * @param mixed       $table
     * @param string|null $alias
     * @param string|null $joinOn
     *
     * @return TableInterface
     */
    public function straightJoin($table, $alias = null, $joinOn = null)
    {
        return $this->doJoin(JoinType::STRAIGHT_JOIN, $table, $alias, $joinOn);
    }

    /**
     * @param mixed       $table
     * @param string|null $alias
     * @param string|null $joinOn
     *
     * @return TableInterface
     */
    public function crossJoin($table, $alias = null, $joinOn = null)
    {
        return $this->doJoin(JoinType::CROSS_JOIN, $table, $alias, $joinOn);
    }

    /**
     * @param mixed       $table
     * @param string|null $alias
     * @param string|null $joinOn
     *
     * @return TableInterface
     */
    public function leftJoin($table, $alias = null, $joinOn = null)
    {
        return $this->doJoin(JoinType::LEFT_JOIN, $table, $alias, $joinOn);
    }

    /**
     * @param mixed       $table
     * @param string|null $alias
     * @param string|null $joinOn
     *
     * @return TableInterface
     */
    public function rightJoin($table, $alias = null, $joinOn = null)
    {
        return $this->doJoin(JoinType::RIGHT_JOIN, $table, $alias, $joinOn);
    }

    /**
     * @param mixed       $table
     * @param string|null $alias
     * @param string|null $joinOn
     *
     * @return TableInterface
     */
    public function innerJoin($table, $alias = null, $joinOn = null)
    {
        return $this->doJoin(JoinType::INNER_JOIN, $table, $alias, $joinOn);
    }

    /**
     * @return array
     */
    public function getJoinTables()
    {
        return $this->joinTables;
    }
}

1		<?php
2
3		/**
4		* This file is part of UnderQuery package.
5		*
6		* Copyright (c) 2016 Beniamin Jonatan Šimko
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Phuria\UnderQuery\QueryBuilder\Clause;
13
14		use Phuria\UnderQuery\JoinType;
15		use Phuria\UnderQuery\Language\Expression\RelativeClause;
16		use Phuria\UnderQuery\Table\JoinMetadata;
17		use Phuria\UnderQuery\Table\TableInterface;
18
19		/**
20		* @author Beniamin Jonatan Šimko <[email protected]>
21		*/
22		trait JoinTrait
23		{
24		/**
25		* @var array $joinTables
26		*/
27		private $joinTables = [];
28
29		/**
30		* @param mixed $table
31		* @param string\|null $alias
32		*
33		* @return TableInterface
34		*/
35		abstract public function createTable($table, $alias = null);
36
37		/**
38		* @param string $joinType
39		* @param mixed $table
40		* @param string\|null $alias
41		* @param string\|null $joinOn
42		*
43		* @return TableInterface
44		*/
45		public function doJoin($joinType, $table, $alias = null, $joinOn = null)
46	3	{
47		$this->joinTables[] = $tableObject = $this->createTable($table, $alias);
48	3
49		$joinMetadata = new JoinMetadata();
50	3	$joinMetadata->setJoinType($joinType);
51	3
52		if ($joinOn) {
		0 ignored issues – show Bug Best Practice introduced 2016-11-20 14:47 UTC by Report Bug Copy Issue Report The expression `$joinOn` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
53	3	$relativeOn = new RelativeClause($tableObject, $joinOn, RelativeClause::SELF_DIRECTIVE);
54	1	$joinMetadata->setJoinOn($relativeOn);
55	1	}
56	1
57		$tableObject->setJoinMetadata($joinMetadata);
58	3	is_callable($table) && $table($tableObject, $joinMetadata);
59	3
60		return $tableObject;
61	3	}
62
63		/**
64		* @param mixed $table
65		* @param string\|null $alias
66		* @param string\|null $joinOn
67		*
68		* @return TableInterface
69		*/
70		public function join($table, $alias = null, $joinOn = null)
71	3	{
72		return $this->doJoin(JoinType::JOIN, $table, $alias, $joinOn);
73	3	}
74
75		/**
76		* @param mixed $table
77		* @param string\|null $alias
78		* @param string\|null $joinOn
79		*
80		* @return TableInterface
81		*/
82		public function straightJoin($table, $alias = null, $joinOn = null)
83	1	{
84		return $this->doJoin(JoinType::STRAIGHT_JOIN, $table, $alias, $joinOn);
85	1	}
86
87		/**
88		* @param mixed $table
89		* @param string\|null $alias
90		* @param string\|null $joinOn
91		*
92		* @return TableInterface
93		*/
94		public function crossJoin($table, $alias = null, $joinOn = null)
95	1	{
96		return $this->doJoin(JoinType::CROSS_JOIN, $table, $alias, $joinOn);
97	1	}
98
99		/**
100		* @param mixed $table
101		* @param string\|null $alias
102		* @param string\|null $joinOn
103		*
104		* @return TableInterface
105		*/
106		public function leftJoin($table, $alias = null, $joinOn = null)
107	1	{
108		return $this->doJoin(JoinType::LEFT_JOIN, $table, $alias, $joinOn);
109	1	}
110
111		/**
112		* @param mixed $table
113		* @param string\|null $alias
114		* @param string\|null $joinOn
115		*
116		* @return TableInterface
117		*/
118		public function rightJoin($table, $alias = null, $joinOn = null)
119	1	{
120		return $this->doJoin(JoinType::RIGHT_JOIN, $table, $alias, $joinOn);
121	1	}
122
123		/**
124		* @param mixed $table
125		* @param string\|null $alias
126		* @param string\|null $joinOn
127		*
128		* @return TableInterface
129		*/
130		public function innerJoin($table, $alias = null, $joinOn = null)
131	1	{
132		return $this->doJoin(JoinType::INNER_JOIN, $table, $alias, $joinOn);
133	1	}
134
135		/**
136		* @return array
137		*/
138		public function getJoinTables()
139	1	{
140		return $this->joinTables;
141		}
142		}

phuria / under-query

JoinTrait A last analyzed 2016-12-22 14:17 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Duplication Side-by-Side

Filter issues like

JoinTrait A
last analyzed 2016-12-22 14:17 UTC