info.magnolia.modules.resources.templating

Class ResourcesTemplatingFunctions

java.lang.Object

info.magnolia.modules.resources.templating.ResourcesTemplatingFunctions

public class ResourcesTemplatingFunctions
extends Object

Templating functions for creating links to web resources such as css and js files by given patterns.

Provide a single pattern or a list of patterns to match files from all resources. Use methods css(String), css(List), cachedCss(String), cachedCss(List), js(String), js(List), cachedJs(String) or cachedJs(List) demanding on your needs.

The methods create printable html tags such as the followings:
<script src="/.resources/travel-demo-theme/js/html5shiv.js"></script>
<link rel="stylesheet" type="text/css" href="/.resources/foobar/webresources/css/a.css"/>
<link rel="stylesheet" type="text/css" media="all" href="/.resources/foobar/webresources/css/a~2016-12-08-02-56-06-000~cache.css"/>

Example calls:

 ${resfn.css("/travel-demo-theme.*css")} (single pattern)
 ${resfn.js("/travel-demo-theme.*js")} (single pattern)
 ${resfn.css(["/foobar.*css", ".*magnolia.*css"])} (pattern list)
 ${resfn.css(["/foobar.*css", ".*magnolia.*css"], "media='all'")} (pattern list and other properties argument with single quotes)
 ${resfn.css(["/foobar.*css", ".*magnolia.*css"], "media=\"all\"")} (pattern list and other properties argument with escaped double quotes)
 ${resfn.cachedJs(["/foobar/.*.js", "/travel-demo/.*.js"])} (call to cached files)
 

This templating functions class originates from the project neat-resources by rah003@github.com.

See Also:

https://documentation.magnolia-cms.com/display/DOCS/resfn

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CSS_SUFFIX
protected static String	JS_PREFIX
protected static String	JS_SUFFIX
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ResourcesTemplatingFunctions(info.magnolia.resourceloader.ResourceOrigin resourceOrigin, info.magnolia.module.resources.ResourceLinker linker)

Method Summary

Modifier and Type	Method and Description
String	cachedCss(List<String> patterns) Generates cached css links for all css files matching the provided pattern(s).
String	cachedCss(List<String> patterns, String otherAttributes) Generates cached css links for all css files matching the provided pattern(s); css links will contain the provided other attributes.
String	cachedCss(String pattern) Generates cached css links for all css files matching the provided pattern.
String	cachedCss(String pattern, String otherAttributes) Generates cached css links for all css files matching the provided pattern; css links will contain the provided other attributes.
String	cachedJs(List<String> patterns) Generates cached js links for all js files matching the provided pattern(s).
String	cachedJs(String pattern) Generates cached js links for all js files matching the provided pattern.
String	css(List<String> patterns) Generates css links for all css files matching the provided pattern(s).
String	css(List<String> patterns, String otherAttributes) Generates css links for all css files matching the provided pattern(s); css links will contain the provided other attributes.
String	css(String pattern) Generates css links for all css files matching the provided pattern.
String	css(String pattern, String otherAttributes) Generates css links for all css files matching the provided pattern; css links will contain the provided other attributes.
String	js(List<String> patterns) Generates js links for all js files matching provided pattern(s).
String	js(String pattern) Generates js links for all js files matching the provided pattern.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

CSS_SUFFIX

protected static final String CSS_SUFFIX

See Also:

Constant Field Values

JS_PREFIX

protected static final String JS_PREFIX

See Also:

Constant Field Values

JS_SUFFIX

protected static final String JS_SUFFIX

See Also:

Constant Field Values

Constructor Detail

ResourcesTemplatingFunctions

@Inject
public ResourcesTemplatingFunctions(info.magnolia.resourceloader.ResourceOrigin resourceOrigin,
                                            info.magnolia.module.resources.ResourceLinker linker)

Method Detail

css

public String css(String pattern)

Generates css links for all css files matching the provided pattern.

css

public String css(String pattern,
                  String otherAttributes)

Generates css links for all css files matching the provided pattern; css links will contain the provided other attributes.

css

public String css(List<String> patterns)

Generates css links for all css files matching the provided pattern(s).

css

public String css(List<String> patterns,
                  String otherAttributes)

Generates css links for all css files matching the provided pattern(s); css links will contain the provided other attributes.

cachedCss

public String cachedCss(String pattern)

Generates cached css links for all css files matching the provided pattern.

cachedCss

public String cachedCss(String pattern,
                        String otherAttributes)

Generates cached css links for all css files matching the provided pattern; css links will contain the provided other attributes.

cachedCss

public String cachedCss(List<String> patterns)

Generates cached css links for all css files matching the provided pattern(s).

cachedCss

public String cachedCss(List<String> patterns,
                        String otherAttributes)

Generates cached css links for all css files matching the provided pattern(s); css links will contain the provided other attributes.

js

public String js(String pattern)

Generates js links for all js files matching the provided pattern.

js

public String js(List<String> patterns)

Generates js links for all js files matching provided pattern(s).

cachedJs

public String cachedJs(String pattern)

Generates cached js links for all js files matching the provided pattern.

cachedJs

public String cachedJs(List<String> patterns)

Generates cached js links for all js files matching the provided pattern(s).