Location: PHPKode > projects > Open Power Template > docs/Opt/syntax.functions.truncate.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>truncate() - 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>truncate()</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.truncate.html">truncate()</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="syntax.functions.html">3.6. Function reference</a><br/>3.6.34. truncate()</dt><dd class="prev">3.6.33. sum()<br/><a href="syntax.functions.sum.html">&laquo; Previous</a></dd><dd class="next">3.6.35. upper()<br/><a href="syntax.functions.upper.html">Next &raquo;</a></dd></dl>	<h1>3.6.34. truncate()</h1><div class="tf_reference"><table><tr><th>Reference</th><td><code>string truncate(string $text, integer $length [, string $ending [, boolean $breakWords ]])</code></td></tr></table><hr/></div><p>Truncates the text <code>$text</code> to the specified <code>$length</code>. Optionally, you might define the <code>$ending</code> that is added to the <code>$text</code>, if it has been truncated. The last argument allows to control if the function might break words (<strong>true</strong>, default value) or not (<strong>false</strong>). Below you can see a sample results for the text <code>This is a very long text that needs to be truncated</code>:</p>

<pre class="xml">{@text is 'This is a very long text that needs to be truncated'}
&nbsp;
<span style="color: #808080; font-style: italic;">&lt;!-- result: &quot;This is a very lo&quot; --&gt;</span>
{truncate(@text, 17)}
&nbsp;
<span style="color: #808080; font-style: italic;">&lt;!-- result: &quot;This is a very lo...&quot; --&gt;</span>
{truncate(@text, 17, '...')}
&nbsp;
<span style="color: #808080; font-style: italic;">&lt;!-- result: &quot;This is a very long text that needs to be truncated&quot; --&gt;</span>
{truncate(@text, 500, '...')}
&nbsp;
<span style="color: #808080; font-style: italic;">&lt;!-- result: &quot;This is a very...&quot; --&gt;</span>
{truncate(@text, 17, '...', false)}</pre>

<blockquote class="information">
  <p>This function can operate also on a container of strings, truncating them all and returning the modified container.</p>
</blockquote>
<dl class="location location-bottom"><dt>3.6.34. truncate()<br/><a href="syntax.functions.html">3.6. Function reference</a></dt><dd class="prev"><a href="syntax.functions.sum.html">&laquo; Previous</a><br/>3.6.33. sum()</dd><dd class="next"><a href="syntax.functions.upper.html">Next &raquo;</a><br/>3.6.35. upper()</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