bananastandio/php_sdk

Banana Stand PHP SDK

0.0.1 2017-03-19 19:19 UTC

This package is not auto-updated.

Last update: 2024-09-17 04:47:49 UTC


README

此仓库是Banana Stand PHP SDK的仓库。更多信息请访问https://www.bananastand.io

安装

使用composer安装:composer require bananastandio/php_sdk,或者将文件夹复制到您的项目中并包含所有文件。

用法

设置

require_once('vendor/autoload.php');

use Banana\Client;
use Banana\Models\Event;

$client = new Client("*your public key*", "* your secret key *"); // Replace with your keys

获取事件

$events = $client->events(); // Get the first page of events (default sorting is most recently updated first)
foreach ($events as $event) {
    echo $event->id . "|" . $event->visitor_id . "\n";
}

删除事件

$event->delete();

查找事件

$event = Event::find($client, $events[0]->id);
echo "Found: " . $event->id . "|" . $event->visitor_id . "\n";

获取产品的HTML内容

$html = $client->getProductPageHtml($event->product_id);

为顾客123推送该产品的查看事件

$client->pushViewEvent($event->product_id, null, 123);

需要帮助?

在此github上发布问题,开发人员将回应。如果您更喜欢通过电子邮件联系,请将邮件发送至支持团队。

待办事项

  • 添加自动化测试并将其链接到travis

贡献

如何贡献

要为此仓库做出贡献

  1. 分叉仓库。
  2. 在本地上分叉仓库。
  3. 创建一个描述您工作的分支。例如 "my_new_feature_xyz"。
  4. 完成工作后,将该分支推送到您的分叉仓库(而不是主仓库)。
  5. 访问https://github.com/bananastandio/php_sdk,您将看到一个从您的分叉分支创建拉取请求到master的选项。创建一个拉取请求。
  6. 填写拉取请求模板中要求的所有内容,并将拉取请求分配给某人进行审查。
  7. 将审查者设置为本人,将请求的审查者设置为任何您希望审查您PR的人。
  8. 一旦PR合并到master,它就准备好投入生产并应如此对待。它将在几分钟内部署到测试环境。

获取您的PR批准

以下是一些需要注意的关键事项

  • 在您合并之前,PR必须获得所有请求的审查者的批准。
  • 在您根据审查者的请求实施更改后,请发布回信息,例如 :recyle: 请再次查看。 注意:如果您不这样做,则PR可能永远不会在评论被考虑后再次审查。
  • 如果PR评论以🍺开头,则这只是审查者的建议和偏好,评论是非阻塞的。也就是说,您的PR可能仍然会获得这些评论的批准。
  • 如果PR评论以💁‍♂️开头,则只是信息性的,无需采取行动。它就像是一个“仅供参考”。
  • 所有其他PR评论可能需要解决,除非审查者另有约定。
  • PR批准后,您可以自由合并。
  • PR审查将尽快进行,但通常在24小时内。

设计和代码标准

一般标准

使用以下设置配置您的IDE或代码编辑器

  • 使用4个空格,而不是制表符。
  • 在文件末尾添加新行。

PHP样式

遵循PSR-2编码标准

其他考虑事项
  1. 保持方法和类小巧精炼。 遵循SRP
  2. 如果您在代码中添加了很多注释,您可能应该考虑是否应该将代码拆分成多个方法。这种情况有95%的可能性。