Location: PHPKode > projects > Open Power Template > docs/Opt/syntax.functions.pad.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>pad() - 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>pad()</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.pad.html">pad()</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="syntax.functions.html">3.6. Function reference</a><br/>3.6.22. pad()</dt><dd class="prev">3.6.21. number()<br/><a href="syntax.functions.number.html">&laquo; Previous</a></dd><dd class="next">3.6.23. pluralize()<br/><a href="syntax.functions.pluralize.html">Next &raquo;</a></dd></dl>	<h1>3.6.22. pad()</h1><div class="tf_reference"><table><tr><th>Reference</th><td><code>mixed pad(mixed $value, int $length [, string $padString, [, string $paddingType]])</code></td></tr><tr><th>Versions</th><td>since <code>2.0.5</code></td></tr>
</table><hr/></div><p>Pads a string <code>$value</code> to a certain length with another string. If the input string length is greater than or equal to <code>$length</code>, no padding takes place. Otherwise, the string is padded with <code>$padSymbol</code> symbols which are spaces by default. <code>$paddingType</code> specifies the padding type:</p>

<h2><code>right</code> - pads on the right (default)</h2>

<h2><code>left</code> - pads on the left.</h2>

<h2><code>both</code> - pads on the both sides.</h2>

<blockquote class="warning">
  <p><code>$padString</code> can be truncated if the number of padded characters is not evenly divided by the <code>$padSymbol</code> length.</p>
</blockquote>

<!-- .. -->

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