<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Perform case folding on a string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-check-encoding.html">mb_check_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-convert-encoding.html">mb_convert_encoding</a></div>
<div class="up"><a href="ref.mbstring.html">Multibyte String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mb-convert-case" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_convert_case</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">mb_convert_case</span> — <span class="dc-title">Perform case folding on a string</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mb-convert-case-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mb_convert_case</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code><span class="initializer"> = mb_internal_encoding()</span></span>
] )</div>
<p class="para rdfs-comment">
Performs case folding on a <span class="type"><a href="language.types.string.html" class="type string">string</a></span>, converted in the way specified by
<em><code class="parameter">mode</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mb-convert-case-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">str</code></em></span>
<dd>
<p class="para">
The <span class="type"><a href="language.types.string.html" class="type string">string</a></span> being converted.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The mode of the conversion. It can be one of
<strong><code>MB_CASE_UPPER</code></strong>,
<strong><code>MB_CASE_LOWER</code></strong>, or
<strong><code>MB_CASE_TITLE</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">encoding</code></em></span>
<dd>
<p class="para">The <em><code class="parameter">encoding</code></em>
parameter is the character encoding. If it is omitted, the internal character
encoding value will be used.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mb-convert-case-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A case folded version of <em><code class="parameter">string</code></em> converted in the
way specified by <em><code class="parameter">mode</code></em>.
</p>
</div>
<div class="refsect1 unicode" id="refsect1-function.mb-convert-case-unicode">
<h3 class="title">Unicode</h3>
<p class="para">
By contrast to the standard case folding functions such as
<span class="function"><a href="function.strtolower.html" class="function">strtolower()</a></span> and <span class="function"><a href="function.strtoupper.html" class="function">strtoupper()</a></span>,
case folding is performed on the basis of the Unicode character
properties. Thus the behaviour of this function is not affected
by locale settings and it can convert any characters that have
'alphabetic' property, such as A-umlaut (Ä).
</p>
<p class="para">
For more information about the Unicode properties, please see <a href="http://www.unicode.org/unicode/reports/tr21/" class="link external">» http://www.unicode.org/unicode/reports/tr21/</a>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mb-convert-case-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2699">
<p><strong>Example #1 <span class="function"><strong>mb_convert_case()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$str </span><span style="color: #007700">= </span><span style="color: #DD0000">"mary had a Little lamb and she loved it so"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_case</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">MB_CASE_UPPER</span><span style="color: #007700">, </span><span style="color: #DD0000">"UTF-8"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$str</span><span style="color: #007700">; </span><span style="color: #FF8000">// Prints MARY HAD A LITTLE LAMB AND SHE LOVED IT SO<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_case</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">MB_CASE_TITLE</span><span style="color: #007700">, </span><span style="color: #DD0000">"UTF-8"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$str</span><span style="color: #007700">; </span><span style="color: #FF8000">// Prints Mary Had A Little Lamb And She Loved It So<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-2700">
<p><strong>Example #2 <span class="function"><strong>mb_convert_case()</strong></span> example with non-Latin UTF-8 text</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$str </span><span style="color: #007700">= </span><span style="color: #DD0000">"Τάχιστη αλώπηξ βαφής ψημένη γη, δρασκελίζει υπέρ νωθρού κυνός"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_case</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">MB_CASE_UPPER</span><span style="color: #007700">, </span><span style="color: #DD0000">"UTF-8"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$str</span><span style="color: #007700">; </span><span style="color: #FF8000">// Prints ΤΆΧΙΣΤΗ ΑΛΏΠΗΞ ΒΑΦΉΣ ΨΗΜΈΝΗ ΓΗ, ΔΡΑΣΚΕΛΊΖΕΙ ΥΠΈΡ ΝΩΘΡΟΎ ΚΥΝΌΣ<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_case</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">MB_CASE_TITLE</span><span style="color: #007700">, </span><span style="color: #DD0000">"UTF-8"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$str</span><span style="color: #007700">; </span><span style="color: #FF8000">// Prints Τάχιστη Αλώπηξ Βαφήσ Ψημένη Γη, Δρασκελίζει Υπέρ Νωθρού Κυνόσ<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.mb-convert-case-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.mb-strtolower.html" class="function" rel="rdfs-seeAlso">mb_strtolower()</a> - Make a string lowercase</span></li>
<li class="member"> <span class="function"><a href="function.mb-strtoupper.html" class="function" rel="rdfs-seeAlso">mb_strtoupper()</a> - Make a string uppercase</span></li>
<li class="member"> <span class="function"><a href="function.strtolower.html" class="function" rel="rdfs-seeAlso">strtolower()</a> - Make a string lowercase</span></li>
<li class="member"> <span class="function"><a href="function.strtoupper.html" class="function" rel="rdfs-seeAlso">strtoupper()</a> - Make a string uppercase</span></li>
<li class="member"> <span class="function"><a href="function.ucfirst.html" class="function" rel="rdfs-seeAlso">ucfirst()</a> - Make a string's first character uppercase</span></li>
<li class="member"> <span class="function"><a href="function.ucwords.html" class="function" rel="rdfs-seeAlso">ucwords()</a> - Uppercase the first character of each word in a string</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-check-encoding.html">mb_check_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-convert-encoding.html">mb_convert_encoding</a></div>
<div class="up"><a href="ref.mbstring.html">Multibyte String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
