Skip to content

Commit

Permalink
Api documentations update (Thu Sep 5 12:17:24 UTC 2024)
Browse files Browse the repository at this point in the history 
#apidocs
  • Loading branch information
@sudo-robot
sudo-robot committed Sep 5, 2024
1 parent 494e88c commit 9c37f84
Show file tree
Hide file tree
Showing 45 changed files with 2,096 additions and 7,068 deletions.
10 changes: 6 additions & 4 deletions api-docs/phpstorm-stubs/Couchbase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,13 @@ <h2>Classes</h2>
<div class="row">
<div class="col-md-6">
<a href="Couchbase/Bucket.html"><abbr title="Couchbase\Bucket">Bucket</abbr></a> </div>
<div class="col-md-6"><p>Represents connection to the Couchbase Server</p></div>
<div class="col-md-6"><p>Bucket is an object containing functionality for performing bucket level operations
against a cluster and for access to scopes and collections.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="Couchbase/BucketManager.html"><abbr title="Couchbase\BucketManager">BucketManager</abbr></a> </div>
<div class="col-md-6"><p>Provides management capabilities for the Couchbase Bucket</p></div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
Expand All @@ -149,7 +150,8 @@ <h2>Classes</h2>
<div class="row">
<div class="col-md-6">
<a href="Couchbase/Cluster.html"><abbr title="Couchbase\Cluster">Cluster</abbr></a> </div>
<div class="col-md-6"><p>Represents a Couchbase Server Cluster.</p></div>
<div class="col-md-6"><p>Cluster is an object containing functionality for performing cluster level operations
against a cluster and for access to buckets.</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down Expand Up @@ -510,7 +512,7 @@ <h2>Classes</h2>
<div class="row">
<div class="col-md-6">
<a href="Couchbase/MutationState.html"><abbr title="Couchbase\MutationState">MutationState</abbr></a> </div>
<div class="col-md-6"><p>Container for mutation tokens.</p></div>
<div class="col-md-6"><p>MutationState is an object which holds and aggregates mutation tokens across operations.</p></div>
</div>
<div class="row">
<div class="col-md-6">
Expand Down
55 changes: 49 additions & 6 deletions api-docs/phpstorm-stubs/Couchbase/BooleanFieldSearchQuery.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h1>BooleanFieldSearchQuery


<p> class
<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>)
<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>)
</p>


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

<p><p>Specify data which should be serialized to JSON</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">

</div>
<div class="col-md-8">
<a href="#method___construct">__construct</a>(bool $arg)

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
Expand Down Expand Up @@ -143,7 +153,7 @@ <h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_jsonSerialize">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2780">at line 2780</a></div>
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2387">at line 2387</a></div>
<code> mixed
<strong>jsonSerialize</strong>()
</code>
Expand All @@ -153,8 +163,7 @@ <h3 id="method_jsonSerialize">


<div class="method-description">
<p class="no-description">No description</p>

<p><p>Specify data which should be serialized to JSON</p></p>
</div>
<div class="tags">

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



</div>
</div>

</div>
<div class="method-item">
<h3 id="method___construct">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2389">at line 2389</a></div>
<code>
<strong>__construct</strong>(bool $arg)
</code>
</h3>
<div class="details">



<div class="method-description">
<p class="no-description">No description</p>

</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>bool</td>
<td>$arg</td>
<td></td>
</tr>
</table>





</div>
</div>

</div>
<div class="method-item">
<h3 id="method_boost">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2786">at line 2786</a></div>
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2395">at line 2395</a></div>
<code> <a href="../Couchbase/BooleanFieldSearchQuery.html"><abbr title="Couchbase\BooleanFieldSearchQuery">BooleanFieldSearchQuery</abbr></a>
<strong>boost</strong>(float $boost)
</code>
Expand Down Expand Up @@ -220,7 +263,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_field">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2792">at line 2792</a></div>
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2401">at line 2401</a></div>
<code> <a href="../Couchbase/BooleanFieldSearchQuery.html"><abbr title="Couchbase\BooleanFieldSearchQuery">BooleanFieldSearchQuery</abbr></a>
<strong>field</strong>(string $field)
</code>
Expand Down
73 changes: 53 additions & 20 deletions api-docs/phpstorm-stubs/Couchbase/BooleanSearchQuery.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h1>BooleanSearchQuery


<p> class
<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>)
<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>)
</p>


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

<p><p>Specify data which should be serialized to JSON</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">

</div>
<div class="col-md-8">
<a href="#method___construct">__construct</a>()

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
Expand All @@ -129,7 +139,7 @@ <h2>Methods</h2>
<a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
</div>
<div class="col-md-8">
<a href="#method_must">must</a>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
<a href="#method_must">must</a>(<a href="../Couchbase/ConjunctionSearchQuery.html"><abbr title="Couchbase\ConjunctionSearchQuery">ConjunctionSearchQuery</abbr></a> $query)

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

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

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


<div class="method-description">
<p class="no-description">No description</p>

<p><p>Specify data which should be serialized to JSON</p></p>
</div>
<div class="tags">

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



</div>
</div>

</div>
<div class="method-item">
<h3 id="method___construct">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2411">at line 2411</a></div>
<code>
<strong>__construct</strong>()
</code>
</h3>
<div class="details">



<div class="method-description">
<p class="no-description">No description</p>

</div>
<div class="tags">




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_boost">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2811">at line 2811</a></div>
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2417">at line 2417</a></div>
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
<strong>boost</strong>(float $boost)
</code>
Expand Down Expand Up @@ -242,9 +275,9 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_must">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2817">at line 2817</a></div>
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2423">at line 2423</a></div>
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
<strong>must</strong>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
<strong>must</strong>(<a href="../Couchbase/ConjunctionSearchQuery.html"><abbr title="Couchbase\ConjunctionSearchQuery">ConjunctionSearchQuery</abbr></a> $query)
</code>
</h3>
<div class="details">
Expand All @@ -260,8 +293,8 @@ <h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td><a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a></td>
<td>...$queries</td>
<td><a href="../Couchbase/ConjunctionSearchQuery.html"><abbr title="Couchbase\ConjunctionSearchQuery">ConjunctionSearchQuery</abbr></a></td>
<td>$query</td>
<td></td>
</tr>
</table>
Expand All @@ -285,9 +318,9 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_mustNot">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2823">at line 2823</a></div>
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2429">at line 2429</a></div>
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
<strong>mustNot</strong>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
<strong>mustNot</strong>(<a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a> $query)
</code>
</h3>
<div class="details">
Expand All @@ -303,8 +336,8 @@ <h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td><a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a></td>
<td>...$queries</td>
<td><a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a></td>
<td>$query</td>
<td></td>
</tr>
</table>
Expand All @@ -328,9 +361,9 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_should">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase_v2/couchbase.php#L2829">at line 2829</a></div>
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L2435">at line 2435</a></div>
<code> <a href="../Couchbase/BooleanSearchQuery.html"><abbr title="Couchbase\BooleanSearchQuery">BooleanSearchQuery</abbr></a>
<strong>should</strong>(<a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a> ...$queries)
<strong>should</strong>(<a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a> $query)
</code>
</h3>
<div class="details">
Expand All @@ -346,8 +379,8 @@ <h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td><a href="../Couchbase/SearchQueryPart.html"><abbr title="Couchbase\SearchQueryPart">SearchQueryPart</abbr></a></td>
<td>...$queries</td>
<td><a href="../Couchbase/DisjunctionSearchQuery.html"><abbr title="Couchbase\DisjunctionSearchQuery">DisjunctionSearchQuery</abbr></a></td>
<td>$query</td>
<td></td>
</tr>
</table>
Expand Down
Loading

0 comments on commit 9c37f84

Please sign in to comment.