README

我们仅使用 Laravel 来构建我们的应用程序，因此此包是以 Laravel 为基础编写的。如果社区有要求将此包拆分为两个部分以便在 Laravel 之外使用，我们将考虑执行这项工作。

构建状态

安装

安装 QuickBooks PHP 客户端

$ composer require spinen/laravel-quickbooks-client

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

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

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

配置

您需要在您的 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 中配置路径。

将适当的值添加到您的 .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

[可选] 发布配置和视图

配置

可以通过运行以下命令将名为 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
   }
>>>

您可以像文档中所描述的那样调用任何资源。

中间件

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

以下是一个示例路由定义

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

spinen / laravel-quickbooks-client

维护者

详细信息