<!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>Check if code point is a control character</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.isblank.html">IntlChar::isblank</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.isdefined.html">IntlChar::isdefined</a></div>
<div class="up"><a href="class.intlchar.html">IntlChar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intlchar.iscntrl" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlChar::iscntrl</h1>
<p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">IntlChar::iscntrl</span> — <span class="dc-title">Check if code point is a control character</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlchar.iscntrl-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><strong>IntlChar::iscntrl</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$codepoint</code></span>
)</div>
<p class="para rdfs-comment">
Determines whether the specified code point is a control character.
</p>
<p class="para">
A control character is one of the following:
<ul class="simplelist">
<li class="member">ISO 8-bit control character (U+0000..U+001f and U+007f..U+009f)</li>
<li class="member"><strong><code>IntlChar::CHAR_CATEGORY_CONTROL_CHAR</code></strong> (Cc)</li>
<li class="member"><strong><code>IntlChar::CHAR_CATEGORY_FORMAT_CHAR</code></strong> (Cf)</li>
<li class="member"><strong><code>IntlChar::CHAR_CATEGORY_LINE_SEPARATOR</code></strong> (Zl)</li>
<li class="member"><strong><code>IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR</code></strong> (Zp)</li>
</ul>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intlchar.iscntrl-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">codepoint</code></dt>
<dd>
<p class="para">The <span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span> codepoint value (e.g. <em>0x2603</em> for <em class="emphasis">U+2603 SNOWMAN</em>), or the character encoded as a UTF-8 <span class="type"><a href="language.types.string.html" class="type string">string</a></span> (e.g. <em>"\u{2603}"</em>)</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlchar.iscntrl-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if
<code class="parameter">codepoint</code> is a control character, <strong><code>FALSE</code></strong> if not.
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlchar.iscntrl-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3222">
<p><strong>Example #1 Testing different code points</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">iscntrl</span><span style="color: #007700">(</span><span style="color: #DD0000">"A"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">iscntrl</span><span style="color: #007700">(</span><span style="color: #DD0000">" "</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">iscntrl</span><span style="color: #007700">(</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">iscntrl</span><span style="color: #007700">(</span><span style="color: #DD0000">"\u{200e}"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(false)
bool(false)
bool(true)
bool(true)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-intlchar.iscntrl-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="intlchar.isprint.html" class="function" rel="rdfs-seeAlso">IntlChar::isprint()</a> - Check if code point is a printable character</span></li>
<li class="member"><strong><code>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</code></strong></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.isblank.html">IntlChar::isblank</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.isdefined.html">IntlChar::isdefined</a></div>
<div class="up"><a href="class.intlchar.html">IntlChar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
