1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ctype.xml, last change in rev 1.1 -->
<refentry xml:id="function.ctype-cntrl" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ctype_cntrl</refname>
<refpurpose>Check for control character(s)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ctype_cntrl</methodname>
<methodparam><type>mixed</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
Checks if all of the characters in the provided <type>string</type>,
<parameter>text</parameter>, are control characters.
Control characters are e.g. line feed, tab, escape.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem>
<para>
The tested string.
¬e.ctype.parameter.integer;
¬e.ctype.parameter.non-string;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if every character in <parameter>text</parameter> is
a control character from the current locale, &false; otherwise.
&ctype.result.empty-string;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>ctype_cntrl</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$strings = array('string1' => "\n\r\t", 'string2' => 'arf12');
foreach ($strings as $name => $testcase) {
if (ctype_cntrl($testcase)) {
echo "The string '$name' consists of all control characters.\n";
} else {
echo "The string '$name' does not consist of all control characters.\n";
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
The string 'string1' consists of all control characters.
The string 'string2' does not consist of all control characters.
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ctype_print</function></member>
<member><function>IntlChar::iscntrl</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
