Skip to content

Commit f984ff2

Browse files
weakishweakish
committed
docs: update api doc
1 parent e9f2fdb commit f984ff2

File tree

6 files changed

+839
-688
lines changed

6 files changed

+839
-688
lines changed

‎Hacking.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@
3030
vendor/bin/phpunit --filter testInitializeWithString test/QueryTest.php
3131
```
3232

33-
* `make doc` to build documentation (should running on PHP < 7.2)
33+
* `make doc` to build documentation.
34+
The make task uses PHP 5.6, to install it on recent versions of macOS,
35+
see https://github.com/eXolnet/homebrew-deprecated/pull/25
3436

3537
* Send a pull request at leancloud/php-sdk
3638

‎docs/class-LeanCloud.Client.html‎

Lines changed: 62 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ <h1>Class Client</h1>
139139
<b>Namespace:</b> <a href="namespace-LeanCloud.html">LeanCloud</a><br>
140140

141141

142-
<b>Located at</b> <a href="source-class-LeanCloud.Client.html#15-718" title="Go to source code">LeanCloud/Client.php</a>
142+
<b>Located at</b> <a href="source-class-LeanCloud.Client.html#15-729" title="Go to source code">LeanCloud/Client.php</a>
143143
<br>
144144
</div>
145145

@@ -183,6 +183,43 @@ <h4>Parameters</h4>
183183

184184

185185

186+
</div>
187+
</div></td>
188+
</tr>
189+
<tr data-order="setApiTimeout" id="_setApiTimeout">
190+
191+
<td class="attributes"><code>
192+
public static
193+
194+
195+
196+
</code>
197+
</td>
198+
199+
<td class="name"><div>
200+
<a class="anchor" href="#_setApiTimeout">#</a>
201+
<code><a href="source-class-LeanCloud.Client.html#137-146" title="Go to source code">setApiTimeout</a>( <span>integer <var>$seconds</var></span> )</code>
202+
203+
<div class="description short">
204+
<p>Set a deadline for requests to complete.</p>
205+
</div>
206+
207+
<div class="description detailed hidden">
208+
<p>Set a deadline for requests to complete.</p>
209+
210+
<p>Note that file upload requests are not affected.</p>
211+
212+
213+
<h4>Parameters</h4>
214+
<div class="list"><dl>
215+
<dt><var>$seconds</var></dt>
216+
<dd></dd>
217+
</dl></div>
218+
219+
220+
221+
222+
186223
</div>
187224
</div></td>
188225
</tr>
@@ -198,7 +235,7 @@ <h4>Parameters</h4>
198235

199236
<td class="name"><div>
200237
<a class="anchor" href="#_getVersionString">#</a>
201-
<code><a href="source-class-LeanCloud.Client.html#152-159" title="Go to source code">getVersionString</a>( )</code>
238+
<code><a href="source-class-LeanCloud.Client.html#163-170" title="Go to source code">getVersionString</a>( )</code>
202239

203240
<div class="description short">
204241
<p>Get version string used as user agent</p>
@@ -232,7 +269,7 @@ <h4>Returns</h4>
232269

233270
<td class="name"><div>
234271
<a class="anchor" href="#_useRegion">#</a>
235-
<code><a href="source-class-LeanCloud.Client.html#161-171" title="Go to source code">useRegion</a>( <span>mixed <var>$region</var></span> )</code>
272+
<code><a href="source-class-LeanCloud.Client.html#172-182" title="Go to source code">useRegion</a>( <span>mixed <var>$region</var></span> )</code>
236273

237274
<div class="description short">
238275
<p>Set API region</p>
@@ -269,7 +306,7 @@ <h4>Parameters</h4>
269306

270307
<td class="name"><div>
271308
<a class="anchor" href="#_useProduction">#</a>
272-
<code><a href="source-class-LeanCloud.Client.html#173-180" title="Go to source code">useProduction</a>( <span>boolean <var>$flag</var></span> )</code>
309+
<code><a href="source-class-LeanCloud.Client.html#184-191" title="Go to source code">useProduction</a>( <span>boolean <var>$flag</var></span> )</code>
273310

274311
<div class="description short">
275312
<p>Use production or not</p>
@@ -304,7 +341,7 @@ <h4>Parameters</h4>
304341

305342
<td class="name"><div>
306343
<a class="anchor" href="#_setDebug">#</a>
307-
<code><a href="source-class-LeanCloud.Client.html#182-191" title="Go to source code">setDebug</a>( <span>boolean <var>$flag</var></span> )</code>
344+
<code><a href="source-class-LeanCloud.Client.html#193-202" title="Go to source code">setDebug</a>( <span>boolean <var>$flag</var></span> )</code>
308345

309346
<div class="description short">
310347
<p>Set debug mode</p>
@@ -341,7 +378,7 @@ <h4>Parameters</h4>
341378

342379
<td class="name"><div>
343380
<a class="anchor" href="#_useMasterKey">#</a>
344-
<code><a href="source-class-LeanCloud.Client.html#193-200" title="Go to source code">useMasterKey</a>( <span>boolean <var>$flag</var></span> )</code>
381+
<code><a href="source-class-LeanCloud.Client.html#204-211" title="Go to source code">useMasterKey</a>( <span>boolean <var>$flag</var></span> )</code>
345382

346383
<div class="description short">
347384
<p>Use master key or not</p>
@@ -376,7 +413,7 @@ <h4>Parameters</h4>
376413

377414
<td class="name"><div>
378415
<a class="anchor" href="#_setServerUrl">#</a>
379-
<code><a href="source-class-LeanCloud.Client.html#202-212" title="Go to source code">setServerUrl</a>( <span>string <var>$url</var></span> )</code>
416+
<code><a href="source-class-LeanCloud.Client.html#213-223" title="Go to source code">setServerUrl</a>( <span>string <var>$url</var></span> )</code>
380417

381418
<div class="description short">
382419
<p>Set server url</p>
@@ -414,7 +451,7 @@ <h4>Parameters</h4>
414451

415452
<td class="name"><div>
416453
<a class="anchor" href="#_getAPIEndPoint">#</a>
417-
<code><a href="source-class-LeanCloud.Client.html#214-231" title="Go to source code">getAPIEndPoint</a>( )</code>
454+
<code><a href="source-class-LeanCloud.Client.html#225-242" title="Go to source code">getAPIEndPoint</a>( )</code>
418455

419456
<div class="description short">
420457
<p>Get API Endpoint</p>
@@ -451,7 +488,7 @@ <h4>Returns</h4>
451488

452489
<td class="name"><div>
453490
<a class="anchor" href="#_buildHeaders">#</a>
454-
<code><a href="source-class-LeanCloud.Client.html#233-266" title="Go to source code">buildHeaders</a>( <span>string <var>$sessionToken</var></span>, <span>boolean <var>$useMasterKey</var></span> )</code>
491+
<code><a href="source-class-LeanCloud.Client.html#244-277" title="Go to source code">buildHeaders</a>( <span>string <var>$sessionToken</var></span>, <span>boolean <var>$useMasterKey</var></span> )</code>
455492

456493
<div class="description short">
457494
<p>Build authentication headers</p>
@@ -492,7 +529,7 @@ <h4>Returns</h4>
492529

493530
<td class="name"><div>
494531
<a class="anchor" href="#_verifySign">#</a>
495-
<code><a href="source-class-LeanCloud.Client.html#268-288" title="Go to source code">verifySign</a>( <span>string <var>$appId</var></span>, <span>string <var>$sign</var></span> )</code>
532+
<code><a href="source-class-LeanCloud.Client.html#279-299" title="Go to source code">verifySign</a>( <span>string <var>$appId</var></span>, <span>string <var>$sign</var></span> )</code>
496533

497534
<div class="description short">
498535
<p>Verify app ID and sign</p>
@@ -536,7 +573,7 @@ <h4>Returns</h4>
536573

537574
<td class="name"><div>
538575
<a class="anchor" href="#_verifyKey">#</a>
539-
<code><a href="source-class-LeanCloud.Client.html#290-309" title="Go to source code">verifyKey</a>( <span>string <var>$appId</var></span>, <span>string <var>$key</var></span> )</code>
576+
<code><a href="source-class-LeanCloud.Client.html#301-320" title="Go to source code">verifyKey</a>( <span>string <var>$appId</var></span>, <span>string <var>$key</var></span> )</code>
540577

541578
<div class="description short">
542579
<p>Verify app ID and key</p>
@@ -580,7 +617,7 @@ <h4>Returns</h4>
580617

581618
<td class="name"><div>
582619
<a class="anchor" href="#_signHook">#</a>
583-
<code><a href="source-class-LeanCloud.Client.html#311-321" title="Go to source code">signHook</a>( <span>string <var>$hookName</var></span>, <span>integer <var>$msec</var></span> )</code>
620+
<code><a href="source-class-LeanCloud.Client.html#322-332" title="Go to source code">signHook</a>( <span>string <var>$hookName</var></span>, <span>integer <var>$msec</var></span> )</code>
584621

585622
<div class="description short">
586623
<p>Generate a sign used to auth hook invocation on LeanEngine</p>
@@ -621,7 +658,7 @@ <h4>Returns</h4>
621658

622659
<td class="name"><div>
623660
<a class="anchor" href="#_verifyHookSign">#</a>
624-
<code><a href="source-class-LeanCloud.Client.html#323-337" title="Go to source code">verifyHookSign</a>( <span>string <var>$hookName</var></span>, <span>string <var>$sign</var></span> )</code>
661+
<code><a href="source-class-LeanCloud.Client.html#334-348" title="Go to source code">verifyHookSign</a>( <span>string <var>$hookName</var></span>, <span>string <var>$sign</var></span> )</code>
625662

626663
<div class="description short">
627664
<p>Verify a signed hook</p>
@@ -662,7 +699,7 @@ <h4>Returns</h4>
662699

663700
<td class="name"><div>
664701
<a class="anchor" href="#_request">#</a>
665-
<code><a href="source-class-LeanCloud.Client.html#339-449" title="Go to source code">request</a>( <span>string <var>$method</var></span>, <span>string <var>$path</var></span>, <span>array <var>$data</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
702+
<code><a href="source-class-LeanCloud.Client.html#350-460" title="Go to source code">request</a>( <span>string <var>$method</var></span>, <span>string <var>$path</var></span>, <span>array <var>$data</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
666703

667704
<div class="description short">
668705
<p>Issue request to LeanCloud</p>
@@ -722,7 +759,7 @@ <h4>Throws</h4>
722759

723760
<td class="name"><div>
724761
<a class="anchor" href="#_get">#</a>
725-
<code><a href="source-class-LeanCloud.Client.html#451-466" title="Go to source code">get</a>( <span>string <var>$path</var></span>, <span>array <var>$data</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
762+
<code><a href="source-class-LeanCloud.Client.html#462-477" title="Go to source code">get</a>( <span>string <var>$path</var></span>, <span>array <var>$data</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
726763

727764
<div class="description short">
728765
<p>Issue GET request to LeanCloud</p>
@@ -773,7 +810,7 @@ <h4>See</h4>
773810

774811
<td class="name"><div>
775812
<a class="anchor" href="#_post">#</a>
776-
<code><a href="source-class-LeanCloud.Client.html#468-483" title="Go to source code">post</a>( <span>string <var>$path</var></span>, <span>array <var>$data</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
813+
<code><a href="source-class-LeanCloud.Client.html#479-494" title="Go to source code">post</a>( <span>string <var>$path</var></span>, <span>array <var>$data</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
777814

778815
<div class="description short">
779816
<p>Issue POST request to LeanCloud</p>
@@ -824,7 +861,7 @@ <h4>See</h4>
824861

825862
<td class="name"><div>
826863
<a class="anchor" href="#_put">#</a>
827-
<code><a href="source-class-LeanCloud.Client.html#485-500" title="Go to source code">put</a>( <span>string <var>$path</var></span>, <span>array <var>$data</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
864+
<code><a href="source-class-LeanCloud.Client.html#496-511" title="Go to source code">put</a>( <span>string <var>$path</var></span>, <span>array <var>$data</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
828865

829866
<div class="description short">
830867
<p>Issue PUT request to LeanCloud</p>
@@ -875,7 +912,7 @@ <h4>See</h4>
875912

876913
<td class="name"><div>
877914
<a class="anchor" href="#_delete">#</a>
878-
<code><a href="source-class-LeanCloud.Client.html#502-516" title="Go to source code">delete</a>( <span>string <var>$path</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
915+
<code><a href="source-class-LeanCloud.Client.html#513-527" title="Go to source code">delete</a>( <span>string <var>$path</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
879916

880917
<div class="description short">
881918
<p>Issue DELETE request to LeanCloud</p>
@@ -924,7 +961,7 @@ <h4>See</h4>
924961

925962
<td class="name"><div>
926963
<a class="anchor" href="#_batch">#</a>
927-
<code><a href="source-class-LeanCloud.Client.html#518-548" title="Go to source code">batch</a>( <span>array <var>$requests</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
964+
<code><a href="source-class-LeanCloud.Client.html#529-559" title="Go to source code">batch</a>( <span>array <var>$requests</var></span>, <span>string <var>$sessionToken</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$headers</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$useMasterKey</var> = <span class="php-keyword1">null</span></span> )</code>
928965

929966
<div class="description short">
930967
<p>Issue a batch request</p>
@@ -973,7 +1010,7 @@ <h4>See</h4>
9731010

9741011
<td class="name"><div>
9751012
<a class="anchor" href="#_encode">#</a>
976-
<code><a href="source-class-LeanCloud.Client.html#550-611" title="Go to source code">encode</a>( <span>mixed <var>$value</var></span>, <span>string <var>$encoder</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$seen</var> = <span class="php-keyword1">array</span>()</span> )</code>
1013+
<code><a href="source-class-LeanCloud.Client.html#561-622" title="Go to source code">encode</a>( <span>mixed <var>$value</var></span>, <span>string <var>$encoder</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$seen</var> = <span class="php-keyword1">array</span>()</span> )</code>
9771014

9781015
<div class="description short">
9791016
<p>Recursively encode value as JSON representation</p>
@@ -1034,7 +1071,7 @@ <h4>Returns</h4>
10341071

10351072
<td class="name"><div>
10361073
<a class="anchor" href="#_formatDate">#</a>
1037-
<code><a href="source-class-LeanCloud.Client.html#613-627" title="Go to source code">formatDate</a>( <span>DateTime <var>$date</var></span> )</code>
1074+
<code><a href="source-class-LeanCloud.Client.html#624-638" title="Go to source code">formatDate</a>( <span>DateTime <var>$date</var></span> )</code>
10381075

10391076
<div class="description short">
10401077
<p>Format date according to LeanCloud spec.</p>
@@ -1073,7 +1110,7 @@ <h4>Returns</h4>
10731110

10741111
<td class="name"><div>
10751112
<a class="anchor" href="#_decode">#</a>
1076-
<code><a href="source-class-LeanCloud.Client.html#629-684" title="Go to source code">decode</a>( <span>mixed <var>$value</var></span>, <span>string <var>$key</var></span> )</code>
1113+
<code><a href="source-class-LeanCloud.Client.html#640-695" title="Go to source code">decode</a>( <span>mixed <var>$value</var></span>, <span>string <var>$key</var></span> )</code>
10771114

10781115
<div class="description short">
10791116
<p>Decode value from LeanCloud response.</p>
@@ -1114,7 +1151,7 @@ <h4>Returns</h4>
11141151

11151152
<td class="name"><div>
11161153
<a class="anchor" href="#_getStorage">#</a>
1117-
<code><a href="source-class-LeanCloud.Client.html#686-693" title="Go to source code">getStorage</a>( )</code>
1154+
<code><a href="source-class-LeanCloud.Client.html#697-704" title="Go to source code">getStorage</a>( )</code>
11181155

11191156
<div class="description short">
11201157
<p>Get storage</p>
@@ -1148,7 +1185,7 @@ <h4>Returns</h4>
11481185

11491186
<td class="name"><div>
11501187
<a class="anchor" href="#_setStorage">#</a>
1151-
<code><a href="source-class-LeanCloud.Client.html#695-704" title="Go to source code">setStorage</a>( <span><code><a href="class-LeanCloud.Storage.IStorage.html">LeanCloud\Storage\IStorage</a></code> <var>$storage</var></span> )</code>
1188+
<code><a href="source-class-LeanCloud.Client.html#706-715" title="Go to source code">setStorage</a>( <span><code><a href="class-LeanCloud.Storage.IStorage.html">LeanCloud\Storage\IStorage</a></code> <var>$storage</var></span> )</code>
11521189

11531190
<div class="description short">
11541191
<p>Set storage</p>
@@ -1185,7 +1222,7 @@ <h4>Parameters</h4>
11851222

11861223
<td class="name"><div>
11871224
<a class="anchor" href="#_randomFloat">#</a>
1188-
<code><a href="source-class-LeanCloud.Client.html#706-716" title="Go to source code">randomFloat</a>( <span>float <var>$min</var> = <span class="php-num">0</span></span>, <span>float <var>$max</var> = <span class="php-num">1</span></span> )</code>
1225+
<code><a href="source-class-LeanCloud.Client.html#717-727" title="Go to source code">randomFloat</a>( <span>float <var>$min</var> = <span class="php-num">0</span></span>, <span>float <var>$max</var> = <span class="php-num">1</span></span> )</code>
11891226

11901227
<div class="description short">
11911228
<p>Generate a random float between [$min, $max)</p>

0 commit comments

Comments
 (0)