silverstripe / cms-events
触发 Silverstripe CMS 中常见操作的事件
dev-master / 2.x-dev
2024-02-09 00:48 UTC
This package is auto-updated.
Last update: 2024-08-29 02:53:55 UTC
README
此模块允许开发人员使用 silverstripe/event-dispatcher
API 注册常见 CMS 操作的事件处理器。
可用事件
formSubmitted
- 描述:CMS 中提交的任何表单
- 示例:保存、发布、取消发布、删除
- 监听器:
SilverStripe\CMSEvents\Listener\Form\Listener
cmsAction
- 描述:一个
CMSMain
控制器操作 - 示例:
savetreenode
(重新排列网站树) - 监听器:
SilverStripe\CMSEvents\Listener\CMSMain\Listener
gridFieldAction
- 描述:通过 URL(
GridField_URLHandler
)调用的标准 GridField 操作 - 示例:
handleReorder
(重新排列项目) - 监听器:
SilverStripe\CMSEvents\Listener\GridField\Action\Listener
gridFieldAlteration
- 描述:通过 URL(
GridField_ActionProvider
)调用的 GridField 操作 - 示例:
deleterecord
、archiverecord
- 监听器:
SilverStripe\CMSEvents\Listener\GridField\Alteration\Listener
graphqlMutation
- 描述:一个构建的 GraphQL 变更
- 示例:
mutation createMyDataObject(Input: $Input)
- 监听器:
SilverStripe\CMSEvents\Listener\GraphQL\Mutation\Listener
graphqlOperation
- 描述:任何通用的 GraphQL 操作
- 示例:
mutation publishAllFiles
、query allTheThings
- 监听器:
SilverStripe\CMSEvents\Listener\GraphQL\Middleware\Listener
注册事件处理器
SilverStripe\Core\Injector\Injector: SilverStripe\EventDispatcher\Dispatch\Dispatcher: properties: handlers: # arbitrary key cmsForms: on: [ formSubmitted.save ] handler: %$MyProject\MySaveHandler
有关使用事件派发器的更多信息,请参阅 事件派发器文档
要求
- silverstripe/framework: ^4.5
安装
$ composer require silverstripe/cms-events
许可
请参阅 许可
错误跟踪器
错误在存储库的问题部分中跟踪。在提交问题之前,请阅读现有问题以确保您的独特性。
如果问题看起来像是一个新的错误
- 创建一个新问题
- 描述重现问题的步骤和预期结果。单元测试、截图和屏幕录像在这里可能会有所帮助。
- 尽可能详细地描述您的环境:SilverStripe 版本、浏览器、PHP 版本、操作系统、安装的任何 SilverStripe 模块。
请直接向模块维护者报告安全问题。请不要在错误跟踪器中提交安全问题。
开发和贡献
如果您想为此模块做出贡献,请确保您发起了一个拉取请求,并与模块维护者进行了讨论。