jeroendesloovere/fork-cms-php-api

这个 Fork CMS PHP 类可以与 Fork CMS 网站API通信。

1.0.2 2014-09-16 11:49 UTC

This package is auto-updated.

Last update: 2024-08-24 04:24:19 UTC


README

Latest Stable Version License Build Status

这个 Fork CMS PHP 类可以与 Fork CMS 网站的 API 通信。

用法

安装

{
    "require": {
        "forkcms/api-wrapper-class": "1.0.*"
    }
}

将此代码添加到您的 composer.json 文件中,将使用 Composer 获取最新的 fork-cms-php-api Packagist 包

示例

use ForkCms\Api\ForkCms;

不需要身份验证的函数调用

$api = new ForkCms(
    $url,
    $email
);

$response = $api->coreGetAPIKey($email, $password);

$apiKey = $response['api_key'];

需要身份验证的函数调用

$api = new ForkCms(
    $url,
    $email,
    $apiKey
);

$response = $api->coreAppleAddDevice(APPLE_DEVICE_TOKEN);
$response = $api->coreAppleRemoveDevice(APPLE_DEVICE_TOKEN);
$response = $api->blogCommentsGet();
// ...

查看所有示例 或检查 Fork CMS API 包装类

测试

phpunit

文档

类内部有良好的文档。如果您使用了一个不错的 IDE,您会看到每个方法都有 PHPDoc 文档。

贡献

贡献是 欢迎的,并且将得到完全 认可

拉取请求

添加或更新代码

  • 编码语法 - 请保持代码语法与包的其余部分一致。
  • 添加单元测试! - 如果您的补丁没有测试,则不会接受。
  • 记录任何行为变更 - 确保 README 和任何其他相关文档都保持最新。
  • 考虑我们的发布周期 - 我们尽量遵循 semver。随机破坏公共 API 不是可选项。
  • 创建主题分支 - 不要要求我们从您的 master 分支拉取。
  • 每个功能一个拉取请求 - 如果您想做更多的事情,请发送多个拉取请求。
  • 发送一致的记录 - 确保您的拉取请求中的每个单独提交都是有意义的。如果您在开发过程中必须做出多个中间提交,请在提交之前将它们压缩。

问题

用于错误报告或代码讨论。

有关如何在 help.github.com 上与 GitHub 合作,请参阅更多信息。

鸣谢

许可证

该模块许可在 MIT 下。简而言之,此许可证允许您做任何事情,只要版权声明保持存在。