Source of: /manual/en/function.mb-strimwidth.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mbstring.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mb-strimwidth.php',
1 => 'mb_strimwidth',
),
'up' =>
array (
0 => 'ref.mbstring.php',
1 => 'Multibyte String Functions',
),
'prev' =>
array (
0 => 'function.mb-strcut.php',
1 => 'mb_strcut',
),
'next' =>
array (
0 => 'function.mb-stripos.php',
1 => 'mb_stripos',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mb-strimwidth" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_strimwidth</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">mb_strimwidth</span> — <span class="dc-title">Get truncated string with specified width</span></p>
</div>
<a name="function.mb-strimwidth.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>mb_strimwidth</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$str</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$start</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$width</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$trimmarker</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$encoding</tt></span>
]] )</div>
<p class="para rdfs-comment">
Truncates <a href="language.types.string.php" class="type string">string</a> <i><tt class="parameter">str</tt></i>
to specified <i><tt class="parameter">width</tt></i>
.
</p>
</div>
<a name="function.mb-strimwidth.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">str</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The <a href="language.types.string.php" class="type string">string</a> being decoded.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">start</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The start position offset. Number of
characters from the beginning of string. (First character is 0)
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">width</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The width of the desired trim.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">trimmarker</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A string that is added to the end of string
when string is truncated.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">encoding</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The <i><tt class="parameter">encoding</tt></i>
parameter is the character encoding. If it is omitted, the internal character
encoding value will be used.</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mb-strimwidth.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The truncated <a href="language.types.string.php" class="type string">string</a>. If <i><tt class="parameter">trimmarker</tt></i>
is set,
<i><tt class="parameter">trimmarker</tt></i>
is appended to the return value.
</p>
</div>
<a name="function.mb-strimwidth.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mb_strimwidth()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_strimwidth</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">40</span><span style="color: #007700">, </span><span style="color: #DD0000">"..>"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.mb-strimwidth.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mb-strwidth.php" class="function" rel="rdfs-seeAlso">mb_strwidth()</a> - Return width of string</li>
<li class="member"><a href="function.mb-internal-encoding.php" class="function" rel="rdfs-seeAlso">mb_internal_encoding()</a> - Set/Get internal character encoding</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
