org.craftercms.engine.freemarker

Class ExecuteControllerDirective

java.lang.Object

org.craftercms.engine.freemarker.ExecuteControllerDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class ExecuteControllerDirective
extends Object
implements freemarker.template.TemplateDirectiveModel

Freemarker directive that allows to execute scripts/controllers from inside Freemarker templates. The directive receives a single parameter that is that path of the controller in the site.

Author:

avasquez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecuteControllerDirective.EnvironmentGroovyBeanWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_PARAM_NAME
protected javax.servlet.ServletContext	servletContext

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
ExecuteControllerDirective()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createScriptVariables(freemarker.core.Environment env)
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body)
protected void	executeController(Script script, Map<String,Object> variables, freemarker.core.Environment env)
protected void	executeController(String path, freemarker.core.Environment env)
protected SiteItem	getContentModel(freemarker.core.Environment env)
protected String	getPath(freemarker.template.TemplateModel pathParam, freemarker.core.Environment env)
protected Object	getTemplateModel(freemarker.core.Environment env)
void	setServletContext(javax.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Field Detail

PATH_PARAM_NAME

public static final String PATH_PARAM_NAME

See Also:

Constant Field Values

servletContext

protected javax.servlet.ServletContext servletContext

Constructor Detail

ExecuteControllerDirective

public ExecuteControllerDirective()

Method Detail

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

execute

public void execute(freemarker.core.Environment env,
                    Map params,
                    freemarker.template.TemplateModel[] loopVars,
                    freemarker.template.TemplateDirectiveBody body)
             throws freemarker.template.TemplateException,
                    IOException

Specified by:

execute in interface freemarker.template.TemplateDirectiveModel

Throws:

freemarker.template.TemplateException

IOException

executeController

protected void executeController(String path,
                                 freemarker.core.Environment env)
                          throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

executeController

protected void executeController(Script script,
                                 Map<String,Object> variables,
                                 freemarker.core.Environment env)
                          throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

createScriptVariables

protected Map<String,Object> createScriptVariables(freemarker.core.Environment env)
                                            throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getPath

protected String getPath(freemarker.template.TemplateModel pathParam,
                         freemarker.core.Environment env)
                  throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getContentModel

protected SiteItem getContentModel(freemarker.core.Environment env)
                            throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getTemplateModel

protected Object getTemplateModel(freemarker.core.Environment env)
                           throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException