mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
82124f4826
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341291 c90b9560-bf6c-de11-be94-00142212c4b1
93 lines
2.5 KiB
XML
93 lines
2.5 KiB
XML
<?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>
|
||
Checks if given string contains any suspicious characters like letters which
|
||
are almost identical visually, but are Unicode characters from different sets.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>text</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
String to test.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<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>
|
||
</variablelist>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
Returns &true; if there are suspicious characters, &false; otherwise.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><function>Spoofchecker::isSuspicious</function> example</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$checker = new Spoofchecker();
|
||
|
||
$checker->isSuspicious('google.com'); // FALSE: only ASCII characters
|
||
|
||
$checker->isSuspicious('Рaypal.com'); // TRUE
|
||
// 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
|
||
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
|
||
-->
|