From 32e2df4de3c948596019437e756fb95b433c2113 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Thu, 30 Jun 2011 20:20:13 +0000
Subject: [PATCH] Spoofchecker prototype

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@312728 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/intl/book.xml                       |   1 +
 reference/intl/spoofchecker.xml               | 172 ++++++++++++++++++
 reference/intl/spoofchecker/areconfusable.xml |  85 +++++++++
 reference/intl/spoofchecker/construct.xml     |  58 ++++++
 reference/intl/spoofchecker/issuspicious.xml  |  76 ++++++++
 .../intl/spoofchecker/setallowedlocales.xml   |  67 +++++++
 reference/intl/spoofchecker/setchecks.xml     |  67 +++++++
 7 files changed, 526 insertions(+)
 create mode 100644 reference/intl/spoofchecker.xml
 create mode 100644 reference/intl/spoofchecker/areconfusable.xml
 create mode 100644 reference/intl/spoofchecker/construct.xml
 create mode 100644 reference/intl/spoofchecker/issuspicious.xml
 create mode 100644 reference/intl/spoofchecker/setallowedlocales.xml
 create mode 100644 reference/intl/spoofchecker/setchecks.xml

diff --git a/reference/intl/book.xml b/reference/intl/book.xml
index 6c616267c2..672b47e2ea 100644
--- a/reference/intl/book.xml
+++ b/reference/intl/book.xml
@@ -95,6 +95,7 @@
  &reference.intl.messageformatter;
  &reference.intl.dateformatter; 
  &reference.intl.resourcebundle;
+ &reference.intl.spoofchecker;
  &reference.intl.transliterator;
 
  &reference.intl.grapheme;
diff --git a/reference/intl/spoofchecker.xml b/reference/intl/spoofchecker.xml
new file mode 100644
index 0000000000..8a75949674
--- /dev/null
+++ b/reference/intl/spoofchecker.xml
@@ -0,0 +1,172 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.spoofchecker" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The Spoofchecker class</title>
+ <titleabbrev>Spoofchecker</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ Spoofchecker intro -->
+  <section xml:id="spoofchecker.intro">
+   &reftitle.intro;
+   <para>
+
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="spoofchecker.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>Spoofchecker</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>Spoofchecker</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    <classsynopsisinfo role="comment">Constants</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="spoofchecker.constants.single-script-confusable">Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</varname>
+     <initializer>1</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="spoofchecker.constants.mixed-script-confusable">Spoofchecker::MIXED_SCRIPT_CONFUSABLE</varname>
+     <initializer>2</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="spoofchecker.constants.whole-script-confusable">Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</varname>
+     <initializer>4</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="spoofchecker.constants.any-case">Spoofchecker::ANY_CASE</varname>
+     <initializer>8</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="spoofchecker.constants.single-script">Spoofchecker::SINGLE_SCRIPT</varname>
+     <initializer>16</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="spoofchecker.constants.invisible">Spoofchecker::INVISIBLE</varname>
+     <initializer>32</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>integer</type>
+     <varname linkend="spoofchecker.constants.char-limit">Spoofchecker::CHAR_LIMIT</varname>
+     <initializer>64</initializer>
+    </fieldsynopsis>
+    
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spoofchecker')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+  
+<!-- {{{ Spoofchecker constants -->
+  <section xml:id="spoofchecker.constants">
+   &reftitle.constants;
+   <section xml:id="spoofchecker.constants.types">
+    <title>Spoofchecker Node Types</title>
+    <variablelist>
+
+     <varlistentry xml:id="spoofchecker.constants.single-script-confusable">
+      <term><constant>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</constant></term>
+      <listitem>
+       <para></para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="spoofchecker.constants.mixed-script-confusable">
+      <term><constant>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</constant></term>
+      <listitem>
+       <para></para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="spoofchecker.constants.whole-script-confusable">
+      <term><constant>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</constant></term>
+      <listitem>
+       <para></para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="spoofchecker.constants.any-case">
+      <term><constant>Spoofchecker::ANY_CASE</constant></term>
+      <listitem>
+       <para></para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="spoofchecker.constants.single-script">
+      <term><constant>Spoofchecker::SINGLE_SCRIPT</constant></term>
+      <listitem>
+       <para></para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="spoofchecker.constants.invisible">
+      <term><constant>Spoofchecker::INVISIBLE</constant></term>
+      <listitem>
+       <para></para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="spoofchecker.constants.char-limit">
+      <term><constant>Spoofchecker::CHAR_LIMIT</constant></term>
+      <listitem>
+       <para></para>
+      </listitem>
+     </varlistentry>
+
+    </variablelist>
+   </section>
+  </section>
+<!-- }}} -->
+
+
+ </partintro>
+
+ &reference.intl.entities.spoofchecker;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
diff --git a/reference/intl/spoofchecker/areconfusable.xml b/reference/intl/spoofchecker/areconfusable.xml
new file mode 100644
index 0000000000..ff267bc24f
--- /dev/null
+++ b/reference/intl/spoofchecker/areconfusable.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="spoofchecker.areconfusable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Spoofchecker::areConfusable</refname>
+  <refpurpose>Checks if a given text contains any confusable characters</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>Spoofchecker::areConfusable</methodname>
+   <methodparam><type>string</type><parameter>s1</parameter></methodparam>
+   <methodparam><type>string</type><parameter>s2</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>s1</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>s2</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>error</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </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
+-->
diff --git a/reference/intl/spoofchecker/construct.xml b/reference/intl/spoofchecker/construct.xml
new file mode 100644
index 0000000000..d4ccae472c
--- /dev/null
+++ b/reference/intl/spoofchecker/construct.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="spoofchecker.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Spoofchecker::__construct</refname>
+  <refpurpose>Constructor</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>Spoofchecker::__construct</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </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
+-->
diff --git a/reference/intl/spoofchecker/issuspicious.xml b/reference/intl/spoofchecker/issuspicious.xml
new file mode 100644
index 0000000000..9e2e85f3d2
--- /dev/null
+++ b/reference/intl/spoofchecker/issuspicious.xml
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="spoofchecker.issuspicious" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Spoofchecker::isSuspicious</refname>
+  <refpurpose>Checks if a given text contains any suspicious characters</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>Spoofchecker::isSuspicious</methodname>
+   <methodparam><type>string</type><parameter>text</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>text</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>error</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </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
+-->
diff --git a/reference/intl/spoofchecker/setallowedlocales.xml b/reference/intl/spoofchecker/setallowedlocales.xml
new file mode 100644
index 0000000000..a601ab8a43
--- /dev/null
+++ b/reference/intl/spoofchecker/setallowedlocales.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="spoofchecker.setallowedlocales" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Spoofchecker::setAllowedLocales</refname>
+  <refpurpose>Locales to use when running checks</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Spoofchecker::setAllowedLocales</methodname>
+   <methodparam><type>string</type><parameter>locale_list</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>locale_list</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </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
+-->
diff --git a/reference/intl/spoofchecker/setchecks.xml b/reference/intl/spoofchecker/setchecks.xml
new file mode 100644
index 0000000000..a6fe8b5b16
--- /dev/null
+++ b/reference/intl/spoofchecker/setchecks.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="spoofchecker.setchecks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Spoofchecker::setChecks</refname>
+  <refpurpose>Set the checks to run</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Spoofchecker::setChecks</methodname>
+   <methodparam><type>string</type><parameter>checks</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>checks</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </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
+-->