Location: PHPKode > projects > Open Power Template > docs/Opt/syntax.functions.entity.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="pl">
<head>
	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
	<meta name="robots" content="all" />

	<title>entity() - Open Power Template</title>
	
	<link rel="stylesheet" type="text/css" href="design/generic.css" media="all"  />
	<link rel="stylesheet" type="text/css" href="design/print.css" media="print" />
	<!--[if lte IE 6]><link rel="stylesheet" href="design/ie.css" type="text/css" /><![endif]-->	
	<!--[if IE 7]><link rel="stylesheet" href="design/ie7.css" type="text/css" /><![endif]-->
</head>
<body>

<div id="wrap">
	<div id="header">
		<h1>Open Power Template 2.0</h1>
		<h2>entity()</h2>
		<p class="generated">@ 02.09.2010</p>
		<p class="location"><a href="index.html"><strong>User manual</strong></a> &raquo; <a href="syntax.html">Template syntax</a> &raquo; <a href="syntax.functions.html">Function reference</a> &raquo; <a href="syntax.functions.entity.html">entity()</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="syntax.functions.html">3.6. Function reference</a><br/>3.6.13. entity()</dt><dd class="prev">3.6.12. date()<br/><a href="syntax.functions.date.html">&laquo; Previous</a></dd><dd class="next">3.6.14. firstof()<br/><a href="syntax.functions.firstof.html">Next &raquo;</a></dd></dl>	<h1>3.6.13. entity()</h1><div class="tf_reference"><table><tr><th>Reference</th><td><code>string entity(string)</code></td></tr></table><hr/></div><p>Allows to display an entity in the output document.</p>

<p>Because OPT contains an XML parser, all the entities are parsed on the server-side. Usually, this is not a bad thing, because the entities have been introduced mostly for the user convenience and the web browser is able to handle both the entities and the original characters. However, in certain situations it may be necessary to send the entity in the browser. We cannot prevent the parser from processing it, so we may use this function to encode it:</p>

<pre class="xml"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;p<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>An example of <span style="color: #ddbb00;">&amp;amp;</span>Acute; entity: {u:entity('Acute')}<span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/p<span style="color: #000000; font-weight: bold;">&gt;</span></span></span></pre>

<p>The result would be:</p>

<pre class="xml"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;p<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>An example of <span style="color: #ddbb00;">&amp;amp;</span>Acute; entity: <span style="color: #ddbb00;">&amp;Acute;</span><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/p<span style="color: #000000; font-weight: bold;">&gt;</span></span></span></pre>

<blockquote class="error">
  <p>In order to work, this function <strong>must not</strong> be escaped. The best way to achieve this is to prepend the expression with <code>u:</code> modifier.</p>
</blockquote>

<p>The function recognizes any valid XML entity name (excluding Unicode symbols), for example <code>Acute</code>, <code>#184</code> and <code>#xB8</code>. If the function is not able to parse the entity name, it generates an exception which is captured by the script.</p>
<h4>See also:</h4><ul><li><a href="syntax.entities.html">3.4. Entities</a></li></ul><dl class="location location-bottom"><dt>3.6.13. entity()<br/><a href="syntax.functions.html">3.6. Function reference</a></dt><dd class="prev"><a href="syntax.functions.date.html">&laquo; Previous</a><br/>3.6.12. date()</dd><dd class="next"><a href="syntax.functions.firstof.html">Next &raquo;</a><br/>3.6.14. firstof()</dd></dl>		</div>
	
	<div id="footer">
		<p>Copyright &copy; <a href="http://www.invenzzia.org/">Invenzzia Group 2008-2009</a></p>
		<p>Available under the terms of license: <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License 1.2</a></p>
		<p>Generated by <strong>TypeFriendly 0.1.4</strong> by <a href="http://www.invenzzia.org/">Invenzzia</a></p>
	</div>
</div>

</body>
</html>
Return current item: Open Power Template