codelathe/filecloudapi-php

FileCloud API 客户端包装器


README

PHP 的 FileCloud API

FileCloud 是一个完全自托管的 企业级 文件共享和同步解决方案,可以在各种平台上运行,以及您的云基础设施。(https://www.getfilecloud.com

API 类包装器

FileCloud 的 API 包装器提供了对用户端操作以及管理端操作的大部分 API 的快速访问。有关完整 API 文档,请参阅 https://www.getfilecloud.com/developer/

  • CloudAPI 类:用户端 API 的 API
  • CloudAdminAPI 类:管理端 API 的 API

安装

filecloudapi-php 代码需要在 Windows 或 Linux 及以上版本的正确配置的 PHP 7.1 环境中运行

  • 需要 PHP curl
  • 需要 PHP SimpleXML 解析器

有两种方法将此库包含在您的系统中

手动要求

如果您无法(或只是不想)在项目中设置 composer,您只需在代码中要求 fccloudapi.php 文件,就可以准备就绪。

查看 example1.php 以了解其实际运行情况。

Composer

如果您的代码已设置好 composer,您只需执行 composer require codelathe/filecloudapi-php,或在 composer.json 文件的 require 部分中包含 codelathe/filecloudapi-php,然后运行 composer update。您应该可以正常运行,因为库将包含在您的 composer 自动加载器中。

您可以通过查看 example2 来了解它如何与 composer 一起工作。

开发

要开始,请查看示例文件夹。那里的所有示例都只是登录到 FileCloud 并创建一个新文件夹。

example1 - 手动要求

查看 example1.php 并更改文件顶部的常量值。然后执行它

$ php example1.php
example2 - Composer

转到 example2 文件夹,并运行 composer install。它将创建 vendor 文件夹和 composer.lock 文件。查看 index.php 并更改文件顶部的常量值,然后执行它

$ php index.php

此示例仅模拟使用 FileCloudAPI 客户端库作为依赖项的项目。

更多信息

调用 API 将返回一个包含不同记录的集合对象或仅返回单个记录对象的单个记录对象。集合对象可以包含包含关于返回的记录的一般信息的元记录对象。它们还可以包含多个数据记录对象。

[集合]

  +--------------- [Meta Record]
  +--------------- [1 ..n Data Records]

根据 API 的不同,您可能得到不同类型的数据记录。请参考 API 文档以了解返回的是哪种记录类型。

例如,以下是一个非详尽的记录类型列表,可以返回

[数据记录]

 +----------- [CommandRecord]
 +----------- [FolderPropertiesRecord]
 +----------- [AuthenticationRecord]
 +----------- [ShareRecord]
 +----------- [CommentRecord]
 +----------- [UserRecord]
 +----------- [ProfileRecord]
 +----------- [LangRecord]
 +----------- and so on...

许可证

版权所有 2018 CodeLathe Technologies Inc。

根据 Apache 许可证 2.0 版(“许可证”);除非根据适用的法律或书面同意,否则不得使用此文件,除非遵守许可证。您可以在以下位置获得许可证副本:

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或经书面同意,否则在许可证下分发的软件按“原样”基础分发,不提供任何明示或暗示的保证或条件。有关许可证的具体语言,请参阅许可证。