sonarsoftware / customer_portal_framework
用于为 Sonar 构建客户门户的框架。
1.0.18
2020-07-17 19:53 UTC
Requires
- php: ^5.5 || ^7.0
- guzzlehttp/guzzle: 6.*
- inacho/php-credit-card-validator: ^1.0
- nesbot/carbon: 1.*
- vlucas/phpdotenv: *
README
这是一个用于构建 Sonar 集成客户门户的框架。此库需要 Sonar 版本 0.6.0 或更高版本才能正常工作,在早期版本上无法使用。
这是什么?
这是一个 PHP 库,可帮助您构建自定义客户门户。此库抽象了许多 Sonar API 调用,并为客户门户中所需的一些常用功能添加了便捷的快捷方式。
安装
推荐安装方法是使用 Composer。您可以通过运行 composer require sonarsoftware/customer_portal_framework
来安装。
配置
将位于 src
目录中的 .env.example
文件复制到名为 .env
的新文件中。编辑此文件并设置您的 Sonar 安装 URL、API 用户名和 API 密码。此库要正常工作所需的唯一权限是创建、读取、更新和删除账户,以及创建、读取和更新票据。强烈建议您为客户门户创建一个专用的账户 - 请勿使用您的管理员账户!
如何使用此库
Controllers
目录包含控制器,允许您与 Sonar API 的不同方面进行交互。每个控制器函数都有文档说明。某些控制器函数将 Sonar API 的原始数据作为 PHP 对象返回。允许您将更改保存回 Sonar API 的控制器将返回在 Models
目录中定义的抽象对象。请检查每个控制器函数的格式以了解要求。