README

关于

A easy to use PHP client for CartoDB's SQL API v2, using OAuth or API key authentication.

该库有两个版本：OAuth 或 API Key。在安装时，您必须选择使用哪个。

此库需要 composer，PHP 的包管理器。要使用 OAuth 版本，请将以下内容添加到您的 composer.json 中

{
    "require": {
        "simbiotica/cartodbclient-php": "dev-master"
    }
}

或者，如果您更喜欢 API key 版本，请使用以下

{
    "require": {
        "simbiotica/cartodbclient-php": "dev-api-key"
    }
}

然后，使用以下命令安装

$ php composer.phar update simbiotica/cartodbclient-php

这将安装此库以及所需的依赖项。

当前支持两种类型的连接：PrivateConnection 和 PublicConnection。公共连接是私有连接的子集，因为它们可以建立到任何公共表，具有较低的权限和配置要求。

此外，还需要实现 TokenStorageInterface 来持久化 OAuth Token。我们提供了 SessionStorage 和 FileStorage，但您也可以实现自己的。

参考 Connection 类，其中包含您需要的所有方便的函数。还有一个 runSql() 函数用于处理现有函数未涵盖的所有内容。

所有响应都被封装在 Payload 对象中，该对象包含格式化的答案、请求元数据和几个处理结果的实用工具。

没有提供实际演示，但您可以在 /tests 文件夹中查看一种示例。记住在尝试之前填写您的数据。

仅使用 API key 的使用方式不太安全，但功能相同且设置更简单。

所有连接都由 Connection 类支持，该类接受您的域和可选的 API key。如果您不提供它，您将只能有限地访问表。

参考 Connection 类，其中包含您需要的所有方便的函数。还有一个 runSql() 函数用于处理现有函数未涵盖的所有内容。

所有响应都被封装在 Payload 对象中，该对象包含格式化的答案、请求元数据和几个处理结果的实用工具。

没有提供实际演示，但您可以在 /tests 文件夹中查看一种示例。记住在尝试之前填写您的数据。