mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
201dc3748c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@291313 c90b9560-bf6c-de11-be94-00142212c4b1
141 lines
4 KiB
XML
141 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xml:id="normalizer.isnormalized">
|
|
<refnamediv>
|
|
<refname>Normalizer::isNormalized</refname>
|
|
<refname>normalizer_is_normalized</refname>
|
|
<refpurpose>
|
|
Checks if the provided string is already in the specified normalization
|
|
form.
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>Object oriented style</para>
|
|
<methodsynopsis>
|
|
<modifier>static</modifier>
|
|
<type>bool</type>
|
|
<methodname>Normalizer::isNormalized</methodname>
|
|
<methodparam><type>string</type><parameter>input</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>form</parameter><initializer>Normalizer::FORM_C</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>Procedural style</para>
|
|
<methodsynopsis>
|
|
<type>bool</type>
|
|
<methodname>normalizer_is_normalized</methodname>
|
|
<methodparam><type>string</type><parameter>input</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>form</parameter><initializer>Normalizer::FORM_C</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Checks if the provided string is already in the specified normalization
|
|
form.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>input</parameter></term>
|
|
<listitem>
|
|
<para>The input string to normalize</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>form</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of the normalization forms.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>&true; if normalized, &false; otherwise or if there an error</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>
|
|
<function>normalizer_is_normalized</function> example
|
|
</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$char_A_ring = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
|
|
$char_combining_ring_above = "\xCC\x8A"; // 'COMBINING RING ABOVE' (U+030A)
|
|
|
|
$char_orig = 'A' . $char_combining_ring_above;
|
|
$char_norm = normalizer_normalize( 'A' . $char_combining_ring_above, Normalizer::FORM_C );
|
|
|
|
echo ( normalizer_is_normalized($char_orig, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
|
|
echo '; ';
|
|
echo ( normalizer_is_normalized($char_norm, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>OO example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$char_A_ring = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
|
|
$char_combining_ring_above = "\xCC\x8A"; // 'COMBINING RING ABOVE' (U+030A)
|
|
|
|
$char_orig = 'A' . $char_combining_ring_above;
|
|
$char_norm = Normalizer::normalize( 'A' . $char_combining_ring_above, Normalizer::FORM_C );
|
|
|
|
echo ( Normalizer::isNormalized($char_orig, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
|
|
echo '; ';
|
|
echo ( Normalizer::isNormalized($char_norm, Normalizer::FORM_C) ) ? "normalized" : "not normalized";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
not normalized; normalized
|
|
]]>
|
|
</screen>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>normalizer_normalize</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
|
|
-->
|