README

PHP客户端，封装了 QuickBooks PHP SDK。

我们仅使用 Laravel 开发我们的应用程序，因此该包是针对Laravel编写的。如果社区有请求将此包拆分为两部分以允许在Laravel之外使用，我们将考虑完成这项工作。

构建状态

安装

1. 安装QuickBooks PHP客户端

$ composer require spinen/laravel-quickbooks-client

1. 运行我们的迁移以安装 quickbooks_tokens 表

$ php artisan migrate --package=spinen/laravel-quickbooks-client

该包使用Laravel的 自动注册功能。

配置

1. 您需要在您的 User 模型中创建一个 quickBooksToken 关联。存在一个名为 Spinen\QuickBooks\HasQuickBooksToken 的特质，您可以将它包含在您的 User 模型中，这将设置关联。要完成此操作，请实现以下内容

在User.php的顶部添加 use Spinen\QuickBooks\HasQuickBooksToken; 并在类内添加特质。例如

class User extends Authenticatable
{
    use Notifiable, HasQuickBooksToken;

注意：如果您的 User 模型不是 App\Models\User，则需要配置 configs/quickbooks.php 中的路径。

1. 在您的 .env 文件中添加相应的值

   最小密钥

   QUICKBOOKS_CLIENT_ID=<client id given by QuickBooks>
   QUICKBOOKS_CLIENT_SECRET=<client secret>

   可选密钥

   QUICKBOOKS_API_URL=<Development|Production> # Defaults to App's env value
   QUICKBOOKS_DEBUG=<true|false>               # Defaults to App's debug value

2. [可选] 发布配置和视图

   配置

   可以通过运行以下命令将名为 quickbooks.php 的配置文件发布到 config/...

   php artisan vendor:publish --tag=quickbooks-config

   视图

   可以通过运行以下命令发布视图文件...

   php artisan vendor:publish --tag=quickbooks-views

用法

以下是从QuickBooks获取公司信息的示例

注意：在执行这些命令之前，请访问您的连接路由（默认：/quickbooks/connect）以获取用户的QuickBooks令牌

php artisan tinker
Psy Shell v0.8.17 (PHP 7.1.14 — cli) by Justin Hileman
>>> Auth::logInUsingId(1)
=> App\Models\User {#1668
     id: 1,
     // Other keys removed for example
   }
>>> $quickbooks = app('Spinen\QuickBooks\Client') // or app('QuickBooks')
=> Spinen\QuickBooks\Client {#1613}
>>> $quickbooks->getDataService()->getCompanyInfo();
=> QuickBooksOnline\API\Data\IPPCompanyInfo {#1673
     +CompanyName: "Sandbox Company_US_1",
     +LegalName: "Sandbox Company_US_1",
     // Other properties removed for example
   }
>>>

您可以根据SDK中的文档调用任何资源 （SDK）。

中间件

如果您有需要用户帐户具有可用的QuickBooks OAuth令牌的路由，有一个名为 Spinen\QuickBooks\Laravel\Filter 的中间件被注册为 quickbooks，这将确保帐户已链接，并在需要时将它们重定向到 connect 路由。

以下是一个示例路由定义

Route::view('some/route/needing/quickbooks/token/before/using', 'some.view')
     ->middleware('quickbooks');