php-doc-en/reference/mbstring/functions/mb-check-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mb-check-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_check_encoding</refname>
  <refpurpose>Check if the string is valid for the specified encoding</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>mb_check_encoding</methodname>
   <methodparam choice="opt"><type>string</type><parameter>var</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
  </methodsynopsis>
  <para>
   Checks if the specified byte stream is valid for the specified encoding.
   It is useful to prevent so-called "Invalid Encoding Attack".
  </para>
  <para>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>var</parameter></term>
     <listitem>
      <para>
       The byte stream to check. If it is omitted, this function checks
       all the input from the beginning of the request.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       The expected encoding.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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:"../../../../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
-->