README

此 SDK 与 Appwrite 服务器版本 1.6.x 兼容。对于旧版本，请查看 以前的版本。

Appwrite 是一个开源的后端即服务服务器，它通过一个非常简单的 REST API 抽象和简化了复杂且重复的开发任务。Appwrite 旨在帮助您更快、更安全地开发应用程序。使用 PHP SDK 将您的应用程序与 Appwrite 服务器集成，以便轻松交互 Appwrite 后端的所有 API 和工具。有关完整 API 文档和教程，请访问 https://appwrite.io/docs

安装

通过 Composer 安装

composer require appwrite/appwrite

入门

初始化 SDK

使用您的 Appwrite 服务器 API 端点和项目 ID 初始化您的 SDK，这些可以在项目设置页面和项目的 API 密钥部分找到。同时，您还需要新的 API 密钥。

$client = new Client();

$client
    ->setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    ->setProject('5df5acd0d48c2') // Your project ID
    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ->setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;

发送第一个请求

一旦您的 SDK 对象设置完毕，创建任何 Appwrite 服务对象并发送任何请求。您想要使用的任何服务方法的完整文档可以在 SDK 文档或 API 参考 部分找到。

$users = new Users($client);

$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");

完整示例

use Appwrite\Client;
use Appwrite\ID;
use Appwrite\Services\Users;

$client = new Client();

$client
    ->setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    ->setProject('5df5acd0d48c2') // Your project ID
    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ->setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;

$users = new Users($client);

$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");

错误处理

Appwrite PHP SDK 通过具有 message、code 和 response 属性的 AppwriteException 对象来抛出错误。您可以通过捕获 AppwriteException 来处理任何错误，并将 message 显示给用户或根据提供的错误信息自行处理。以下是一个示例。

$users = new Users($client);
try {
    $user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(AppwriteException $error) {
    echo $error->message;
}

了解更多

您可以使用以下资源来了解更多信息并获得帮助

• 🚀 入门教程
• 📜 Appwrite 文档
• 💬 Discord 社区
• 🚂 Appwrite PHP 演示场

贡献

此库由 Appwrite 定制的 SDK 生成器 自动生成。在发送拉取请求之前，请查看 贡献指南 以了解如何帮助我们改进此 SDK。

许可

有关更多信息，请参阅 BSD-3-Clause 许可证 文件。