<?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-digit" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>ctype_digit</refname>

<refpurpose>Check for numeric character(s)</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>ctype_digit</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 numerical.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>text</parameter></term>

<listitem>

<para>

The tested string.

&note.ctype.parameter.integer;

&note.ctype.parameter.non-string;

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns &true; if every character in the string

<parameter>text</parameter> is a decimal digit, &false; otherwise.

&ctype.result.empty-string;

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>A <function>ctype_digit</function> example</title>

<programlisting role="php">

<![CDATA[

<?php

$strings = array('1820.20', '10002', 'wsl!12');

foreach ($strings as $testcase) {

if (ctype_digit($testcase)) {

echo "The string $testcase consists of all digits.\n";

} else {

echo "The string $testcase does not consist of all digits.\n";

}

}

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

The string 1820.20 does not consist of all digits.

The string 10002 consists of all digits.

The string wsl!12 does not consist of all digits.

]]>

</screen>

</example>

</para>

<para>

<example>

<title>A <function>ctype_digit</function> example comparing strings with integers</title>

<programlisting role="php">

<![CDATA[

<?php

$numeric_string = '42';

$integer = 42;

ctype_digit($numeric_string); // true

ctype_digit($integer); // false (ASCII 42 is the * character)

is_numeric($numeric_string); // true

is_numeric($integer); // true

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>ctype_alnum</function></member>

<member><function>ctype_xdigit</function></member>

<member><function>is_numeric</function></member>

<member><function>is_int</function></member>

<member><function>is_string</function></member>

<member><function>IntlChar::isdigit</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

-->