README

这是一个示例模块项目，开发人员可以克隆并使用它来在 OpenEMR 代码库中创建自己的自定义模块。这些模块利用 oe-module-install-plugin，该插件将自定义模块安装到 OpenEMR 自定义模块安装文件夹中。

该项目包含示例代码，演示了将您的模块添加到菜单系统、创建全局设置以及添加 REST API 端点的方法。

由于我们正在继续为模块编写者添加支持，OpenEMR 代码库中目前有有限数量的事件。如果您希望在核心代码库中连接到您自定义模块的某个位置，请在 https://github.com/openemr/openemr 上提交问题。

开始使用

您可以通过克隆项目开始。在开发模块时，最佳初始位置是在 OpenEMR 自定义模块位置克隆目录。这是 <openemr_installation_directory>//interface/modules/custom_modules/

git clone https://github.com/adunsulag/oe-module-custom-skeleton <your-project-name>

更新 composer.json 文件属性以适应您的项目。

查看 src/Bootstrap.php 了解如何添加菜单项、订阅系统事件、插入全局设置或调整 OpenEMR API。

通过 Composer 安装模块

有两种方式可以通过 Composer 安装您的模块。

公共模块

我们强烈建议您将创建的模块与 OpenEMR 社区共享。为了确保其他开发人员/用户可以安装您的包，请在 https://packagist.org.cn/ 上注册您的模块。一旦您的模块已注册，用户可以通过执行 composer require "<namespace>/<your-package-name> 来安装您的包。

私有模块

如果您的模块是私有模块，您仍然可以通过设置它以使用私有仓库来告诉 composer 您的模块的位置。您可以使用以下命令来完成此操作

composer config repositories.repo-name vcs https://github.com/<organization or user name>/<repository name>

例如，要将此骨架作为模块安装，您可以运行以下命令

composer config repositories.repo-name vcs https://github.com/adunsulag/oe-module-custom-skeleton

此时，您可以运行安装命令

composer require adunsulag/oe-module-custom-skeleton

通过文件系统安装模块

如果您将模块复制到安装目录，则需要将您的模块的 composer.json "psr-4" 属性复制到 OpenEMR 的 psr-4 设置中。您还需要在您的 openemr composer.json 文件所在的任何位置运行 composer dump-autoload，以便正确设置命名空间属性以包含您的模块。

激活您的模块

使用 composer（推荐）或将您的模块放置在 <openemr_installation_directory>//interface/modules/custom_modules/ 中安装您的模块。

一旦您的模块已安装在 OpenEMR 自定义模块文件夹中，您可以在 OpenEMR 中执行以下操作来激活您的模块。

以管理员身份登录到您的 OpenEMR 安装
转到您的菜单，选择 Modules -> Manage Modules
在模块列表中点击“未注册”标签
找到您的模块，点击“注册”按钮。这将重新加载页面并将您的模块放入模块的“已注册”列表标签中
现在点击您的模块名称旁边的“安装”按钮。
最后，点击您的模块的“启用”按钮。

贡献

如果您想帮助改进骨架库，请在微博上发布问题或发送拉取请求。

adunsulag / oe-module-custom-skeleton

维护者

详细信息