README

Diaporamas模块v0.1.6

作者：Romain Ducher

1. 用法

此模块允许您在描述中插入幻灯片。目前适用于产品、类别、文件夹、内容和品牌。

幻灯片使用简短代码标识。幻灯片简短代码是包含字母（小写和大写）、数字、下划线和短横线的字符串。简短代码必须包含1到32个字符。

要将幻灯片插入描述，请插入"[£ shortcode £]"标签，其中shortcode是您的幻灯片简短代码。例如，写入"[£ foo £]"将在描述中插入简短代码为"foo"的幻灯片。不要忘记在简短代码周围留出空格，否则幻灯片标签将不会被解释为描述中的幻灯片。

要管理您的幻灯片，请登录到Thelia的后台，然后在Thelia菜单中转到工具 > 幻灯片。这里有现有幻灯片的列表。对于每个幻灯片，数据库中的ID、标题和简短代码都会显示。在即将发布的版本中，您可以通过点击简短代码或点击幻灯片操作中的打开眼睛来查看幻灯片。

如果您想创建幻灯片，请点击幻灯片列表右上角的"+"标志。在标题字段中输入标题的语言，然后在其对应字段中输入简短代码。如果简短代码已被现有幻灯片使用，则幻灯片创建将失败。它将创建一个空的幻灯片，不包含图片。

要编辑幻灯片，请转到幻灯片列表并点击其数据库ID、标题或幻灯片操作中的编辑按钮。在这里，您可以像您想要的那样管理您的幻灯片。为此有两个选项卡

• 第一个选项卡，称为"常规"，允许您更改您想要的Thelia语言中的简短代码或标题。通过点击"保存"或"保存并关闭"来保存您的更改，然后通过点击"关闭"返回到幻灯片列表。
• 第二个选项卡，称为"图片"，允许您管理幻灯片的图片。您将像在Thelia中管理产品、类别、品牌、文件夹或内容的图片一样管理它们。

要删除幻灯片，请转到幻灯片列表并点击您想要删除的幻灯片的垃圾桶图标。

该模块使用SmartyFilter模块将简短代码转换为幻灯片。为此，必须激活代码为diaporamas.filter.shortcodes的Smarty过滤器。该过滤器在激活Diaporamas模块时自动激活。

1. API

该模块为在Thelia中使用幻灯片提供了一些实体。

2.1. 循环

该模块提供了两个循环。

2.1.1. 幻灯片

它处理幻灯片的一般信息。

输入

输出

2.1.2. 幻灯片图片

这个循环处理幻灯片图片。它的工作方式几乎与Thelia的图片循环相同，其参考信息请见这里。区别在于您不需要提供source参数。如果提供了，它将被忽略。也不要提供category、product、folder、content或brand参数。您正在处理幻灯片图片，而不是那些来源的图片。如果您也提供了这些参数，它们将被忽略。为了给循环提供幻灯片ID，请在source_id参数中写入它。

2.2 模型

存在用于幻灯片和幻灯片图片的类。

幻灯片由\Diaporamas\Model\Diaporama类表示。它们包含幻灯片的一般信息，即数据库ID、短代码和（i18n）标题。

幻灯片图片由\Diaporamas\Model\DiaporamaImage类表示。它们的工作方式就像经典Thelia图片，其来源为"diaporama"。

2.3. 表单

有用于创建、更新和删除幻灯片以及更新幻灯片图片的表单。有关它们的信息，请参阅config.xml文件。

2.4. 服务和事件

2.5. 有用的端点

1. 安装

Diaporamas模块需要SmartyFilter模块。它用于将短代码替换为其相应的HTML代码。在激活Diaporamas模块之前，请安装并激活它。

您可以通过下载zip存档并将其提取到thelia/local/modules中，或者通过后台办公室（在/admin/modules）上传它，或者通过Composer要求它来将模块作为Thelia模块安装。

"require": {
    "thelia/diaporamas-module": "~0.1.6"
}

注意：模块将创建一个thelia/local/media/images/diaporama文件夹来存储幻灯片图片。