README

GetFiles for Craft 3.1

基于指定的文件夹路径检索文件列表。

安装

要安装此插件，请按照以下说明操作。

1. 打开您的终端并进入您的Craft项目

cd /path/to/project

1. 然后告诉Composer加载插件

composer require youandmedigital/craft-getfiles

简介

这个小插件可以基于指定的文件夹路径检索文件列表。

如果您有以下需求，这可能会对您有所帮助：

• 您正在运行Craft 3.1或更高版本
• 您需要从您的Web服务器上的一个文件夹中检索不由Craft CMS管理的文件，并将输出返回到Twig

示例

输出目录内容

在/assets/images中，有3个图片文件

22 Apr 22:54 image01.jpg
22 Apr 22:54 image02.jpg
22 Apr 22:54 image03.gif

在我们的Twig模板中，我们设置变量并给GetFiles一个要搜索的文件夹路径

{% set settings =
    {
        path: '/assets/images/'
    }
%}
{% set file = craft.getfiles.config(settings) %}

<p>Available images:</p>
{% for image in images %}
    <img src="{{ image }}" alt="{{ image }}">
{% endfor %}

以下示例Twig代码将输出

<img src="/assets/images/image01.jpg" alt="image01.jpg">
<img src="/assets/images/image02.jpg" alt="image02.jpg">
<img src="/assets/images/image03.gif" alt="image03.gif">

输出与正则表达式模式匹配的目录内容

在/assets/images中，有3个文件

<img src="/assets/images/image01.jpg" alt="image01.jpg">
<img src="/assets/images/image02.jpg" alt="image02.jpg">
<img src="/assets/images/image03.gif" alt="image03.gif">

在我们的Twig模板中，我们设置变量，给GetFiles一个要搜索的文件夹路径和一个要匹配的正则表达式模式

{% set settings =
    {
        path: '/assets/images/',
        pattern: '*.gif'
    }
%}
{% set images = craft.getfiles.config(settings) %}

<p>Available images:</p>
{% for image in images %}
<img src="/assets/images/{{ image }}" alt="{{ image }}">
{% endfor %}

以下示例Twig代码将输出

<p>Available images:<p>
<img src="/assets/images/image03.gif" alt="image03.gif">

配置GetFiles

• path (string, required)：GetFiles要搜索的有效文件夹
• pattern (string, optional, default value '*')：要匹配的正则表达式模式
• pathFormat (string, optional, default value '2')：如果您指定1，则插件将仅返回文件名。如果您指定2，则插件将输出相对于您的基路径的文件名。3将输出文件名的绝对路径。

示例配置

{% set myVarSettings =
    {
        path: '<path>',
        pathformat: '<pathformat>',
        pattern: '<pattern>'
    }
%}

{% set myVar = craft.getfiles.config(myVarSettings) %}