README

用PHP编写的非官方WorkFlowy API。

免责声明
安装
使用
更新日志
许可
致谢

免责声明

API的目标是保持简单。请注意，这是一个非官方工具，它可能在任何时候停止工作。

因此，我强烈建议您不要使用此API处理敏感数据，并确保定期备份您的列表。

安装

{
    "require": {
        "johansatge/workflowy-php": "0.1"
    }
}

如果您不使用Composer，您可以下载源代码，在任何项目上安装它们，并调用提供的自动加载器文件

<?php require_once '/your/project/root/path/workflowy-php/src/autoload.php';

使用

登录API

由于API的非官方状态，您必须首先登录，使用您的常规凭证，然后才能对您的数据进行请求。

use WorkFlowyPHP\WorkFlowy;
use WorkFlowyPHP\WorkFlowyException;
try
{
    $session_id = WorkFlowy::login('user@domain.org', 'password');
}
catch (WorkFlowyException $e)
{
    var_dump($e->getMessage());
}

将使用$session_id变量，在执行请求时。

您必须在代码中使用未编码的密码。因此，我强烈建议您将其存储在不同的文件中，或者一次性从用户那里获取，然后存储会话ID。（但请记住，会话不会永远存在。）这是一个巨大的限制，但目前没有解决方案。

列表API

与列表相关的内容通过递归的WorkFlowySublist类管理。

首先，您需要获取主（根）列表。

use WorkFlowyPHP\WorkFlowyList;

$list_request = new WorkFlowyList($session_id);
$list = $list_request->getList();

然后，您将对生成的$list或其子列表执行以下操作。

获取列表信息

编辑列表信息

以下方法用于编辑数据。

请注意，它们将向服务器发送请求，但不会更新现有变量。

例如，如果您更改列表的父项，并在旧父项上调用getSublists()方法，该列表仍然会出现在结果数组中。

johansatge / workflowy-php

维护者

详情