leszcz/laravel-directadmin

Laravel 5 DirectAdmin API 封装器

1.0.5 2018-03-28 18:54 UTC

This package is auto-updated.

Last update: 2024-09-10 13:40:40 UTC


README

Latest Version Software License Build Status Total Downloads

安装

您可以使用 Composer 安装此包:

composer require solitweb/laravel-directadmin

Laravel 5.5 使用包自动发现功能,因此不需要您手动添加 ServiceProvider。

Laravel 5.5+

如果您不使用自动发现,请将 ServiceProvider 添加到 config/app.php 文件中的 providers 数组中

// config/app.php
'providers' => [
    ...
    Solitweb\LaravelDirectAdmin\LaravelDirectAdminServiceProvider::class,
];

可选,注册 facade

// config/app.php
'aliases' => [
    ...
    'DirectAdmin' => Solitweb\LaravelDirectAdmin\LaravelDirectAdminFacade::class,
];

要发布配置文件到 app/config/laravel-directadmin.php,请运行

php artisan vendor:publish --provider="Solitweb\LaravelDirectAdmin\LaravelDirectAdminServiceProvider"

使用

在文件顶部导入 facade。

use DirectAdmin;

示例

这将返回一个数组,包含当前所有由经销商拥有的用户

return DirectAdmin::get()->request('SHOW_USERS');

这将返回一个包含用户使用情况的数组

return DirectAdmin::get()->request('SHOW_USER_USAGE', ['user' => 'john']);

有关更多命令,请查看 DirectAdmin API 文档。您必须复制命令,不包括 CMD_API_

魔术方法

您还可以使用以下方式利用魔术方法从 API 获取数据

$users = DirectAdmin::getShowAllUsers();
// Translates to DirectAdmin->get()->request('SHOW_ALL_USERS');

在使用魔术方法时也支持参数

return DirectAdmin::postAccountAdmin([
    'action' => 'create',
    'username' => 'New Admin',
    ....
]);
// Translates to DirectAdmin->post()->request('ACCOUNT_ADMIN', [arguments]);

魔术方法的命名规则是方法名(get/post)后跟没有 CMD_API_ 的命令,首字母大写。因此,如果您想使用 CMD_API_SHOW_ALL_USERS 命令进行 GET 请求,魔术方法将是 getShowAllUsers()

致谢

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件