Merge pull request #229 from leancloud/prepare-release-doc

release 0.14.0

Author: weakish

Changelog.md

@@ -1,4 +1,11 @@
 
+0.14.0 Released on 2020-12-15
+----
+
+- Add `runRemote()` (invoking cloud function remotely).
+- Allow specifying the file key/path with `masterKey`.
+- Add license (Apache-2.0).
+
 0.13.0 Released on 2020-07-15
 ----
 

Hacking.md

@@ -47,7 +47,10 @@ and edit `Changelog.md` (git log subjects are for reference only, do not leave t
 
 Commit changes and send a pull request at leancloud/php-sdk.
 
-If everything is O.K., the maintainer will merge the pull request, push a new tag, and publish a new release at GitHub.
+If everything is O.K., the maintainer will merge the pull request, create a new tag, and publish a new release at GitHub.
+Then a new version will be published at Packagist automatically.
+It is recommended for the maintainer to create the tag when drafting a new release on GitHub web interface.
+If you prefer creating a tag locally, do not forget to pull from origin before creating a new tag. 
 Then a new version will be published at Packagist automatically.
 
 ## Run Tests with Coverage

docs/class-LeanCloud.Client.html

@@ -1282,7 +1282,7 @@ <h4>Returns</h4>
 		<td class="value">
 			<div>
 				<a href="#VERSION" class="anchor">#</a>
-				<code><span class="php-quote">'0.13.0'</span></code>
+				<code><span class="php-quote">'0.14.0'</span></code>
 			</div>
 		</td>
 	</tr>

docs/class-LeanCloud.File.html

@@ -135,7 +135,7 @@ <h1>Class File</h1>
 		<b>Namespace:</b> <a href="namespace-LeanCloud.html">LeanCloud</a><br>
 
 
-			<b>Located at</b> <a href="source-class-LeanCloud.File.html#9-451" title="Go to source code">LeanCloud/File.php</a>
+			<b>Located at</b> <a href="source-class-LeanCloud.File.html#9-459" title="Go to source code">LeanCloud/File.php</a>
 		<br>
 	</div>
 
@@ -155,7 +155,7 @@ <h1>Class File</h1>
 
 		<td class="name"><div>
 		<a class="anchor" href="#___construct">#</a>
-		<code><a href="source-class-LeanCloud.File.html#43-67" title="Go to source code">__construct</a>( <span>string <var>$name</var></span>, <span>mixed <var>$data</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#43-68" title="Go to source code">__construct</a>( <span>string <var>$name</var></span>, <span>mixed <var>$data</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span> )</code>
 
 		<div class="description short">
 			<p>Initialize file</p>
@@ -194,7 +194,7 @@ <h4>Parameters</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_createWithUrl">#</a>
-		<code><a href="source-class-LeanCloud.File.html#69-82" title="Go to source code">createWithUrl</a>( <span>string <var>$name</var></span>, <span>string <var>$url</var></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#70-83" title="Go to source code">createWithUrl</a>( <span>string <var>$name</var></span>, <span>string <var>$url</var></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span> )</code>
 
 		<div class="description short">
 			<p>Create file with public external URL</p>
@@ -237,7 +237,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_createWithData">#</a>
-		<code><a href="source-class-LeanCloud.File.html#84-95" title="Go to source code">createWithData</a>( <span>string <var>$name</var></span>, <span>string <var>$data</var></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#85-96" title="Go to source code">createWithData</a>( <span>string <var>$name</var></span>, <span>string <var>$data</var></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span> )</code>
 
 		<div class="description short">
 			<p>Create file with raw data</p>
@@ -280,7 +280,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_createWithLocalFile">#</a>
-		<code><a href="source-class-LeanCloud.File.html#97-115" title="Go to source code">createWithLocalFile</a>( <span>string <var>$filepath</var></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#98-116" title="Go to source code">createWithLocalFile</a>( <span>string <var>$filepath</var></span>, <span>string <var>$mimeType</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>
 
 		<div class="description short">
 			<p>Create file from disk</p>
@@ -327,7 +327,7 @@ <h4>Throws</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_get">#</a>
-		<code><a href="source-class-LeanCloud.File.html#117-128" title="Go to source code">get</a>( <span>string <var>$key</var></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#118-129" title="Go to source code">get</a>( <span>string <var>$key</var></span> )</code>
 
 		<div class="description short">
 			<p>Get file attribute</p>
@@ -366,7 +366,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getName">#</a>
-		<code><a href="source-class-LeanCloud.File.html#130-137" title="Go to source code">getName</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#131-138" title="Go to source code">getName</a>( )</code>
 
 		<div class="description short">
 			<p>Get name of file</p>
@@ -385,6 +385,74 @@ <h4>Returns</h4>
 
 
 
+		</div>
+		</div></td>
+	</tr>
+	<tr data-order="getKey" id="_getKey">
+
+		<td class="attributes"><code>
+			 public 
+
+			string
+			
+			</code>
+		</td>
+
+		<td class="name"><div>
+		<a class="anchor" href="#_getKey">#</a>
+		<code><a href="source-class-LeanCloud.File.html#140-147" title="Go to source code">getKey</a>( )</code>
+
+		<div class="description short">
+			<p>Get key of file</p>
+		</div>
+
+		<div class="description detailed hidden">
+			<p>Get key of file</p>
+
+
+
+				<h4>Returns</h4>
+				<div class="list">
+					string
+				</div>
+
+
+
+
+		</div>
+		</div></td>
+	</tr>
+	<tr data-order="setKey" id="_setKey">
+
+		<td class="attributes"><code>
+			 public 
+
+			<code><a href="class-LeanCloud.File.html">LeanCloud\File</a></code>
+			
+			</code>
+		</td>
+
+		<td class="name"><div>
+		<a class="anchor" href="#_setKey">#</a>
+		<code><a href="source-class-LeanCloud.File.html#148-156" title="Go to source code">setKey</a>( <span> <var>$val</var></span> )</code>
+
+		<div class="description short">
+			<p>Set key of file</p>
+		</div>
+
+		<div class="description detailed hidden">
+			<p>Set key of file</p>
+
+
+
+				<h4>Returns</h4>
+				<div class="list">
+					<code><a href="class-LeanCloud.File.html">LeanCloud\File</a></code>
+				</div>
+
+
+
+
 		</div>
 		</div></td>
 	</tr>
@@ -400,7 +468,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getObjectId">#</a>
-		<code><a href="source-class-LeanCloud.File.html#139-146" title="Go to source code">getObjectId</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#158-165" title="Go to source code">getObjectId</a>( )</code>
 
 		<div class="description short">
 			<p>Get objectId of file</p>
@@ -434,7 +502,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getCreatedAt">#</a>
-		<code><a href="source-class-LeanCloud.File.html#148-153" title="Go to source code">getCreatedAt</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#167-172" title="Go to source code">getCreatedAt</a>( )</code>
 
 		<div class="description short">
 
@@ -468,7 +536,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getUpdatedAt">#</a>
-		<code><a href="source-class-LeanCloud.File.html#155-160" title="Go to source code">getUpdatedAt</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#174-179" title="Go to source code">getUpdatedAt</a>( )</code>
 
 		<div class="description short">
 
@@ -502,7 +570,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getMimeType">#</a>
-		<code><a href="source-class-LeanCloud.File.html#162-169" title="Go to source code">getMimeType</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#181-188" title="Go to source code">getMimeType</a>( )</code>
 
 		<div class="description short">
 			<p>Get file MIME type</p>
@@ -536,7 +604,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getUrl">#</a>
-		<code><a href="source-class-LeanCloud.File.html#171-178" title="Go to source code">getUrl</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#190-197" title="Go to source code">getUrl</a>( )</code>
 
 		<div class="description short">
 			<p>Get file url</p>
@@ -570,7 +638,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getThumbUrl">#</a>
-		<code><a href="source-class-LeanCloud.File.html#180-210" title="Go to source code">getThumbUrl</a>( <span>float|integer <var>$width</var></span>, <span>float|integer <var>$height</var></span>, <span>float|integer <var>$quality</var> = <span class="php-num">100</span></span>, <span>boolean <var>$scaleToFit</var> = <span class="php-keyword1">true</span></span>, <span>string <var>$format</var> = <span class="php-quote">&quot;png&quot;</span></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#199-229" title="Go to source code">getThumbUrl</a>( <span>float|integer <var>$width</var></span>, <span>float|integer <var>$height</var></span>, <span>float|integer <var>$quality</var> = <span class="php-num">100</span></span>, <span>boolean <var>$scaleToFit</var> = <span class="php-keyword1">true</span></span>, <span>string <var>$format</var> = <span class="php-quote">&quot;png&quot;</span></span> )</code>
 
 		<div class="description short">
 			<p>Get thumbnail URL</p>
@@ -621,7 +689,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getSize">#</a>
-		<code><a href="source-class-LeanCloud.File.html#212-219" title="Go to source code">getSize</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#231-238" title="Go to source code">getSize</a>( )</code>
 
 		<div class="description short">
 			<p>Get file size</p>
@@ -655,7 +723,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getOwnerId">#</a>
-		<code><a href="source-class-LeanCloud.File.html#221-228" title="Go to source code">getOwnerId</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#240-247" title="Go to source code">getOwnerId</a>( )</code>
 
 		<div class="description short">
 			<p>Get id of uploaded user</p>
@@ -689,7 +757,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_setMeta">#</a>
-		<code><a href="source-class-LeanCloud.File.html#230-240" title="Go to source code">setMeta</a>( <span>string <var>$key</var></span>, <span>miexed <var>$val</var></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#249-259" title="Go to source code">setMeta</a>( <span>string <var>$key</var></span>, <span>miexed <var>$val</var></span> )</code>
 
 		<div class="description short">
 			<p>Set meta data</p>
@@ -730,7 +798,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_getMeta">#</a>
-		<code><a href="source-class-LeanCloud.File.html#242-259" title="Go to source code">getMeta</a>( <span>string <var>$key</var> = <span class="php-keyword1">null</span></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#261-278" title="Go to source code">getMeta</a>( <span>string <var>$key</var> = <span class="php-keyword1">null</span></span> )</code>
 
 		<div class="description short">
 			<p>Get meta data</p>
@@ -771,7 +839,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_mergeAfterSave">#</a>
-		<code><a href="source-class-LeanCloud.File.html#308-324" title="Go to source code">mergeAfterSave</a>( <span>array <var>$data</var></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#314-330" title="Go to source code">mergeAfterSave</a>( <span>array <var>$data</var></span> )</code>
 
 		<div class="description short">
 			<p>Merge server response after save</p>
@@ -806,7 +874,7 @@ <h4>Parameters</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_mergeAfterFetch">#</a>
-		<code><a href="source-class-LeanCloud.File.html#326-338" title="Go to source code">mergeAfterFetch</a>( <span>array <var>$data</var></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#332-344" title="Go to source code">mergeAfterFetch</a>( <span>array <var>$data</var></span> )</code>
 
 		<div class="description short">
 			<p>Merge server response after fetch</p>
@@ -841,7 +909,7 @@ <h4>Parameters</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_isDirty">#</a>
-		<code><a href="source-class-LeanCloud.File.html#340-348" title="Go to source code">isDirty</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#346-354" title="Go to source code">isDirty</a>( )</code>
 
 		<div class="description short">
 			<p>If there are unsaved changes.</p>
@@ -875,7 +943,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_save">#</a>
-		<code><a href="source-class-LeanCloud.File.html#350-406" title="Go to source code">save</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#356-414" title="Go to source code">save</a>( )</code>
 
 		<div class="description short">
 			<p>Save file on the cloud</p>
@@ -909,7 +977,7 @@ <h4>Throws</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_fetch">#</a>
-		<code><a href="source-class-LeanCloud.File.html#408-421" title="Go to source code">fetch</a>( <span> <var>$objectId</var></span> )</code>
+		<code><a href="source-class-LeanCloud.File.html#416-429" title="Go to source code">fetch</a>( <span> <var>$objectId</var></span> )</code>
 
 		<div class="description short">
 			<p>Fetch file object by id</p>
@@ -946,7 +1014,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_destroy">#</a>
-		<code><a href="source-class-LeanCloud.File.html#423-433" title="Go to source code">destroy</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#431-441" title="Go to source code">destroy</a>( )</code>
 
 		<div class="description short">
 			<p>Delete file on cloud</p>
@@ -980,7 +1048,7 @@ <h4>Throws</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_encode">#</a>
-		<code><a href="source-class-LeanCloud.File.html#435-450" title="Go to source code">encode</a>( )</code>
+		<code><a href="source-class-LeanCloud.File.html#443-458" title="Go to source code">encode</a>( )</code>
 
 		<div class="description short">
 			<p>Encode to JSON representation</p>

docs/source-class-LeanCloud.Client.html

@@ -161,7 +161,7 @@ <h3>Exceptions</h3>
 </span><span id="24" class="l">    <span class="php-comment">/**
 </span></span><span id="25" class="l"><span class="php-comment">     * Client version
 </span></span><span id="26" class="l"><span class="php-comment">     */</span>
-</span><span id="27" class="l">    <span class="php-keyword1">const</span> VERSION = <span class="php-quote">'0.13.0'</span>;
+</span><span id="27" class="l">    <span class="php-keyword1">const</span> VERSION = <span class="php-quote">'0.14.0'</span>;
 </span><span id="28" class="l">
 </span><span id="29" class="l">    <span class="php-comment">/**
 </span></span><span id="30" class="l"><span class="php-comment">     * API Version string

docs/source-class-LeanCloud.File.html

@@ -24,7 +24,7 @@ class Client {
     /**
      * Client version
      */
-    const VERSION = '0.13.0';
+    const VERSION = '0.14.0';
 
     /**
      * API Version string