README

这个开源软件包是为了使使用D2L Brightspace的API（Valence）和数据导出（数据枢纽）更容易而构建的。

此软件包是用PHP编写的。如果您不使用PHP，尽管这些软件包本身可能对您的应用程序没有直接用途，但它们可能激发您将它们移植到您选择的任何语言。

您会发现此软件包的文档很少，这是故意的。此软件包的主要功能是用于与IDE（如PhpStorm）一起使用，它提供了类、函数、字段等的完成功能。

想要使用Valence注册用户？只需输入 $valenceobjectname->enroll 并检查包含所需操作的函数的自动完成。想法是您将不需要翻阅文档或记住所有API路由和字段。您将使用自动完成来完成它。

想要从数据枢纽访问信息？只需输入您要检索数据的报告名称（应自动完成）并使用Eloquent ORM访问信息。

如果您不使用具有类意识和自动完成的IDE，此软件包可能对您帮助不大。实际上，它可能会增加使用API开发应用程序所需的时间，因为它只是添加了您需要阅读的又一层文档。

状态

此软件包目前为 预览版。第一版官方发布预计在1月份。在第一版官方发布后，将尽量避免重大更改，除非是由于Valence API本身的更改导致的重大更改。然而，由于最后细节正在完善，因此可能对此预览版进行更改，这可能会更改您使用此软件包创建的代码。目前提供此软件包是为了实验目的。

这是一个开源软件包。目前不接受贡献。许多计划中的功能已经在扩展的定制客户端中构建，并将在未来实施，其中一些功能依赖于尚未记录的特定命名约定和其他一致性。一旦这些功能实现，我们将接受合并请求到官方仓库。在此期间，您可以在本地扩展您的客户端，或创建自己的composer软件包，扩展此软件包。