README

Laravel TransIP 在 TransIP 包 和 Laravel 5.* 之间提供桥梁。

安装

要使用此包而不会遇到麻烦，您需要 PHP 5.5+ 或 HHVM 3.6+，以及 Composer。

1. 获取 Laravel TransIP 的最新版本，将以下行添加到您的 composer.json 文件中 "hiddeco/laravel-transip": "~5.3"

2. 运行 composer update 或 composer install

3. 在 config/app.php 中注册 Laravel TransIP 服务提供程序，通过将 'TransIP\Laravel\TransIPServiceProvider::class' 添加到 providers 键

4. 将 TransIP 门面添加到 aliases 键： 'TransIP' => TransIP\Laravel\Facades\TransIP::class

配置

要管理您的 TransIP 连接，请运行 php artisan vendor:publish 命令，这将创建 config/transip.php 文件，您可以在其中修改和管理您的客户端连接。

以下配置选项可用

默认连接名称

在此处设置的 TransIP 连接名称（default）是用于所有 API 请求的默认连接。但是，您可以使用管理类使用所需数量的连接。默认设置是 'main'。

TransIP 连接

这是配置您的 TransIP 连接（connections）的地方。已存在一个具有可能选项的默认配置（除您的 API 凭证外），并且连接数量没有限制。

每个连接有两个必填字段（username 和 private_key）和两个可选字段（mode 和 endpoint）。值得注意的是，mode 字段只接受 readonly 和 readwrite 作为值。

用法

TransIP 管理器

TransIPManager 是魔法发生的地方。绑定到 ioc 容器中的 transip，并通过使用 Facade\TransIP 门面访问。它使用 Laravel Manager 包的部分来管理 TransIP 客户端连接。有关 Manager 的更多信息，您应该查看相应的 文档。

值得注意的是，返回的连接始终是 \HiddeCo\TransIP\Client 的实例。您可以在 TransIP 文档 中找到有关此实例及其方法的更多信息。

TransIP 门面

TransIP 门面将静态方法调用传递到 ioc 容器中的 transip 对象，正如之前所述，这是 TransIPManager 类。

示例

使用此包相对简单。将您的 TransIP API 凭证添加到 main 连接，该包将无需其他设置即可工作。

使用门面

use TransIP\Laravel\Facades\TransIP;

$domainNames = TransIP::domain()->getDomainNames();
// and you're done

使用 TransIP 管理器

TransIPManager 返回一个 \HiddeCo\TransIP\Client 的实例，并且将表现得像它一样。如果您想调用特定的连接，可以使用 connection 方法。

use TransIP\Laravel\Facades\TransIP;

$domainNames = TransIP::connection('alternative')->domain()->getDomainNames();

更改默认连接和进一步说明

use TransIP\Laravel\Facades\TransIP;

TransIP::connection('main')->domain()->getDomainNames();
TransIP::domain()->getDomainNames();
TransIP::connection()->domain()->getDomainNames();
// are all the same because 

TransIP::getDefaultConnection();
// returns 'main' as set in the configuration file

TransIP::setDefaultConnection('alternative');
// the 'alternative' connection is now the default connection

依赖注入

更喜欢使用依赖注入而不是外观？您可以轻松注入管理者

use TransIP\Laravel\TransIPManager;

class Foo
{
	protected $transIP;
	
	public function __construct(TransIPManager $transIP)
	{
		$this->transIP;
	}
	
	public function bar()
	{
		$this->transIP->domain()->getDomainNames();
	}
}

许可证

Laravel TransIP遵循MIT许可证（MIT）。