跳到主要内容
版本:5.1

文件列表表单字段

文件列表 表单字段类型提供从指定目录中获取文件的下拉列表。如果该字段具有保存的值,则在页面首次加载时选择该值。否则,将选择默认值(如果有)。

默认情况下,列表中的第一个项目是“- 未选择 -”(可翻译)并被赋予值“-1”,之后是“- 使用默认值 -”(也可翻译)并被赋予值“0”。

  • type(必需)必须为 filelist
  • name(必需)是字段的唯一名称。
  • label(必需)是字段的 HTML 标签(可翻译)。
  • description(可选)是 字段描述(可翻译)。
  • directory(可选)是包含要列出的文件的目录的系统路径。如果省略,则假设由 JPATH_ROOT 给出的目录。
  • default(可选)是默认文件名。
  • filter(Joomla 3.x)或 fileFilter(Joomla 4.0 及更高版本)(可选)是一个正则表达式字符串,用于过滤选择包含在下拉列表中的文件列表。如果省略,则包含目录中的所有文件。筛选器参数表达式在排除参数表达式之前应用。有关构建正则表达式的信息,请参阅 参数参数中的正则表达式
  • exclude(可选)是一个正则表达式字符串,用于从列表中排除文件。排除参数表达式在筛选器参数表达式之后应用。有关构建正则表达式的信息,请参阅 参数参数中的正则表达式
  • stripext(可选)是一个布尔参数。如果为真,则会从列出的文件名中剥离文件名扩展名。另请注意,文件名也会在没有扩展名的情况下保存。
  • hide_none(可选)是一个布尔参数。如果为真,则会从下拉列表中省略“- 未选择 -”项。
  • hide_default(可选)是一个布尔参数。如果为真,则会从下拉列表中省略“- 使用默认值 -”项。

由以下文件实现:libraries/src/Form/Field/FilelistField.php

示例 XML 参数定义

<field
name="myfile"
type="filelist"
default=""
label="Select a file"
description=""
directory="administrator"
filter=""
exclude=""
stripext=""
/>

另请参阅