|
1
|
|
|
<?php |
|
2
|
|
|
/* |
|
3
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
4
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
5
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
6
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
|
7
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
8
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
9
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
10
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
11
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
12
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
13
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
14
|
|
|
*/ |
|
15
|
|
|
|
|
16
|
|
|
namespace Alcaeus\MongoDbAdapter\Helper; |
|
17
|
|
|
|
|
18
|
|
|
/** |
|
19
|
|
|
* @internal |
|
20
|
|
|
*/ |
|
21
|
|
|
trait ReadPreference |
|
22
|
|
|
{ |
|
23
|
|
|
/** |
|
24
|
|
|
* @var \MongoDB\Driver\ReadPreference |
|
25
|
|
|
*/ |
|
26
|
|
|
protected $readPreference; |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* @param string $readPreference |
|
30
|
|
|
* @param array $tags |
|
31
|
|
|
* @return bool |
|
32
|
|
|
*/ |
|
33
|
|
|
abstract public function setReadPreference($readPreference, $tags = null); |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* @return array |
|
37
|
|
|
*/ |
|
38
|
|
|
public function getReadPreference() |
|
39
|
|
|
{ |
|
40
|
|
|
if ($this->readPreference === null) { |
|
41
|
|
|
$this->readPreference = new \MongoDB\Driver\ReadPreference(\MongoDB\Driver\ReadPreference::RP_PRIMARY); |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
|
|
$mode = $this->readPreference->getMode(); |
|
45
|
|
|
|
|
46
|
|
|
switch ($mode) { |
|
47
|
|
|
case \MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED: |
|
48
|
|
|
$type = \MongoClient::RP_PRIMARY_PREFERRED; |
|
49
|
|
|
break; |
|
50
|
|
|
case \MongoDB\Driver\ReadPreference::RP_SECONDARY: |
|
51
|
|
|
$type = \MongoClient::RP_SECONDARY; |
|
52
|
|
|
break; |
|
53
|
|
|
case \MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED: |
|
54
|
|
|
$type = \MongoClient::RP_SECONDARY_PREFERRED; |
|
55
|
|
|
break; |
|
56
|
|
|
case \MongoDB\Driver\ReadPreference::RP_NEAREST: |
|
57
|
|
|
$type = \MongoClient::RP_NEAREST; |
|
58
|
|
|
break; |
|
59
|
|
|
default: |
|
60
|
|
|
$type = \MongoClient::RP_PRIMARY; |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
$readPreference = ['type' => $type]; |
|
64
|
|
|
if ($this->readPreference->getTagSets() !== null && $this->readPreference->getTagSets() !== []) { |
|
65
|
|
|
$readPreference['tagsets'] = $this->readPreference->getTagSets(); |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
return $readPreference; |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* @return bool |
|
73
|
|
|
*/ |
|
74
|
|
|
protected function getSlaveOkayFromReadPreference() |
|
75
|
|
|
{ |
|
76
|
|
|
return $this->readPreference->getMode() != \MongoDB\Driver\ReadPreference::RP_PRIMARY; |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* @param string $readPreference |
|
81
|
|
|
* @param array $tags |
|
82
|
|
|
* @return bool |
|
83
|
|
|
*/ |
|
84
|
|
|
protected function setReadPreferenceFromParameters($readPreference, $tags = null) |
|
85
|
|
|
{ |
|
86
|
|
|
// @internal Passing an array for $readPreference is necessary to avoid conversion voodoo |
|
87
|
|
|
// It should not be used externally! |
|
88
|
|
|
if (is_array($readPreference)) { |
|
89
|
|
|
return $this->setReadPreferenceFromArray($readPreference); |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
switch ($readPreference) { |
|
93
|
|
|
case \MongoClient::RP_PRIMARY: |
|
94
|
|
|
$mode = \MongoDB\Driver\ReadPreference::RP_PRIMARY; |
|
95
|
|
|
break; |
|
96
|
|
|
case \MongoClient::RP_PRIMARY_PREFERRED: |
|
97
|
|
|
$mode = \MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED; |
|
98
|
|
|
break; |
|
99
|
|
|
case \MongoClient::RP_SECONDARY: |
|
100
|
|
|
$mode = \MongoDB\Driver\ReadPreference::RP_SECONDARY; |
|
101
|
|
|
break; |
|
102
|
|
|
case \MongoClient::RP_SECONDARY_PREFERRED: |
|
103
|
|
|
$mode = \MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED; |
|
104
|
|
|
break; |
|
105
|
|
|
case \MongoClient::RP_NEAREST: |
|
106
|
|
|
$mode = \MongoDB\Driver\ReadPreference::RP_NEAREST; |
|
107
|
|
|
break; |
|
108
|
|
|
default: |
|
109
|
|
|
trigger_error("The value '$readPreference' is not valid as read preference type", E_USER_WARNING); |
|
110
|
|
|
return false; |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
|
|
if ($readPreference == \MongoClient::RP_PRIMARY && !empty($tags)) { |
|
114
|
|
|
trigger_error("You can't use read preference tags with a read preference of PRIMARY", E_USER_WARNING); |
|
115
|
|
|
return false; |
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
$this->readPreference = new \MongoDB\Driver\ReadPreference($mode, $tags); |
|
119
|
|
|
|
|
120
|
|
|
return true; |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
/** |
|
124
|
|
|
* @param array $readPreferenceArray |
|
125
|
|
|
* @return bool |
|
126
|
|
|
*/ |
|
127
|
|
|
protected function setReadPreferenceFromArray($readPreferenceArray) |
|
128
|
|
|
{ |
|
129
|
|
|
$readPreference = $readPreferenceArray['type']; |
|
130
|
|
|
$tags = isset($readPreferenceArray['tagsets']) ? $readPreferenceArray['tagsets'] : []; |
|
131
|
|
|
|
|
132
|
|
|
return $this->setReadPreferenceFromParameters($readPreference, $tags); |
|
133
|
|
|
} |
|
134
|
|
|
|
|
135
|
|
|
/** |
|
136
|
|
|
* @param bool $ok |
|
137
|
|
|
* @return bool |
|
138
|
|
|
*/ |
|
139
|
|
|
protected function setReadPreferenceFromSlaveOkay($ok = true) |
|
140
|
|
|
{ |
|
141
|
|
|
$result = $this->getSlaveOkayFromReadPreference(); |
|
142
|
|
|
$readPreference = new \MongoDB\Driver\ReadPreference( |
|
143
|
|
|
$ok ? \MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED : \MongoDB\Driver\ReadPreference::RP_PRIMARY, |
|
144
|
|
|
$ok ? $this->readPreference->getTagSets() : [] |
|
145
|
|
|
); |
|
146
|
|
|
|
|
147
|
|
|
$this->readPreference = $readPreference; |
|
148
|
|
|
|
|
149
|
|
|
return $result; |
|
150
|
|
|
} |
|
151
|
|
|
} |
|
152
|
|
|
|
alcaeus /
mongo-php-adapter
