README

演示

为Sulu CMS提供的一个包，允许您管理以模态显示的Flash信息。

功能

编程新闻快讯
原生js模态框（感谢Tingle https://tingle.robinparisi.com/）
用于显示新闻快讯的twig函数

要求

PHP >= 8.0
Sulu >= 2.5
Symfony >= 5.4
Composer

安装

安装包

执行以下composer命令以将包添加到项目的依赖项中

composer require pixelopen/sulu-flashinfobundle

启用包

通过将其添加到项目config/bundles.php文件中注册的包列表中启用包

return [
    /* ... */
    Pixel\FlashInfoBundle\FlashInfoBundle::class => ['all' => true],
];

更新模式

开发环境

bin/console do:sch:up --force

生产环境：使用doctrine迁移

包配置

在routes_admin.yaml中定义Admin API路由

flash_info.flash_infos_api:
  type: rest
  prefix: /admin/api
  resource: pixel_flashinfo.flash-infos_route_controller
  name_prefix: flashinfo.

flash_info.setting_api:
  type: rest
  prefix: /admin/api
  resource: pixel_flashinfo.setting_route_controller
  name_prefix: flashinfo.

使用

添加/编辑新闻快讯

要添加新闻快讯，请转到“新闻快讯”部分，然后点击页面顶部的“添加”。

在表单上，填写以下字段

标题（必填）
图片
文档
开始日期（必填）
结束日期（必填）
描述（必填）
按钮标签
链接

点击“保存”以保存您的新闻快讯。要启用它，请点击页面顶部的“Active?”按钮。

要编辑新闻快讯，请点击您想要编辑的新闻快讯的笔。这将带您到与添加相同的表单。

删除/恢复

有两种删除新闻快讯的方式

转到编辑表单，点击页面顶部的“删除”按钮
勾选您想要删除的新闻快讯，然后点击页面顶部的“删除”

在这两种情况下，已删除的新闻快讯将被放入回收站。

要恢复新闻快讯，请转到设置 > 回收站，选择您想要恢复的新闻快讯（通过点击左侧的逆时针时钟）。恢复后，您将被重定向到编辑表单。

要永久删除新闻快讯，选择它并点击页面顶部的“删除”按钮。

设置

设置允许您设置新闻快讯模态框的显示方式。要访问它，请转到设置 > 新闻快讯管理。您将有一个选择以下选项的列表

不打开：模态框永远不会自动打开
打开一次：在第一次访问网站时打开模态框（存储在cookie中）
每次打开：在用户访问期间每次都打开模态框

显示模态框

模态框将显示当前日期在新闻快讯定义的期间内有效的活动新闻快讯。

模态框可以自动显示或通过点击按钮显示。

添加自动打开模态框

要使用自动打开的新闻快讯模态框，请将auto_display_flash_info_modal函数添加到head标签。

此函数不接受任何参数。

<head>
    {{ auto_display_flash_info_modal() }}
</head>

此Twig函数将在有发布新闻快讯时根据模态框显示策略（在设置中设置）自动显示模态框。

添加点击打开模态框

要使用点击打开模态框，您需要使用display_flash_info_modal_on_click函数。

此函数必须放置在 head 标签中，并接受一个参数

elementId：打开模态框的元素的 id

<head>
    {{ display_flash_info_modal_on_click('flashInfo') }}
</head>
<body>
    <button id="flashInfo">Open the news flashes</button>
</body>

无论模态框的显示策略如何，都将显示模态框。

如果没有激活的新闻快讯，将显示一条空消息。

贡献

您可以为此组件做出贡献。您必须做的唯一一件事是尊重我们实施的编码标准。您可以在 ecs.php 文件中找到它们。

pixelopen / sulu-flashinfobundle

维护者

详情