跳至主要内容
版本:5.1

文件夹列表表单字段

**文件夹列表**表单字段类型提供从指定目录中选择文件夹的下拉列表。保存的值是在页面首次加载时选择的。如果未选择,则选择默认值(如果存在)。

默认情况下,列表中的第一项为“ - 未选择 -”(可翻译),其值为“-1”,然后是“ - 使用默认值 -”(也可翻译),其值为“0”。

  • **type**(必填)必须为folderlist
  • **name**(必填)是字段的唯一名称。
  • **label**(必填)(可翻译)是字段的 HTML 标签。
  • **directory**(必填)是要列出的文件夹所在的目录的文件系统路径。
  • **description**(可选)(可翻译)是字段描述
  • **default**(可选)是默认文件夹名称。
  • **filter**(Joomla 3.x)或 **fileFilter**(Joomla 4.0 及更高版本)(可选)是一个正则表达式字符串,用于筛选要包含在下拉列表中的文件夹列表。如果省略,则包含目录中的所有文件夹。筛选器参数表达式在排除参数表达式之前应用。有关构建正则表达式的信息,请参阅参数参数中的正则表达式
  • **exclude**(可选)是一个正则表达式字符串,用于从列表中排除文件。排除参数表达式在筛选器参数表达式之后应用。有关构建正则表达式的信息,请参阅参数参数中的正则表达式
  • **hide_none**(可选)是布尔参数。如果为 true,则从下拉列表中省略“ - 未选择 -”项。
  • **hide_default**(可选)是布尔参数。如果为 true,则从下拉列表中省略“ - 使用默认值 -”项。
  • **recursive**(可选)是布尔参数。如果为 true,则文件夹列表递归地包含找到的任何子文件夹。注意:如果您有大量子文件夹,这可能会导致页面加载缓慢。

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

XML 参数定义示例

<field
name="myfolder"
type="folderlist"
default=""
label="Select a folder"
directory="administrator"
filter=""
exclude=""
stripext=""
/>

另请参阅