vmunich / ark-laravel
Laravel的ARK桥接器。
Requires
- php: ^7.0
- faustbrian/ark-php-client: ^1.0
- graham-campbell/manager: ^3.0
Requires (Dev)
- graham-campbell/testbench: ^4.0
- mockery/mockery: ^1.0
- phpunit/phpunit: ^6.5
This package is not auto-updated.
Last update: 2024-09-20 03:18:10 UTC
README
这是一个ARK桥接器,用于Laravel。
安装
使用Composer在项目的根目录中安装此包。
$ composer require faustbrian/ark-laravel
配置
ARK Laravel需要连接配置。要开始,你需要发布所有供应商资源
$ php artisan vendor:publish --provider="BrianFaust\Lark\LarkServiceProvider"
这将在你的应用中创建一个config/ark.php
文件,你可以修改它来设置配置。此外,请确保检查该包中原始配置文件在发布之间的变化。
默认连接名称
此选项default
是你希望将以下哪个连接用作所有工作的默认连接的地方。当然,你可以同时使用多个连接,使用管理器类。此设置的默认值是main
。
Lark连接
此选项connections
是设置每个连接的地方,用于你的应用。已包括示例配置,但你可以添加尽可能多的连接。
使用
LarkManager
这是最感兴趣的类。它绑定到ioc容器中的lark
,并可以使用Facades\Lark
外观访问。此类通过扩展AbstractManager实现ManagerInterface。接口和抽象类都是Graham Campbell的Laravel Manager包的一部分,因此你可能想查看该存储库中的文档,了解如何使用管理器类。请注意,返回的连接类始终是Lark\Lark
的实例。
Facades\Lark
此外观将动态地将静态方法调用传递到ioc容器中的lark
对象,默认情况下是LarkManager
类。
LarkServiceProvider
此类没有感兴趣的公共方法。此类应添加到config/app.php
中的提供者数组。此类将设置ioc绑定。
示例
在这里,你可以看到这个包有多么简单易用。默认情况下,默认适配器是main
。在配置文件中输入你的认证详细信息后,它就会正常工作。
// You can alias this in config/app.php. use BrianFaust\Lark\Facades\Lark; Lark::api('Account')->accounts(); // We're done here - how easy was that, it just works!
Lark管理器会表现得像BrianFaust\Lark\Client
。如果你想要调用特定的连接,你可以使用连接方法。
use BrianFaust\Lark\Facades\Lark; // Writing this… Lark::connection('main')->api('Account')->accounts()->create($params); // …is identical to writing this Lark::api('Account')->accounts()->create($params); // and is also identical to writing this. Lark::connection()->api('Account')->accounts()->create($params); // This is because the main connection is configured to be the default. Lark::getDefaultConnection(); // This will return main. // We can change the default connection. Lark::setDefaultConnection('alternative'); // The default is now alternative.
如果你像我一样更喜欢使用依赖注入而不是外观,那么你可以注入管理器
use BrianFaust\Lark\LarkManager; class Foo { protected $lark; public function __construct(LarkManager $lark) { $this->lark = $lark; } public function bar($params) { $this->lark->api('Account')->accounts(); } } App::make('Foo')->bar($params);
文档
此包中还有其他未在此处记录的类。这是因为在发布之间,该包是Ark-PHP包的Laravel包装器。
测试
$ phpunit
安全性
如果你在此包中发现安全漏洞,请发送电子邮件至hello@brianfaust.me。所有安全漏洞都将得到及时处理。