Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.
Rendering context objects provide direct access to important Magnolia classes from a template script. You can get information such as the current template, user and request through these objects. Rendering content objects are set in AbstractRenderer and its child classes.
Most context objects are JavaBeans, which means you can access their properties with the "dot" operator or a getter method in a template script. Both expressions are valid and return the same value.
${ctx.aggregationState.channel.name} ${ctx.getAggregationState().getChannel().getName()}
content
Current content node in the rendering context provided as a ContentMap. In a page template, current node is the page node (mgnl:page
). In a component template, current node is the component node (mgnl:component
). It is the contextual "root" content node. The current node is exposed as a ContentMap object, which means it carries the properties of the underlying Node.
Example: Rendering a page title. Here the current node is a page node.
<h1>${content.title!""}</h1>
def
Current
RenderableDefinition
. Use def
to access the properties of the template definition such as title, or custom parameters. It is a JavaBean, which means you can access its properties with the "dot" operator or a getter method.Example: Getting a CSS class name from custom parameters and assigning it to a variable.
[#assign cssClass=def.parameters.cssClass]
model
A JavaBean created by the renderer based on the model class defined in the template definition. Not every template defines a model class. If no model is defined no bean is created and its reference is null.
Every model class must implement the RenderingModel interface which provides bean properties for:
A model can be implemented as a Java class by implementing RenderingModel, or - since Magnolia 5.5.6 - a Model can be written in JavaScript (see JavaScript Models module). The model
itself provides the following built-in properties:parent
: Model of the parent component or template.root
: Top root model of the rendering process.content
: Content node bound to the model in the rendering context provided as a ContentMap.node
: Content node bound to the model in the rendering context provided as a Node.definition
: The renderable definition (template, area or component) bound to the model. Same as def
.
These properties can referenced like this:
model.root model.node
The probably most handy property is parent
. Parent points to the parent model, its meaning depends on the case. If you have for instance a component template with a model and a page template with a model - the parent model of the component template is the model of the page template. Via parent you can access all built in properties of the parent model like this:
model.parent.definition model.parent.content
Example: Asking a model for a URL and a title, then building a link.
[#assign linkURL = model.url!] [#assign linkText = model.title!] <a href="${linkURL}">${linkText}</a>
action
A String returned by the execute()
method of the model class. Can be used for logic that has to be executed before rendering, when rendered output depends on the result of the logic, for example form field validation before rendering the field.
ctx
Context represents the environment in which the current process runs. The type is Context. It is a WebContext when the script is executed from a Web page and SimpleContext for instance when the script generates a mail from within a workflow or scheduled job. The Context interface provides access to: Please note that In addition, WebContext provides access to: Any WebContext properties are null if the execution is not a Web page request.user
(User)locale
(java.util.Locale)${ctx.locale}
is different from ${cmsfn.language()}
, the former referring to the locale currently used by the user, the latter to the locale currently used by the site. See also AdminCentral and public locales.aggregationState
(AggregationState)contextPath
(current context path)request
(javax.servlet.http.HttpServletRequest
)ctx
attributes (request, session or application scoped) listed under config:server/rendering/engine/protectedAttributes
are not exposed.'protectedAttributes':
'servletContext': 'servletContext'
[#assign queryStr = ctx.getParameter('queryStr')!?html]
state
The current AggregationState. Only set if ctx is of type WebContext. (See above.) It is a shortcut for Provides access to many properties as: Read the javadoc (AggregationState) for all the properties. Please note that the values of all the properties are HTML-escaped by default. Should you need it, the raw (unescaped) data can still be accessed in the following manner: However, be warned that this may expose your webapp to XSS attacks.ctx.aggregationState
.channel
(Channel)originalURI
currentURI
queryString
mainContentNode
(javax.jcr.Node)templateName
locale
(the same as ctx.locale
)${state.unwrap().originalURI}
i18n
A message bundle wrapper (MessagesWrapper) to retrieve translated keys of a message bundle according to the current java.util.Locale.
Use it to internationalize labels which are not stored in content. (See template labels).
Example:
i18n["link.readon"]