README

PHP客户端包装QuickBooks PHP SDK。

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

安装

1. 安装QuickBooks PHP客户端

$ composer require TalentLoom/laravel-quickbooks-v3

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

$ php artisan migrate --package=TalentLoom/laravel-quickbooks-v3

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

配置

1. 您需要在您的User模型中有一个quickBooksToken关系。有一个名为TalentLoom\LaravelQuickbooksV3\HasQuickBooksToken的特质，您可以在您的User模型中包含它，这将设置关系。为此，实现以下内容

将use TalentLoom\LaravelQuickbooksV3\HasQuickBooksToken;添加到User.php的顶部服务容器中，并在类中添加特质。例如

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获取公司信息的示例

注意：在执行以下命令之前，请访问您的connect路由（默认：/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('TalentLoom\LaravelQuickbooksV3\Client') // or app('QuickBooks')
=> TalentLoom\LaravelQuickbooksV3\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令牌的路由，则有一个名为TalentLoom\LaravelQuickbooksV3\Filter的内置中间件，该中间件注册为quickbooks，将确保账户已链接，并在需要时将用户重定向到connect路由。

以下是一个示例路由定义

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