README

此库帮助将 Userlist 集成到 PHP 应用程序中。

安装

此库可以通过 Composer 安装。

composer require userlist/userlist dev-master

配置

唯一需要的配置是推送 API 密钥。您可以通过 Userlist 账户中的推送 API 设置获取您的推送 API 密钥。

配置值可以在创建新的推送客户端或通过环境变量设置。环境变量具有高于初始化过程中提供的值的优先级。

通过环境变量进行配置

USERLIST_PUSH_KEY=401e5c498be718c0a38b7da7f1ce5b409c56132a49246c435ee296e07bf2be39

初始化期间的配置

$userlist = new \Userlist\Push(['push_key' => '401e5c498be718c0a38b7da7f1ce5b409c56132a49246c435ee296e07bf2be39']);

使用

在跟踪用户或事件数据之前，创建一个新的推送客户端。如果您通过环境变量配置了您的推送密钥，则无需添加任何内容。否则，请参阅上面的示例。

$userlist = new \Userlist\Push();

跟踪用户

创建和更新用户

$user = [
    'identifier' => 'user-1',
    'email' => 'user@example.com',
    'properties' => [
        'first_name' => 'Jane',
        'last_name' => 'Doe'
    ]
];

$userlist->users->push($user);

$userlist->user($user); // Alias
$userlist->users->create($user); // Alias

删除用户

$userlist->users->delete('user-1');
$userlist->users->delete($user);

跟踪公司

创建和更新公司

$company = [
    'identifier' => 'company-1',
    'name' => 'Example, Inc.',
    'properties' => [
        'industry' => 'Software Testing'
    ]
];

$userlist->companies->push($company);

$userlist->company($company); // Alias
$userlist->companies->create($company); // Alias

删除公司

$userlist->companies->delete('company-1');
$userlist->companies->delete([ 'identifier' => 'company-1' ]);

跟踪关系

创建和更新关系

$relationship = [
    'user' => 'user-1',
    'company' => 'company-1',
    'properties' => [
        'role' => 'admin'
    ]
];

$userlist->relationships->push($relationship);

$userlist->relationship($relationship); // Alias
$userlist->relationships->create($relationship); // Alias

这与在用户模型上指定关系等效。

$user = [
    'identifier' => 'user-1',
    'relationships' => [
        [
            'company' => 'company-1',
            'properties' => [
                'role' => 'admin'
            ]
        ]
    ],
];

$userlist->users->push($user);

这也与在公司模型上指定关系等效。

$company = [
    'identifier' => 'company-1',
    'relationships' => [
        [
            'user' => 'user-1',
            'properties' => [
                'role' => 'admin'
            ]
        ]
    ],
];

$userlist->companies->push($company);

删除关系

$relationship = [
    'user' => 'user-1',
    'company' => 'company-1'
]

$userlist->relationships->delete($relationship);

跟踪事件

$event = [
    'name' => 'project_created',
    'user' => 'user-1',
    'properties' => [
        'name' => 'Example Project',
    ]
];

$userlist->events->push($event);

$userlist->event($event); // Alias
$userlist->events->create($event); // Alias

贡献

欢迎在 GitHub 上提交错误报告和拉取请求：https://github.com/userlist/userlist-php。此项目旨在成为一个安全、欢迎的协作空间，并期望贡献者遵守贡献者公约行为准则。

许可

此库在 MIT 许可证条件下作为开源软件提供。

行为准则

在Userlist项目的代码库、问题追踪器、聊天室和邮件列表中互动的所有人都应遵守行为准则。

什么是Userlist？

Userlist允许您通过基于行为的定向活动，使用电子邮件或在应用内消息来招募和参与您的SaaS用户。

Userlist始于2017年，作为大型企业消息工具的替代方案。我们相信，运营SaaS产品应该更加愉快。了解更多关于我们。

userlistio / userlist

维护者

详细信息