README

• 安装
• 使用
  • 分页
  • 筛选
  • 部分响应
  • 代理后
• 示例
  • 集合对象

安装

将以下内容添加到您的 composer.json 文件中

{
    "require": {
        "mercurial/mailchimpv3": "dev-master"
    }
}

在您的 app.php 配置文件中添加 ServiceProvider。

// config/app.php
'providers' => [
    ...
    'Asanzred\Mailchimpv3\Mailchimpv3ServiceProvider'
]

并替换别名

// config/app.php
'aliases' => [
    ...
    'Mailchimpv3' => 'Asanzred\Mailchimpv3\Facades\Mailchimpv3'
]

配置

运行以下命令发布配置

php artisan config:publish asanzred/mailchimpv3

现在，配置文件将位于 config/asanzred/mailchimpv3/config.php

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Mailchimp API key
    |--------------------------------------------------------------------------
    |
    | To obtain an API key, go to mailchimp.com under your profile
    | you will find Extras -> API keys. Paste the key below.
    |
    */
    'apikey' => ''
];

使用

只有一个方法

request($resource, $arguments = [], $method = 'GET') 

如有需要，您可以进行以下调用

get($resource, array $options = [])
head($resource, array $options = [])
put($resource, array $options = [])
post($resource, array $options = [])
patch($resource, array $options = [])
delete($resource, array $options = [])

分页

我们使用查询字符串中的 offset 和 count 来分页数据，因为它提供了更大的控制权，以查看您的数据。偏移量默认为 0，因此如果使用 offset=1，您将错过数据集中的第一个元素。计数默认为 10。

来源： http://kb.mailchimp.com/api/article/api-3-overview

筛选

大多数端点目前不支持筛选，但我们计划在未来添加这些功能。模式将告诉您哪些集合可以筛选，以及查询字符串中应包含什么。

来源： http://kb.mailchimp.com/api/article/api-3-overview

部分响应

为了减少数据传输，可以在查询字符串中传递一个用逗号分隔的字段列表，包括或排除在某个响应中的字段。参数 fields 和 exclude_fields 是互斥的，如果请求中不存在有效字段，则将抛出错误。

来源： http://kb.mailchimp.com/api/article/api-3-overview

代理后

如果您在代理后面，可以直接在类上使用 setProxy。

setProxy(host : string, port : int, [ssl : bool = false], [username = null], [password = null]);

示例

集合对象

所有查询都将返回一个 Illuminate\Support\Collection 对象的实例，它非常容易处理。但是，如果您不想使用集合对象，可以使用 $result->toArray() 将其转换为数组。

$resource = '/lists/'

$result = Mailchimpv3::request($resource, $opts,'GET');

// Returns object(Illuminate\Support\Collection)
var_dump($result);

// Returns the first item
var_dump($result->first());

// Returns 3 items
var_dump($result->take(3));

// Returns a JSON string
var_dump($result->toJson());

// Returns an array
var_dump($result->toArray());