unaspbr / laravel-octopus

用于在 Laravel 中使用的 Octopus 包装器

1.0.4 2018-09-25 20:08 UTC

This package is not auto-updated.

Last update: 2024-09-25 14:56:06 UTC


README

是什么?

Octopus 是一个无服务器应用程序,它可以接受、重新分配、处理故障,并帮助预防和服务间通信问题。更多信息,请参阅 文档

Octopus Laravel Wrapper 是一个组件,它将 Octopus 集成到 Laravel 5 框架中,提供辅助类以简化使用 Octopus 的操作。

版本

1.0.4

兼容性

Octopus Laravel Wrapper 仅与 Laravel 5.5 或更高版本进行了测试。虽然可能适用于 Laravel 5 的任何版本,但不保证与早期版本的兼容性。

安装

要安装 Octopus Laravel Wrapper,您需要以下内容:

  • Laravel 5.5 或更高版本
  • PHP 7.0.31 或更高版本
  • Composer

通过 Composer 进行安装

composer require unaspbr/laravel-octopus

配置

安装后,您需要将 Octopus ServiceProvider 添加到 Laravel 的 config/app.php 文件中的 providers 数组,如下所示:

unaspbr\OctopusServiceProvider::class,

如果您想公开 wrapper 以避免导入命名空间,请将以下值添加到 aliases 数组中:

'Octopus' => unaspbr\Octopus::class,

最后,为了发布 Octopus 配置文件,请执行以下命令:

php artisan vendor:publish

在生成的 config/octopus.php 文件中,将 OCTOPUS_API_KEY 字段的数组更改为您用作 API 认证的 API Key。如果您没有 API Key,请联系 Octopus 的管理员。

使用 Wrapper

Wrapper 有两个函数,即 queuesend,与 Octopus 中同名的端点相对应。两者都可以用来发送单个或多个操作,如下面的示例所示。它们都返回一个包含请求响应的 status codemessagearray

单个操作

<?php

use unaspbr\Octopus;

$result = Octopus::queue('nome_da_action', [
	'param1' => 'valor',
	'param2' => 'valor',
]);

var_dump($result);

多个操作

<?php

use unaspbr\Octopus;

$result = Octopus::send([
	[
		'name' => 'nome_da_action',
		'params' => [
			'param1' => 'valor',
			'param2' => 'valor',
		],
	],
	[
		'name' => 'nome_da_outra_action',
		'params' => [
			'param3' => 'valor',
			'param4' => 'valor',
		],
	],
]);

var_dump($result);

许可证

GNU 通用公共许可证 v3