README

一个用于集成 Payload 的 PHP 库。

安装

使用 composer 安装

composer require payload/payload-api

手动安装和运行

依赖项

sudo apt install php-curl

需要 import.php

<?php
require_once('payload-php/import.php');
?>

开始使用

一旦将 Payload PHP 库安装到您的环境中，我们建议使用简写别名 pl 来调用 Payload\API。

<?php
require_once('vendor/autoload.php');
use Payload\API as pl;
?>

API 认证

要使用 Payload API 进行认证，您需要一个实时或测试 API 密钥。API 密钥可以在 Payload 控制台中访问。

use Payload\API as pl;
pl::$api_key = 'secret_key_3bW9JMZtPVDOfFNzwRdfE';

测试 PHP 库

测试文件位于 Tests/ 目录中。要运行测试文件，请在终端中输入以下命令：

./vendor/bin/phpunit Tests/{__FILENAME__}.php

可以使用 ./vendor/bin/phpunit 命令查看测试执行选项。

创建对象

通过 Payload 对象与 Payload API 进行交互。以下是一个使用 Payload\Customer 对象创建客户的示例。

<?php
# Create a Customer
$customer = Payload\Customer::create(array(
    'email'=>'matt.perez@example.com',
    'name'=>'Matt Perez'
));
?>

<?php
# Create a Payment
$payment = Payload\Transaction::create(array(
    'amount'=>100.0,
    'type'=>'payment',
    'payment_method'=>new Payload\PaymentMethod(array(
        'card'=>array('card_number'=>'4242 4242 4242 4242'),
        'type'=>'card'
    ))
));
?>

访问对象属性

可以通过点符号访问对象属性。

<?php
$customer->name;
?>

更新对象

更新对象是一个简单的调用 update 对象方法。

<?php
# Updating a customer's email
$customer->update(array( 'email'=>'matt.perez@newwork.com' ))
?>

选择对象

可以使用任何属性来选择对象。

<?php
# Select a customer by email
$customers = Payload\Customer::filter_by(
    pl::attr()->email->eq('matt.perez@example.com')
);
?>

使用 pl::attr() 属性辅助接口，通过一点额外的语法糖来编写强大的查询。

$payments = Payload\Transaction::filter_by(
    pl::attr()->amount->gt(100),
    pl::attr()->amount->lt(200),
    pl::attr()->description->contains("Test"),
    pl::attr()->created_at->gt('2019-02-01')
)->all()

文档

有关 Payload 的 PHP 库和 API 功能的更多信息，请访问未压缩的 Payload 文档。