README

此模块允许用户在站点和页面级别添加自定义脚本和样式。

入门指南

以下说明将帮助您在您的机器上运行项目副本。

先决条件

要运行 Melis CMS 页面脚本编辑器模块，需要安装以下模块：

• Melis 核心
• Melis 引擎
• Melis 前端
• Melis CMS

安装

运行 composer 命令

composer require melisplatform/melis-cms-page-script-editor

为了在前端显示定义的脚本，需要在选择的站点上手动激活 Melis CMS 页面脚本编辑器模块。这可以通过转到 MelisCms > 站点工具 > 站点菜单，选择站点，然后在“模块加载”选项卡中激活模块来完成。

数据库

数据库模型可通过 MySQL Workbench 文件访问。

/melis-cms-page-script-editor/install/sql/Model

数据库将通过 composer 和其钩子安装。
如果出现问题，SQL 文件位于此处

/melis-cms-page-script-editor/install/sql

提供工具和元素

• Melis CMS 页面系统中的脚本标签
• Melis CMS 工具站点中的脚本标签
• 页面脚本编辑器服务
• 监听器

Melis CMS 页面系统中的脚本标签

• 在 Melis CMS 页面系统中添加了一个“脚本”标签，用户可以在页面渲染时将脚本插入到打开的 head 标签之后、关闭的 head 标签之前或关闭的 body 标签之前。
• 用户可以选择排除站点的脚本，在渲染过程中只包含页面的定义脚本。

Melis CMS 工具站点中的脚本标签

• 在 Melis CMS 工具站点中添加了一个“脚本”标签，其中设置的脚本将应用于站点所属的所有页面，除非页面排除了站点的脚本。
• 显示排除站点的脚本的页面列表，用户可以选择从异常列表中删除页面。
• 用户还可以将页面添加到异常列表。

页面脚本编辑器服务

File: 
      - /melis-cms-page-script-editor/src/Service/MelisCmsPageScriptEditorService.php   

• MelisCmsPageScriptEditorService

  • 此服务的功能包括检索和添加页面或站点的脚本。

  //Get the service
  $pageScriptEditorService = $this->getServiceManager()->get("MelisCmsPageScriptEditorService");
  
  //Retrieve final scripts of the page
  $resultList = $pageScriptEditorService->getMixedScriptsPerPage($pageId);   
  

  • 此服务常用的方法如下：
    • 检索页面脚本：getScriptsPerPage(...)
    • 检索站点脚本：getScriptsPerSite(...)
    • 检索站点异常：getScriptExceptions(...)
    • 保存页面或站点脚本：addScript(...)
    • 保存异常：addScriptException(...)

• 有关方法的详细信息，请参阅文件。

监听器

模块内部有三个监听器

• MelisCmsPageScriptEditorSavePageListener
• MelisCmsPageScriptEditorSaveSiteScriptListener
• MelisCmsPageScriptEditorScriptTagListener

Files: 
      - /melis-cms-page-script-editor/src/Listener/MelisCmsPageScriptEditorSavePageListener.php
      - /melis-cms-page-script-editor/src/Listener/MelisCmsPageScriptEditorSaveSiteScriptListener.php
      - /melis-cms-page-script-editor/src/Listener/MelisCmsPageScriptEditorScriptTagListener.php

• MelisCmsPageScriptEditorSavePageListener

  • 当在 Melis Cms 页面编辑中保存或发布页面时触发，将自动保存给定页面的脚本数据和异常配置。

• MelisCmsPageScriptEditorSaveSiteScriptListener

  • 当站点保存时触发，将自动保存给定站点的脚本数据和异常配置。

• MelisCmsPageScriptEditorScriptTagListener

  • 当页面渲染时触发
  • 将页面的脚本插入到其定义的位置（在打开的 head 标签之后、关闭的 head 标签之前或关闭的 body 标签之前）。
  • 如果页面排除了站点的脚本，则只插入页面的脚本，否则，脚本将是站点和页面脚本的组合，在渲染过程中，站点的脚本始终位于前面。

• 有关监听器的详细信息，请参阅文件。

作者

• 美利技术 - www.melistechnology.com

有关参与此项目的贡献者列表，也请参阅。

许可证

本项目遵循美利技术高级版本最终用户许可协议（EULA）许可 - 请参阅LICENSE.md文件以获取详细信息。