README

为控制警报和火险等级创建WordPress Rest API端点。

警报

警报从远程FTP/SFTP服务器导入。然后警报存储在WordPress数据库中，可以通过WordPress Rest API检索。导入警报后，它们将被移动到远程服务器上的存档文件夹。要使警报在远程服务器上存档，必须设置常量 API_ALARM_MANAGER_ARCHIVE_ALARMS_ON_REMOTE 为 true。否则，远程服务器上的警报文件将不会被修改。

火险等级

火险等级是WordPress中创建的帖子。然后从WordPress Rest API检索帖子。

常量

define('API_ALARM_MANAGER_ARCHIVE_ALARMS_ON_REMOTE', true); - 将警报存档在远程服务器上所必需。

Devcontainer

该项目使用devcontainer进行开发。这意味着您可以使用VS Code来开发项目。要使用devcontainer，您需要为VS Code安装Remote - Containers扩展。安装扩展后，您可以通过点击VS Code左下角的绿色按钮并选择“Remote-Containers: Reopen in Container”来在容器中打开项目。

Devcontainer ftp/sftp服务

为了更容易在本地机器上测试此插件的功能，您可以使用devcontainer中安装的ftp/sftp服务。服务和其凭证列在./devcontainer/docker-compose.yml文件中。

使用以下详细信息从WordPress管理面板设置到ftp或sftp的连接

SFTP

服务器：sftp
用户名：demo
密码：demo
FTP/SFTP文件夹：/files
FTP/SFTP存档文件夹：/archive

FTP

服务器：ftp
用户名：demo
密码：demo
FTP/SFTP文件夹：/files
FTP/SFTP存档文件夹：/archive

Devcontainer ftp/sftp测试文件

在./devcontainer/remoteFiles中提供了一些用于本地测试的文件。要准备或重置测试文件，请从终端运行shell脚本./.vscode/tasks/reset-dummy-files。

sh ./vscode/tasks/reset-dummy-files.sh

PHP测试

Municipio使用PHPUnit进行单元测试。对于模拟和存根，我们使用WP_Mock。这意味着您可以使用WP_Mock、Mockery(由于这是WP_Mock的包装)和PHPUnit_MockObject进行模拟和存根。

PHPUnit测试文件结构

所有测试都存储在tests/phpunit/tests文件夹中。文件结构应与主题的文件结构相同。文件名应与您要测试的文件相同。例如，如果您想测试src/Controller/Base.php文件，您应创建文件tests/phpunit/tests/Controller/Base.php。为了避免测试文件太大，您可以创建一个与要测试的文件同名的文件夹，并将测试文件放在其中。请注意，为了根据您正在测试的类函数分离文件，文件名应为例如Base.functionName.php。

运行PHPUnit测试

在终端中运行composer test。

带有代码覆盖率运行PHPUnit测试

在终端中运行composer test:coverage。这将在tests/phpunit/.coverage文件夹中生成代码覆盖率报告。

helsingborg-stad / api-alarm-manager

维护者

详细信息