give / src / Framework / QueryBuilder / JoinQueryBuilder.php

JoinQueryBuilder.php in GiveWP – Donation Plugin and Fundraising Platform 2.23.0, at src/Framework/QueryBuilder/JoinQueryBuilder.php

179 lines 3.4 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Framework\QueryBuilder;
4
5	use Give\Framework\QueryBuilder\Clauses\Join;
6	use Give\Framework\QueryBuilder\Clauses\JoinCondition;
7	use Give\Framework\QueryBuilder\Clauses\RawSQL;
8	use Give\Framework\QueryBuilder\Types\JoinType;
9	use Give\Framework\QueryBuilder\Types\Operator;
10
11	/**
12	* @since 2.19.0
13	*/
14	class JoinQueryBuilder
15	{
16
17	/**
18	* @var Join[]\|JoinCondition[]\|RawSQL[]
19	*/
20	private $joins = [];
21
22	/**
23	* @param string\|RawSQL $table
24	* @param null\|string $alias
25	*
26	* @return $this
27	*/
28	public function leftJoin($table, $alias = null)
29	{
30	return $this->join(
31	JoinType::LEFT,
32	$table,
33	$alias
34	);
35	}
36
37	/**
38	* @param string\|RawSQL $table
39	* @param null\|string $alias
40	*
41	* @return $this
42	*/
43	public function rightJoin($table, $alias = null)
44	{
45	return $this->join(
46	JoinType::RIGHT,
47	$table,
48	$alias
49	);
50	}
51
52	/**
53	* @param string\|RawSQL $table
54	* @param null\|string $alias
55	*
56	* @return $this
57	*/
58	public function innerJoin($table, $alias = null)
59	{
60	return $this->join(
61	JoinType::INNER,
62	$table,
63	$alias
64	);
65	}
66
67	/**
68	* @param string $column1
69	* @param string $column2
70	* @param bool $quote
71	*
72	* @return $this
73	*/
74	public function on($column1, $column2, $quote = false)
75	{
76	return $this->joinCondition(
77	Operator::ON,
78	$column1,
79	$column2,
80	$quote
81	);
82	}
83
84	/**
85	* @param string $column1
86	* @param string $column2
87	* @param bool $quote
88	*
89	* @return $this
90	*/
91	public function andOn($column1, $column2, $quote = null)
92	{
93	return $this->joinCondition(
94	Operator::_AND,
95	$column1,
96	$column2,
97	$quote
98	);
99	}
100
101	/**
102	* @param string $column1
103	* @param string $column2
104	* @param bool $quote
105	*
106	* @return $this
107	*/
108	public function orOn($column1, $column2, $quote = null)
109	{
110	return $this->joinCondition(
111	Operator::_OR,
112	$column1,
113	$column2,
114	$quote
115	);
116	}
117
118	/**
119	* Add raw SQL JOIN clause
120	*
121	* @param string $sql
122	* @param ...$args
123	*/
124	public function joinRaw($sql, ...$args)
125	{
126	$this->joins[] = new RawSQL($sql, $args);
127	}
128
129	/**
130	* Add Join
131	*
132	* @param string $joinType
133	* @param string\|RawSQL $table
134	* @param string $alias
135	*
136	* @return $this
137	*/
138	private function join($joinType, $table, $alias)
139	{
140	$this->joins[] = new Join(
141	$joinType,
142	$table,
143	$alias
144	);
145
146	return $this;
147	}
148
149	/**
150	* Add JoinCondition
151	*
152	* @param string $operator
153	* @param string $column1
154	* @param string $column2
155	* @param bool $quote
156	*
157	* @return $this
158	*/
159	private function joinCondition($operator, $column1, $column2, $quote)
160	{
161	$this->joins[] = new JoinCondition(
162	$operator,
163	$column1,
164	$column2,
165	$quote
166	);
167
168	return $this;
169	}
170
171	/**
172	* @return Join[]\|JoinCondition[]
173	*/
174	public function getDefinedJoins()
175	{
176	return $this->joins;
177	}
178	}
179