Package com.terminalfour.publish.handlebars.helper.channel

Class ChannelDescriptionHandlebarsHelper

java.lang.Object

com.terminalfour.publish.handlebars.helper.BaseHelper

com.terminalfour.publish.handlebars.helper.channel.ChannelDescriptionHandlebarsHelper

All Implemented Interfaces:

com.github.jknack.handlebars.Helper<Object>

@Component
public class ChannelDescriptionHandlebarsHelper
extends BaseHelper

The {{channelDescription}} handlebars helper outputs the description of the currently publishing Channel.

It should be noted that it does not take microsites into consideration.

Usage

  {{channelDescription}}
 

The channelDescription handlebars expression is a simple tag that does not contain any configurable attributes.

Constructor Summary

Constructors

Constructor	Description
ChannelDescriptionHandlebarsHelper(IChannelAPI channelApi)

Method Summary

Modifier and Type	Method	Description
String	apply(Object context, com.github.jknack.handlebars.Options options)	The apply method is the main entry point for handlebars.java helpers.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelDescriptionHandlebarsHelper

@Autowired
public ChannelDescriptionHandlebarsHelper(IChannelAPI channelApi)

Method Detail

apply

public String apply(Object context,
                    com.github.jknack.handlebars.Options options)

Description copied from class: BaseHelper

The apply method is the main entry point for handlebars.java helpers.

It is called internally by the handlebars.java engine when a matching handlebars.java expression is encountered.

Specified by:

apply in interface com.github.jknack.handlebars.Helper<Object>

Specified by:

apply in class BaseHelper

Parameters:

context - The currently executing context.

options - The options.

Returns:

The generated output.