adamlc/wufoo-php-api-wrapper

WuFoo API 的 PHP 5.3+ 封装器

0.0.1 2014-05-06 07:39 UTC

This package is not auto-updated.

Last update: 2024-09-14 15:16:29 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License

这是原始 Wufoo PHP 库的一个分支。这个分支通过使用正确的命名空间和异常,试图使库更现代化。这个类遵循 PSR2 和 PSR4。

可能我已经破坏了一些东西。我没有测试所有内容,还有很多工作要做,但这只是一个开始...

Wufoo PHP API 插件旨在帮助 PHP 开发者更容易地与 Wufoo API 一起工作。它并不做任何直接与 API 一起工作不能做的事情,它只是提供了一个抽象层,使得获取所需信息更容易。

Composer

要将 Wufoo PHP API Wrapper 作为 Composer 包安装,请将以下内容添加到您的 composer.json 中

"adamlc/wufoo-php-api-wrapper": "dev-master"

运行 composer update

基础

API 封装器是一组函数,每个函数用于使用特定的 API。例如,这是获取您账户用户数据的示例

$wrapper = new Adamlc\Wufoo\WufooApiWrapper($apiKey, $subdomain);
print_r($wrapper->getUsers());

某些 API 需要更多信息才能返回它们应该返回的信息。例如,Entries API 需要知道从哪个表单返回数据。下面将逐一进行说明。

完整 API 文档

在此处提供: http://wufoo.com/docs/api/v3/

每个 API 都返回一组特定的信息,这些信息在 Wufoo.com 上均有文档记录,以供参考。

用户

所有用户的信息

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain')); //create the class
print_r($wrapper->getUsers());

完整文档: http://wufoo.com/docs/api/v3/users/

表单

所有表单的信息

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getForms($identifier = null)); //No identifier needed to retrieve all forms, otherwise pass in a form URL or hash

特定表单的信息

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getForms($identifier = 'k4j9jw')); //Identifier can be either a form hash or form URL.

完整文档: http://wufoo.com/docs/api/v3/forms/

条目

表单的条目

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getEntries('k4j9jw', 'forms', 'Filter1=EntryId+Is_equal_to+1')); //Notice the filter

报告的条目

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getReportEntries('k4j9jw', 'Filter1=EntryId+Is_equal_to+1')); //Notice the filter

向表单 POST 条目

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class

//NOTE: Create WufooSubmitFields for the $postArray values
$postArray = array(new Adamlc\Wufoo\ValueObject\WufooSubmitField('Field1', 'Booyah!'), new Adamlc\Wufoo\ValueObject\WufooSubmitField('Field1', '/files/myFile.txt', $isFile = true));
print_r($wrapper->entryPost('f83u4d', $postArray));

完整文档: http://wufoo.com/docs/api/v3/forms/post/

完整文档: http://wufoo.com/docs/api/v3/entries/

字段

表单的字段

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getFields('j9js9r')); //Identifier is a form URL or hash

报告的字段

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getReportFields('j9js9r')); //Identifier is a reporyt URL or hash

请注意,字段可能有 SubFields,例如使用 Wufoo 提供的字段(如姓名),它有“First”(名)和“Last”(姓)作为子字段。在处理数据时测试子字段并在主循环中遍历这些子字段是一个好主意。

完整文档: http://wufoo.com/docs/api/v3/fields/

评论

评论是在 Wufoo.com 条目管理器中输入的。

从表单获取评论

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getComments('j9js9r', $entryId = '1')); //You may remove the $entryId parameter to get all comments for a form by EntryId.

完整文档: http://wufoo.com/docs/api/v3/comments/

报告

所有报告的信息

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getReports());

单个表单的信息

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->getReports('a5u8r9'));

完整文档: http://wufoo.com/docs/api/v3/reports/

###Web Hook

向表单添加 Web Hook

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->webHookPut('a5u8r9', 'http://coolguy.com/webhooker/', 'key', $metadata = false);

从表单删除 Web Hook

$wrapper = new Adamlc\Wufoo\WufooApiWrapper('KUUI-22JI-ENID-IREW', 'yoursubdomain'); //create the class
print_r($wrapper->webHookDelete($formIdentifier = '432j83j', $hash = 'a5u8r9'));

完整文档: http://wufoo.com/docs/api/v3/webhooks/