LeanCloud PHP SDK

安装

composer 安装

composer require leancloud/leancloud-sdk

手动下载安装

cd $APP_ROOT
wget https://github.com/leancloud/php-sdk/archive/vX.X.X.zip
# 解压并置于 vendor 目录
unzip vX.X.X.zip
mv php-sdk-X.X.X vendor/leancloud

初始化

// 如果是 composer 安装
// require_once("vendor/autoload.php");
// 如果是手动安装
require_once("vendor/leancloud/src/autoload.php");
// 参数依次为 app-id, app-key, master-key
LeanCloud\LeanClient::initialize("app_id", "app_key", "master_key");

使用示例

用户注册及管理

use LeanCloud\LeanUser;
use LeanCloud\CloudException;
$user = new LeanUser();
$user->setUsername("alice"):
$user->setEmail("alice@example.net");
$user->setPassword("passpass");
try {
 $user->signUp();
} catch (CloudException $ex) {
 // 如果 LeanCloud 返回错误,这里会抛出异常 CloudException
 // 如用户名已经被注册:202 Username has been taken
}
// 注册成功后,用户被自动登录。可以通过以下方法拿到当前登录用户和
// 授权码。
LeanUser::getCurrentUser();
LeanUser::getCurrentSessionToken();

LeanUser::logIn("alice", "passpass");
$user = LeanUser::getCurrentUser();
$token = LeanUser::getCurrentSessionToken();
// 给定一个 token 可以很容易的拿到用户
LeanUser::become($token);
// 我们还支持短信验证码,及第三方授权码登录
LeanUser::logInWithSmsCode("phone number", "sms code");
LeanUser::logInWith("weibo", array("openid" => "..."));

对象存储

use LeanCloud\LeanObject;
use LeanCloud\CloudException;
$obj = new LeanObject("TestObject");
$obj->set("name", "alice");
$obj->set("height", 60.0);
$obj->set("weight", 4.5);
$obj->set("birthdate", new \DateTime());
try {
 $obj->save();
} catch (CloudException $ex) {
 // CloudException 会被抛出,如果保存失败
}
// 获取字段值
$obj->get("name");
$obj->get("height");
$obj->get("birthdate");
// 原子增加一个数
$obj->increment("age", 1);
// 在数组字段中添加,添加唯一,删除
// 注意: 由于API限制,不同数组操作之间必须保存,否则会报错
$obj->addIn("colors", "blue");
$obj->save();
$obj->addUniqueIn("colors", "orange");
$obj->save();
$obj->removeIn("colors", "blue");
$obj->save();
// 在云存储上删除数据
$obj->destroy();

class TestObject extends LeanObject {
 protected static $className = "TestObject";
 public setName($name) {
 $this->set("name", $name);
 return $this;
 }
}
// register it as storage class
TestObject::registerClass();
$obj = new TestObject();
$obj->setName();
$obj->set("eyeColor", "blue");
...

对象查询

use LeanCloud\LeanQuery;
$query = new LeanQuery("TestObject");
$obj = $query->get($objectId);

$query = new LeanQuery("TestObject");
$query->lessThan("height", 100.0); // 小于
$query->greaterThanOrEqualTo("weight", 5.0); // 大于等于
$query->addAscend("birthdate"); // 递增排序
$query->addDescend("name"); // 递减排序
$query->count();
$query->first(); // 返回第一个对象
$query->skip(100);
$query->limit(20);
$objects = $query->find(); // 返回查询到的对象

文件存储

use LeanCloud\LeanFile;
$file = LeanFile::createWithData("hello.txt", "Hello LeanCloud!");
try {
 $file->save();
} catch (CloudException $ex) {
 // 云存储返回错误,保存失败
}
$file->getSize();
$file->getName();
$file->getUrl();

$file = LeanFile::createWithLocalFile("/tmp/myfile.png");
try {
 $file->save();
} catch (CloudException $ex) {
 // 云存储返回错误,保存失败
}
// 获取文件缩略图的链接
$url = $file->getThumbUrl();

$file = LeanFile::createWithUrl("image.png", "http://example.net/image.png");
try {
 $file->save();
} catch (CloudException $ex) {
 // 云存储返回错误,保存失败
}

贡献