[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/intl/spoofchecker/_areconfusable.xml_construct.x
From: Maciej_Sobaczewski <sobak () php ! net>
Date: 2016-11-23 21:17:40
Message-ID: svn-sobak-1479935860-341114-1156253223 () svn ! php ! net
[Download RAW message or body]
sobak Wed, 23 Nov 2016 21:17:40 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=341114
Log:
Document some intl Spoofchecker methods
It also integrates user note 120216
Changed paths:
U phpdoc/en/trunk/reference/intl/spoofchecker/areconfusable.xml
U phpdoc/en/trunk/reference/intl/spoofchecker/construct.xml
U phpdoc/en/trunk/reference/intl/spoofchecker/issuspicious.xml
Modified: phpdoc/en/trunk/reference/intl/spoofchecker/areconfusable.xml
===================================================================
--- phpdoc/en/trunk/reference/intl/spoofchecker/areconfusable.xml 2016-11-23 15:27:32 \
UTC (rev 341113)
+++ phpdoc/en/trunk/reference/intl/spoofchecker/areconfusable.xml 2016-11-23 21:17:40 \
UTC (rev 341114) @@ -4,41 +4,38 @@
<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>
+ <refpurpose>Checks if given strings can be confused</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><type>string</type><parameter>string1</parameter></methodparam>
+ <methodparam><type>string</type><parameter>string2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter \
role="reference">error</parameter></methodparam> </methodsynopsis>
<para>
-
+ Checks whether two given strings can easily be mistaken.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>s1</parameter></term>
+ <term><parameter>string1</parameter></term>
<listitem>
<para>
-
+ First string to check.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>s2</parameter></term>
+ <term><parameter>string2</parameter></term>
<listitem>
<para>
-
+ Second string to check.
</para>
</listitem>
</varlistentry>
@@ -46,7 +43,8 @@
<term><parameter>error</parameter></term>
<listitem>
<para>
-
+ This variable is set by-reference to string containing an error, if there
+ were any.
</para>
</listitem>
</varlistentry>
@@ -56,11 +54,28 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns &true; if two given strings can be confused, &false; otherwise.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Spoofchecker::areConfusable</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$checker = new Spoofchecker();
+$checker->areConfusable('google.com', 'goog1e.com'); // true: lower l can be \
confused with digit one +$checker->areConfusable('google.com', 'g00g1e.com'); // \
false: zero digit cannot be confused with "o" letter +?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Modified: phpdoc/en/trunk/reference/intl/spoofchecker/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/intl/spoofchecker/construct.xml 2016-11-23 15:27:32 UTC \
(rev 341113)
+++ phpdoc/en/trunk/reference/intl/spoofchecker/construct.xml 2016-11-23 21:17:40 UTC \
(rev 341114) @@ -14,11 +14,8 @@
<void />
</methodsynopsis>
<para>
-
+ Creates new instance of Spoofchecker.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,11 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns Spoofchecker instance.
</para>
</refsect1>
-
-
</refentry>
<!-- Keep this comment at the end of the file
Modified: phpdoc/en/trunk/reference/intl/spoofchecker/issuspicious.xml
===================================================================
--- phpdoc/en/trunk/reference/intl/spoofchecker/issuspicious.xml 2016-11-23 15:27:32 \
UTC (rev 341113)
+++ phpdoc/en/trunk/reference/intl/spoofchecker/issuspicious.xml 2016-11-23 21:17:40 \
UTC (rev 341114) @@ -15,11 +15,9 @@
<methodparam choice="opt"><type>string</type><parameter \
role="reference">error</parameter></methodparam> </methodsynopsis>
<para>
-
+ Checks if given string contains any suspicious characters like letters which
+ are almost identical visually, but are Unicode characters from different sets.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,7 +27,7 @@
<term><parameter>text</parameter></term>
<listitem>
<para>
-
+ String to test.
</para>
</listitem>
</varlistentry>
@@ -37,7 +35,8 @@
<term><parameter>error</parameter></term>
<listitem>
<para>
-
+ This variable is set by-reference to string containing an error, if there
+ were any.
</para>
</listitem>
</varlistentry>
@@ -47,11 +46,28 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns &true; if there are no suspicious characters, &false; otherwise.
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>Spoofchecker::areConfusable</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$checker = new Spoofchecker();
+$checker->isSuspicious('google.com'); // true: only ASCII characters
+$checker->isSuspicious('Ð aypal.com'); // false: the first letter is from Cyrylic, \
not a regular latin "P" +?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic