| <!doctype html> |
| <!-- Generated by FreeMarker/Docgen from DocBook --> |
| <html lang="en" class="page-type-section"> |
| <head prefix="og: http://ogp.me/ns#"> |
| <meta charset="utf-8"> |
| <title>Variables - FreeMarker Manual</title> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="format-detection" content="telephone=no"> |
| <meta property="og:site_name" content="FreeMarker Manual"> |
| <meta property="og:title" content="Variables"> |
| <meta property="og:locale" content="en_US"> |
| <meta property="og:url" content="http://example.com/pgui_misc_var.html"> |
| <link rel="canonical" href="http://example.com/pgui_misc_var.html"> |
| <link rel="icon" href="favicon.png" type="image/png"> |
| <link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338517553"> |
| </head> |
| <body itemscope itemtype="https://schema.org/Code"> |
| <meta itemprop="url" content="http://example.com/"> |
| <meta itemprop="name" content="FreeMarker Manual"> |
| |
| <!--[if lte IE 9]> |
| <div style="background-color: #C00; color: #fff; padding: 12px 24px;">Please use a modern browser to view this website.</div> |
| <![endif]--><div class="header-top-bg"><div class="site-width header-top"><a class="logo" href="http://example.com" role="banner"> <img itemprop="image" src="logo.png" alt="My Logo"> |
| </a></div></div><div class="header-bottom-bg"><div class="site-width search-row"><a href="index.html" class="navigation-header">FreeMarker Manual</a><div class="navigation-header"></div></div><div class="site-width breadcrumb-row"><ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="index.html"><span itemprop="name">FreeMarker Manual</span></a></li><li class="step-1" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui.html"><span itemprop="name">Programmer's Guide</span></a></li><li class="step-2" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc.html"><span itemprop="name">Miscellaneous</span></a></li><li class="step-3" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc_var.html"><span itemprop="name">Variables</span></a></li></ul><div class="bookmarks" title="Bookmarks"><span class="sr-only">Bookmarks:</span><ul class="bookmark-list"><li><a href="alphaidx.html">Index</a></li><li><a href="gloss.html">Glossary</a></li><li><a href="ref.html">Reference</a></li><li><a href="app_faq.html">FAQ</a></li><li><a href="preface.html#test_target">Bőregér</a></li></ul></div></div></div> <div class="main-content site-width"> |
| <div class="content-wrapper no-toc"> |
| <div id="table-of-contents-wrapper" class="col-left"> |
| </div> |
| <div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="pgui_misc.html"><span>Previous</span></a><a class="paging-arrow next" href="pgui_misc_charset.html"><span>Next</span></a></div><div class="title-wrapper"> |
| <h1 class="content-header header-section1" id="pgui_misc_var" itemprop="headline">Variables</h1> |
| </div></div><p>This chapter explains what happens when a template tries to |
| access a variable, and how the variables are stored.</p><p>When you call <code class="inline-code">Template.process</code> it will |
| internally create an <code class="inline-code">Environment</code> object that will |
| be in use until <code class="inline-code">process</code> returns. This object stores |
| the runtime state of template processing. Among other things, it |
| stores the variables created by the template with directives like |
| <code class="inline-code">assign</code>, <code class="inline-code">macro</code>, |
| <code class="inline-code">local</code> or <code class="inline-code">global</code>. It never tries |
| to modify the data-model object that you pass to the |
| <code class="inline-code">process</code> call, nor does it create or replace shared |
| variables stored in the configuration.</p><p>When you try to read a variable, FreeMarker will seek the |
| variable in this order, and stops when it finds a variable with the |
| right name:</p><div class="orderedlist"><ol type="1"> |
| <li> |
| <p>In the Environment:</p> |
| |
| <div class="orderedlist"><ol type="1"> |
| <li> |
| <p>If you are in a loop, in the set of loop variables. Loop |
| variables are the variables created by directives like |
| <code class="inline-code">list</code>.</p> |
| </li> |
| |
| <li> |
| <p>If you are inside a macro, in the local variable set of |
| the macro. Local variables can be created with the |
| <code class="inline-code">local</code> directive. Also, the parameters of |
| macros are local variables.</p> |
| </li> |
| |
| <li> |
| <p>In the current <a href="dgui_misc_namespace.html">namespace</a>. You can put |
| variables into a namespace with the <code class="inline-code">assign</code> |
| directive.</p> |
| </li> |
| |
| <li> |
| <p>In the set of variables created with |
| <code class="inline-code">global</code> directive. FTL handles these |
| variables as if they were normal members of the data-model. |
| That is, they are visible in all namespaces, and you can |
| access them as if they would be in the data-model.</p> |
| </li> |
| </ol></div> |
| </li> |
| |
| <li> |
| <p>In the data-model object you have passed to the |
| <code class="inline-code">process</code> method</p> |
| </li> |
| |
| <li> |
| <p>In the set of shared variables stored in the |
| <code class="inline-code">Configuration</code></p> |
| </li> |
| </ol></div><p>In practice, from the viewpoint of template authors these 6 |
| layers are only 4 layers, since from that viewpoint the last 3 layers |
| (variables created with <code class="inline-code">global</code>, the actual |
| data-model object, shared variables) together constitute the set of |
| global variables.</p><p>Note that it is possible to get variables from a specific layer |
| in FTL with <a href="ref_specvar.html">special |
| variables</a>.</p><div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="pgui_misc.html"><span>Previous</span></a><a class="paging-arrow next" href="pgui_misc_charset.html"><span>Next</span></a></div></div></div></div> </div> |
| </div> |
| <div class="site-footer"><div class="site-width"><div class="footer-bottom"> <p class="last-generated"> |
| Last generated: |
| <time itemprop="dateModified" datetime="2020-07-09T23:48:37Z" title="Thursday, July 9, 2020 11:48:37 PM GMT">2020-07-09 23:48:37 GMT</time> </p> |
| <p class="copyright"> |
| © <span itemprop="copyrightYear">1999</span>–2020 |
| <a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="https://apache.org/">The Apache Software Foundation</a> </p> |
| </div></div></div></body> |
| </html> |
