Skip to content

Commit 483c831

Browse files
sudo-robotsudo-robot
committed
Api documentations update (Thu Jan 23 12:18:25 UTC 2025)
#apidocs
1 parent ebc6178 commit 483c831

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+7064
-2088
lines changed

‎api-docs/phpstorm-stubs/Couchbase.html

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,12 @@ <h2>Classes</h2>
129129
<div class="row">
130130
<div class="col-md-6">
131131
<a href="Couchbase/Bucket.html"><abbr title="Couchbase\Bucket">Bucket</abbr></a> </div>
132-
<div class="col-md-6"><p>Bucket is an object containing functionality for performing bucket level operations
133-
against a cluster and for access to scopes and collections.</p></div>
132+
<div class="col-md-6"><p>Represents connection to the Couchbase Server</p></div>
134133
</div>
135134
<div class="row">
136135
<div class="col-md-6">
137136
<a href="Couchbase/BucketManager.html"><abbr title="Couchbase\BucketManager">BucketManager</abbr></a> </div>
138-
<div class="col-md-6"></div>
137+
<div class="col-md-6"><p>Provides management capabilities for the Couchbase Bucket</p></div>
139138
</div>
140139
<div class="row">
141140
<div class="col-md-6">
@@ -150,8 +149,7 @@ <h2>Classes</h2>
150149
<div class="row">
151150
<div class="col-md-6">
152151
<a href="Couchbase/Cluster.html"><abbr title="Couchbase\Cluster">Cluster</abbr></a> </div>
153-
<div class="col-md-6"><p>Cluster is an object containing functionality for performing cluster level operations
154-
against a cluster and for access to buckets.</p></div>
152+
<div class="col-md-6"><p>Represents a Couchbase Server Cluster.</p></div>
155153
</div>
156154
<div class="row">
157155
<div class="col-md-6">
@@ -512,7 +510,7 @@ <h2>Classes</h2>
512510
<div class="row">
513511
<div class="col-md-6">
514512
<a href="Couchbase/MutationState.html"><abbr title="Couchbase\MutationState">MutationState</abbr></a> </div>
515-
<div class="col-md-6"><p>MutationState is an object which holds and aggregates mutation tokens across operations.</p></div>
513+
<div class="col-md-6"><p>Container for mutation tokens.</p></div>
516514
</div>
517515
<div class="row">
518516
<div class="col-md-6">

‎api-docs/phpstorm-stubs/Couchbase/BooleanFieldSearchQuery.html

Lines changed: 6 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ <h1>BooleanFieldSearchQuery
8686

8787

8888
<p> class
89-
<strong>BooleanFieldSearchQuery</strong> implements <a href="../JsonSerializable.html">JsonSerializable</a>, <a href="../Couchbase/SearchQuery.html"><abbr title="Couchbase\SearchQuery">SearchQuery</abbr></a> (<a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php">View source</a>)
89+
<strong>BooleanFieldSearchQuery</strong> implements <a href="../JsonSerializable.html">JsonSerializable</a>, <a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> (<a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php">View source</a>)
9090
</p>
9191

9292

@@ -109,16 +109,6 @@ <h2>Methods</h2>
109109
<div class="col-md-8">
110110
<a href="#method_jsonSerialize">jsonSerialize</a>()
111111

112-
<p><p>Specify data which should be serialized to JSON</p></p> </div>
113-
<div class="col-md-2"></div>
114-
</div>
115-
<div class="row">
116-
<div class="col-md-2 type">
117-
118-
</div>
119-
<div class="col-md-8">
120-
<a href="#method___construct">__construct</a>(bool $arg)
121-
122112
<p class="no-description">No description</p>
123113
</div>
124114
<div class="col-md-2"></div>
@@ -153,7 +143,7 @@ <h2>Details</h2>
153143
<div id="method-details">
154144
<div class="method-item">
155145
<h3 id="method_jsonSerialize">
156-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2387">at line 2387</a></div>
146+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2780">at line 2780</a></div>
157147
<code> mixed
158148
<strong>jsonSerialize</strong>()
159149
</code>
@@ -163,7 +153,8 @@ <h3 id="method_jsonSerialize">
163153

164154

165155
<div class="method-description">
166-
<p><p>Specify data which should be serialized to JSON</p></p>
156+
<p class="no-description">No description</p>
157+
167158
</div>
168159
<div class="tags">
169160

@@ -180,47 +171,13 @@ <h4>Return Value</h4>
180171

181172

182173

183-
</div>
184-
</div>
185-
186-
</div>
187-
<div class="method-item">
188-
<h3 id="method___construct">
189-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2389">at line 2389</a></div>
190-
<code>
191-
<strong>__construct</strong>(bool $arg)
192-
</code>
193-
</h3>
194-
<div class="details">
195-
196-
197-
198-
<div class="method-description">
199-
<p class="no-description">No description</p>
200-
201-
</div>
202-
<div class="tags">
203-
<h4>Parameters</h4>
204-
205-
<table class="table table-condensed">
206-
<tr>
207-
<td>bool</td>
208-
<td>$arg</td>
209-
<td></td>
210-
</tr>
211-
</table>
212-
213-
214-
215-
216-
217174
</div>
218175
</div>
219176

220177
</div>
221178
<div class="method-item">
222179
<h3 id="method_boost">
223-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2395">at line 2395</a></div>
180+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2786">at line 2786</a></div>
224181
<code> <a href="../Couchbase/BooleanFieldSearchQuery.html"><abbr title="Couchbase\BooleanFieldSearchQuery">BooleanFieldSearchQuery</abbr></a>
225182
<strong>boost</strong>(float $boost)
226183
</code>
@@ -263,7 +220,7 @@ <h4>Return Value</h4>
263220
</div>
264221
<div class="method-item">
265222
<h3 id="method_field">
266-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2401">at line 2401</a></div>
223+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2792">at line 2792</a></div>
267224
<code> <a href="../Couchbase/BooleanFieldSearchQuery.html"><abbr title="Couchbase\BooleanFieldSearchQuery">BooleanFieldSearchQuery</abbr></a>
268225
<strong>field</strong>(string $field)
269226
</code>

‎api-docs/phpstorm-stubs/Couchbase/BooleanSearchQuery.html

Lines changed: 20 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ <h1>BooleanSearchQuery
8686

8787

8888
<p> class
89-
<strong>BooleanSearchQuery</strong> implements <a href="../JsonSerializable.html">JsonSerializable</a>, <a href="../Couchbase/SearchQuery.html"><abbr title="Couchbase\SearchQuery">SearchQuery</abbr></a> (<a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php">View source</a>)
89+
<strong>BooleanSearchQuery</strong> implements <a href="../JsonSerializable.html">JsonSerializable</a>, <a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> (<a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php">View source</a>)
9090
</p>
9191

9292

@@ -109,16 +109,6 @@ <h2>Methods</h2>
109109
<div class="col-md-8">
110110
<a href="#method_jsonSerialize">jsonSerialize</a>()
111111

112-
<p><p>Specify data which should be serialized to JSON</p></p> </div>
113-
<div class="col-md-2"></div>
114-
</div>
115-
<div class="row">
116-
<div class="col-md-2 type">
117-
118-
</div>
119-
<div class="col-md-8">
120-
<a href="#method___construct">__construct</a>()
121-
122112
<p class="no-description">No description</p>
123113
</div>
124114
<div class="col-md-2"></div>
@@ -139,7 +129,7 @@ <h2>Methods</h2>
139129
<a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
140130
</div>
141131
<div class="col-md-8">
142-
<a href="#method_must">must</a>(<a href="../Couchbase/ConjunctionSearchQuery.html"><abbr title="Couchbase\ConjunctionSearchQuery">ConjunctionSearchQuery</abbr></a> $query)
132+
<a href="#method_must">must</a>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
143133

144134
<p class="no-description">No description</p>
145135
</div>
@@ -150,7 +140,7 @@ <h2>Methods</h2>
150140
<a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
151141
</div>
152142
<div class="col-md-8">
153-
<a href="#method_mustNot">mustNot</a>(<a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a> $query)
143+
<a href="#method_mustNot">mustNot</a>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
154144

155145
<p class="no-description">No description</p>
156146
</div>
@@ -161,7 +151,7 @@ <h2>Methods</h2>
161151
<a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
162152
</div>
163153
<div class="col-md-8">
164-
<a href="#method_should">should</a>(<a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a> $query)
154+
<a href="#method_should">should</a>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
165155

166156
<p class="no-description">No description</p>
167157
</div>
@@ -175,7 +165,7 @@ <h2>Details</h2>
175165
<div id="method-details">
176166
<div class="method-item">
177167
<h3 id="method_jsonSerialize">
178-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2409">at line 2409</a></div>
168+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2805">at line 2805</a></div>
179169
<code> mixed
180170
<strong>jsonSerialize</strong>()
181171
</code>
@@ -185,7 +175,8 @@ <h3 id="method_jsonSerialize">
185175

186176

187177
<div class="method-description">
188-
<p><p>Specify data which should be serialized to JSON</p></p>
178+
<p class="no-description">No description</p>
179+
189180
</div>
190181
<div class="tags">
191182

@@ -202,37 +193,13 @@ <h4>Return Value</h4>
202193

203194

204195

205-
</div>
206-
</div>
207-
208-
</div>
209-
<div class="method-item">
210-
<h3 id="method___construct">
211-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2411">at line 2411</a></div>
212-
<code>
213-
<strong>__construct</strong>()
214-
</code>
215-
</h3>
216-
<div class="details">
217-
218-
219-
220-
<div class="method-description">
221-
<p class="no-description">No description</p>
222-
223-
</div>
224-
<div class="tags">
225-
226-
227-
228-
229196
</div>
230197
</div>
231198

232199
</div>
233200
<div class="method-item">
234201
<h3 id="method_boost">
235-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2417">at line 2417</a></div>
202+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2811">at line 2811</a></div>
236203
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
237204
<strong>boost</strong>(float $boost)
238205
</code>
@@ -275,9 +242,9 @@ <h4>Return Value</h4>
275242
</div>
276243
<div class="method-item">
277244
<h3 id="method_must">
278-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2423">at line 2423</a></div>
245+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2817">at line 2817</a></div>
279246
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
280-
<strong>must</strong>(<a href="../Couchbase/ConjunctionSearchQuery.html"><abbr title="Couchbase\ConjunctionSearchQuery">ConjunctionSearchQuery</abbr></a> $query)
247+
<strong>must</strong>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
281248
</code>
282249
</h3>
283250
<div class="details">
@@ -293,8 +260,8 @@ <h4>Parameters</h4>
293260

294261
<table class="table table-condensed">
295262
<tr>
296-
<td><a href="../Couchbase/ConjunctionSearchQuery.html"><abbr title="Couchbase\ConjunctionSearchQuery">ConjunctionSearchQuery</abbr></a></td>
297-
<td>$query</td>
263+
<td><a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a></td>
264+
<td>...$queries</td>
298265
<td></td>
299266
</tr>
300267
</table>
@@ -318,9 +285,9 @@ <h4>Return Value</h4>
318285
</div>
319286
<div class="method-item">
320287
<h3 id="method_mustNot">
321-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2429">at line 2429</a></div>
288+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2823">at line 2823</a></div>
322289
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
323-
<strong>mustNot</strong>(<a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a> $query)
290+
<strong>mustNot</strong>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
324291
</code>
325292
</h3>
326293
<div class="details">
@@ -336,8 +303,8 @@ <h4>Parameters</h4>
336303

337304
<table class="table table-condensed">
338305
<tr>
339-
<td><a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a></td>
340-
<td>$query</td>
306+
<td><a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a></td>
307+
<td>...$queries</td>
341308
<td></td>
342309
</tr>
343310
</table>
@@ -361,9 +328,9 @@ <h4>Return Value</h4>
361328
</div>
362329
<div class="method-item">
363330
<h3 id="method_should">
364-
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2435">at line 2435</a></div>
331+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2829">at line 2829</a></div>
365332
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
366-
<strong>should</strong>(<a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a> $query)
333+
<strong>should</strong>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
367334
</code>
368335
</h3>
369336
<div class="details">
@@ -379,8 +346,8 @@ <h4>Parameters</h4>
379346

380347
<table class="table table-condensed">
381348
<tr>
382-
<td><a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a></td>
383-
<td>$query</td>
349+
<td><a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a></td>
350+
<td>...$queries</td>
384351
<td></td>
385352
</tr>
386353
</table>

0 commit comments

Comments
 (0)