schimpanz/caspeco

此软件包已被废弃且不再维护。作者建议使用hoy/caspeco软件包。

支持Laravel的Caspeco API库

1.2.0 2016-07-11 19:13 UTC

README

caspeco

支持Laravel的PHP Caspeco API库。

Build Status StyleCI Coverage Status Quality Score Latest Version License

安装

使用Composer在项目的根目录中要求此软件包。

composer require hoy/caspeco

使用Laravel?

将服务提供程序添加到config/app.php中的providers数组。

Hoy\Caspeco\CaspecoServiceProvider::class

如果您想使用facade,可以在config/app.php中将引用添加到您的别名数组。

'Caspeco' => Hoy\Caspeco\Facades\Caspeco::class

配置

Caspeco需要连接配置。要开始,您需要发布所有供应商资产

php artisan vendor:publish

这将在您的应用中创建一个config/caspeco.php文件,您可以根据需要修改它来设置配置。同时,确保您检查此包中原始配置文件在版本之间的更改。

默认连接名称

此选项default是您指定以下哪个连接作为所有工作的默认连接的地方。当然,您可以使用管理器类同时使用多个连接。此设置的默认值是main

Caspeco连接

此选项connections是设置您应用程序中每个连接的地方。已包含示例配置,但您可以添加任意数量的连接。

使用方法

CaspecoManager

这是最具兴趣的类。它绑定到ioc容器中的caspeco,可以使用Facades\Caspeco外观进行访问。此类通过扩展AbstractManager实现了ManagerInterface。接口和抽象类都是Graham Campbell的Laravel Manager包的一部分,因此您可能想查看该存储库中的文档,了解如何使用管理器类。注意,返回的连接类始终是Hoy\Caspeco\Caspeco的实例。

Facades\Caspeco

此外观将动态将静态方法调用传递到ioc容器中的caspeco对象,默认情况下是CaspecoManager类。

CaspecoServiceProvider

此类不包含有趣的公共方法。此类应添加到config/app.php中的提供程序数组。此类将设置ioc绑定。

示例

在这里,您可以看到如何使用此软件包的一个示例。默认情况下,默认适配器是main。在您在配置文件中输入身份验证详细信息后,它将正常工作。

// You can alias this in config/app.php.
use Hoy\Caspeco\Facades\Caspeco;

Caspeco::charges()->find($id);
// We're done here - how easy was that, it just works!

Caspeco::charges()->capture($id);
// This example is simple and there are far more methods available.

Caspeco 管理员将表现得像 Hoy\Caspeco\Caspeco 一样。如果您想调用特定的连接,可以使用连接方法来实现。

use Hoy\Caspeco\Facades\Caspeco;

// Writing this…
Caspeco::connection('main')->customers()->find($id);

// …is identical to writing this
Caspeco::customers()->find($id);

// and is also identical to writing this.
Caspeco::connection()->customers()->find($id);

// This is because the main connection is configured to be the default.
Caspeco::getDefaultConnection(); // This will return main.

// We can change the default connection.
Caspeco::setDefaultConnection('alternative'); // The default is now alternative.

如果您像我一样更喜欢使用依赖注入而不是外观(facade),那么您可以注入该管理员。

use Hoy\Caspeco\CaspecoManager;

class Foo
{
	protected $caspeco;

	public function __construct(CaspecoManager $caspeco)
	{
		$this->caspeco = $caspeco;
	}

	public function bar($id)
	{
		$this->caspeco->customers()->find($id);
	}
}

App::make('Foo')->bar();

文档

本包中还有其他未在此处文档化的方法。相反,请参阅 Caspeco 的文档。如果您有任何问题,请毫不犹豫地提出问题。

许可协议

Caspeco 采用 MIT 许可协议 (MIT) 许可。