roiarthurb / openmole
用于与 OpenMole 平台通信的 PHP 包装器。
v0.0.1
2020-03-06 04:53 UTC
Requires
- php: >=7.1
Requires (Dev)
- phpunit/phpunit: 6.*
This package is auto-updated.
Last update: 2024-09-29 05:36:03 UTC
README
OpenMole PHP 包装器
PHP 包装器,用于轻松与 OpenMole REST API 通信
探索文档
报告错误 · 请求功能
目录
关于项目
这个库是为了更容易地将您的 PHP 应用程序(我在 Lumen µFramework 中使用它)与 OpenMole REST API 之间的通信集成而创建的!
因此,这个库将封装所有公开的 URL,发送 curl 请求,并以易于使用的格式将结果返回到您的 PHP 应用程序。
构建工具
入门
要获取本地副本并运行,请按照以下简单步骤操作。
先决条件
这是如何列出和检查您需要使用此库的东西的示例。
- php
$ php -v PHP 7.4.3 (cli) (built: Feb 18 2020 15:35:13) ( NTS ) Copyright (c) The PHP Group Zend Engine v3.4.0, Copyright (c) Zend Technologies
- curl
$ curl -V curl 7.69.0 (x86_64-pc-linux-gnu) libcurl/7.69.0 OpenSSL/1.1.1d zlib/1.2.11 libidn2/2.3.0 libpsl/0.21.0 (+libidn2/2.2.0) libssh2/1.9.0 nghttp2/1.39.2 Release-Date: 2020-03-04 Protocols: dict file ftp ftps gopher http https imap imaps pop3 pop3s rtsp scp sftp smb smbs smtp smtps telnet tftp Features: AsynchDNS GSS-API HTTP2 HTTPS-proxy IDN IPv6 Kerberos Largefile libz NTLM NTLM_WB PSL SPNEGO SSL TLS-SRP UnixSockets
- composer
$ composer -V Composer version 1.9.3 2020-02-04 12:58:49
从 composer 安装(简单方式)
- 移动到应用程序根目录
$ cd /path/to/your/app
- 将库设为必需
$ composer require roiarthurb/openmole
- 安装所需的库
$ composer install
从 git 安装
- 克隆 OpenMole-PHP-Wrapper
git clone https://github.com/RoiArthurB/OpenMole-PHP-Wrapper.git
- 在您的应用程序中链接/使用库
使用方法
创建 OpenMole 包装器实例
$myWrapper = new \RoiArthurB\OpenMole\OpenMole( $url = "api.myopenmole.org", $port = 8080, $https = false);
获取您 OpenMole 实例上运行的作业完整列表
$result = $myWrapper->getJobs(); var_dump($result); // array(2) { [0]=> object(stdClass)#34 (1) { ["id"]=> string(36) "1b303e8a-b739-46bb-8b9d-323c588e74ff" } [1]=> object(stdClass)#35 (1) { ["id"]=> string(36) "9a1d21e0-c9ed-42e8-b0f3-ba6de6abda53" } }
获取单个作业状态
$result = $myWrapper->getJobState("1b303e8a-b739-46bb-8b9d-323c588e74ff"); var_dump($result); // object(stdClass)#34 (1) { ["state"]=> string(8) "finished" }
有关更多示例,请参阅 文档
贡献
贡献使开源社区成为一个如此令人惊叹的学习、灵感和创造的地方。您做出的任何贡献都 非常欢迎。
- 分支项目
- 创建您的功能分支(
git checkout -b feature/AmazingFeature) - 提交您的更改(
git commit -m 'Add some AmazingFeature') - 将分支推送到远程仓库(
git push origin feature/AmazingFeature) - 打开拉取请求
许可
在 LGPL 2.1 许可下分发。有关更多信息,请参阅 LICENSE。
作者
- Arthur Brugiere - 初始工作 - RoiArthurB
项目链接: https://github.com/RoiArthurB/OpenMole-PHP-Wrapper OpenMole 项目链接: https://openmole.org/index.html