1
|
|
|
<?php |
2
|
|
|
declare(strict_types=1); |
3
|
|
|
|
4
|
|
|
/** |
5
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
6
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
7
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
8
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
9
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
10
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
11
|
|
|
* THE SOFTWARE. |
12
|
|
|
*/ |
13
|
|
|
|
14
|
|
|
namespace Ytake\LaravelCouchbase\Query; |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* Class Builder |
18
|
|
|
*/ |
19
|
|
|
class Builder extends \Illuminate\Database\Query\Builder |
20
|
|
|
{ |
21
|
|
|
/** |
22
|
|
|
* The database connection instance. |
23
|
|
|
* |
24
|
|
|
* @var \Ytake\LaravelCouchbase\Database\CouchbaseConnection |
25
|
|
|
*/ |
26
|
|
|
public $connection; |
27
|
|
|
|
28
|
|
|
/** |
29
|
|
|
* The database query grammar instance. |
30
|
|
|
* |
31
|
|
|
* @var \Ytake\LaravelCouchbase\Query\Grammar |
32
|
|
|
*/ |
33
|
|
|
public $grammar; |
34
|
|
|
|
35
|
|
|
/** @var string use-keys-clause */ |
36
|
|
|
public $key; |
37
|
|
|
|
38
|
|
|
/** @var string[] returning-clause */ |
39
|
|
|
public $returning = ['*']; |
40
|
|
|
|
41
|
|
|
/** |
42
|
|
|
* @param string $key |
43
|
|
|
* |
44
|
|
|
* @return Builder |
45
|
|
|
*/ |
46
|
14 |
|
public function key(string $key): Builder |
47
|
|
|
{ |
48
|
14 |
|
$this->key = $key; |
49
|
|
|
|
50
|
14 |
|
return $this; |
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* @param array $column |
55
|
|
|
* |
56
|
|
|
* @return Builder |
57
|
|
|
*/ |
58
|
6 |
|
public function returning(array $column = ['*']): Builder |
59
|
|
|
{ |
60
|
6 |
|
$this->returning = $column; |
61
|
|
|
|
62
|
6 |
|
return $this; |
63
|
|
|
} |
64
|
|
|
|
65
|
|
|
/** |
66
|
|
|
* Insert a new record into the database. |
67
|
|
|
* |
68
|
|
|
* @param array $values |
69
|
|
|
* |
70
|
|
|
* @return bool |
71
|
|
|
*/ |
72
|
10 |
|
public function insert(array $values) |
73
|
|
|
{ |
74
|
10 |
|
if (empty($values)) { |
75
|
|
|
return true; |
76
|
|
|
} |
77
|
10 |
|
$values = $this->detectValues($values); |
78
|
10 |
|
$bindings = []; |
79
|
10 |
|
foreach ($values as $record) { |
80
|
10 |
|
foreach ($record as $key => $value) { |
81
|
10 |
|
$bindings[$key] = $value; |
82
|
|
|
} |
83
|
|
|
} |
84
|
|
|
|
85
|
10 |
|
$sql = $this->grammar->compileInsert($this, $values); |
86
|
|
|
|
87
|
10 |
|
return $this->connection->insert($sql, $bindings); |
|
|
|
|
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
/** |
91
|
|
|
* supported N1QL upsert query. |
92
|
|
|
* |
93
|
|
|
* @param array $values |
94
|
|
|
* |
95
|
|
|
* @return bool|mixed |
96
|
|
|
*/ |
97
|
2 |
|
public function upsert(array $values) |
98
|
|
|
{ |
99
|
2 |
|
if (empty($values)) { |
100
|
|
|
return true; |
101
|
|
|
} |
102
|
2 |
|
$values = $this->detectValues($values); |
103
|
2 |
|
$bindings = []; |
104
|
2 |
|
foreach ($values as $record) { |
105
|
2 |
|
foreach ($record as $key => $value) { |
106
|
2 |
|
$bindings[$key] = $value; |
107
|
|
|
} |
108
|
|
|
} |
109
|
|
|
|
110
|
2 |
|
$sql = $this->grammar->compileUpsert($this, $values); |
111
|
|
|
|
112
|
2 |
|
return $this->connection->upsert($sql, $bindings); |
113
|
|
|
} |
114
|
|
|
|
115
|
|
|
/** |
116
|
|
|
* @param string|int|array $values |
117
|
|
|
* |
118
|
|
|
* @return array |
119
|
|
|
*/ |
120
|
12 |
|
protected function detectValues($values): array |
121
|
|
|
{ |
122
|
12 |
|
if (!is_array(reset($values))) { |
123
|
12 |
|
$values = [$values]; |
124
|
|
|
} else { |
125
|
|
|
foreach ($values as $key => $value) { |
126
|
|
|
ksort($value); |
127
|
|
|
$values[$key] = $value; |
128
|
|
|
} |
129
|
|
|
} |
130
|
|
|
|
131
|
12 |
|
return $values; |
132
|
|
|
} |
133
|
|
|
} |
134
|
|
|
|
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.