Documentation · ViewHelper reference

XSD schema file | vhs master

Resource / FileViewHelper

ViewHelper to output or assign FAL sys_file records. /

  • Tag usage example

    <v:resource.file identifier="[mixed]" categories="[mixed]" treatIdAsUid="1" treatIdAsReference="1" as="NULL" onlyProperties="1">
    	<!-- tag content - may be ignored! -->
  • Inline usage example

    {v:resource.file(identifier: [mixed], categories: [mixed], treatIdAsUid: 1, treatIdAsReference: 1, as: 'NULL', onlyProperties: 1)}


Argument Description Type

Template variable name to assign; if not specified the ViewHelper returns the variable instead.


The sys_category records to select the resources from (either CSV, array or implementing Traversable).


The FAL combined identifiers (either CSV, array or implementing Traversable).


Whether to return only the properties array of the sys_file record and not the File object itself


If TRUE, the identifier argument is treated as reference uids and will be resolved to resources via sysfilereference.


If TRUE, the identifier argument is treated as resource uids.

Required attribute

Revision history

commit 7de5f54c813a4b9f2fc8cafd131c47c385c55a6f
Author: Danilo Bürger <*****>
Date:   Tue Oct 29 23:01:49 2013 +0100

    [FEATURE] Added FAL vhs

commit ed15bec7ec1450244979567f31ea9e8b7c3bc374
Author: Claus Due <*****>
Date:   Wed Nov 6 03:21:04 2013 +0100

    [FEATURE] ViewHelperUtility for reusable methods

commit da31bad1d9bb058c072ddb5591e8ed907a1ae8e1
Author: Claus Due <*****>
Date:   Tue Dec 31 23:08:37 2013 +0100

    [TASK] Happy new year!

commit da7677bc74f14e9a9300e4ba4487e52c3cb97642
Author: Claus Due <*****>
Date:   Sun Apr 20 01:13:33 2014 +0200

    [TASK] Switch to namespaces

commit 12ff0ddfb8d36c51f2d3befde7ae812177c80d5d
Author: Xaver Maierhofer <*****>
Date:   Wed Jun 11 00:01:47 2014 +0200

    [TASK] CGL remove use leading backslash
    PHP Docs
    Note that for namespaced names (fully qualified namespace names containing namespace separator, such as Foo\Bar as opposed to global names that do not, such as FooBar),
    the leading backslash is unnecessary and not recommended, as import names must be fully qualified, and are not processed relative to the current namespace.

commit 4981055359c895f3869e5bd878293b3c15ed26e5
Author: Xaver Maierhofer <*****>
Date:   Sun Jan 18 14:01:04 2015 +0100

    [TASK] CGL - Define classes, params, use imports

commit 8bb2fc5ee124ba19b0a0ab8e061c9a153fc4651f
Author: Xaver Maierhofer <*****>
Date:   Sun Jan 18 17:56:13 2015 +0100

    [TASK] Reference Copyright to file