<?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-punct" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ctype_punct</refname>
  <refpurpose>
   Check for any printable character which is not whitespace or an
   alphanumeric character
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ctype_punct</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 punctuation character.
  </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 <parameter>text</parameter> 
   is printable, but neither letter, digit or blank, &false; otherwise.
   &ctype.result.empty-string;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>ctype_punct</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$strings = array('ABasdk!@!$#', '!@ # $', '*&$()');
foreach ($strings as $testcase) {
    if (ctype_punct($testcase)) {
        echo "The string $testcase consists of all punctuation.\n";
    } else {
        echo "The string $testcase does not consist of all punctuation.\n";
    }
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
The string ABasdk!@!$# does not consist of all punctuation.
The string !@ # $ does not consist of all punctuation.
The string *&$() consists of all punctuation.
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ctype_cntrl</function></member>
    <member><function>ctype_graph</function></member>
    <member><function>IntlChar::ispunct</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
-->
