<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The Spoofchecker class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="resourcebundle.locales.html">ResourceBundle::getLocales</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spoofchecker.areconfusable.html">Spoofchecker::areConfusable</a></div>
<div class="up"><a href="book.intl.html">intl</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.spoofchecker" class="reference">
<h1 class="title">The Spoofchecker class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.4.0, PHP 7, PECL intl >= 2.0.0)</p>
<div class="section" id="spoofchecker.intro">
<h2 class="title">Introduction</h2>
<p class="para">
This class is provided because Unicode contains large number of characters
and incorporates the varied writing systems of the world and their incorrect
usage can expose programs or systems to possible security attacks using
characters similarity.
</p>
<p class="para">
Provided methods allow to check whether an individual string is likely an attempt
at confusing the reader (<em>spoof detection</em>), such as "pаypаl"
spelled with Cyrillic 'а' characters.
</p>
</div>
<div class="section" id="spoofchecker.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Spoofchecker</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.spoofchecker.html#spoofchecker.constants.single-script-confusable"><var class="varname">SINGLE_SCRIPT_CONFUSABLE</var></a></var>
<span class="initializer"> = 1</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.spoofchecker.html#spoofchecker.constants.mixed-script-confusable"><var class="varname">MIXED_SCRIPT_CONFUSABLE</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.spoofchecker.html#spoofchecker.constants.whole-script-confusable"><var class="varname">WHOLE_SCRIPT_CONFUSABLE</var></a></var>
<span class="initializer"> = 4</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.spoofchecker.html#spoofchecker.constants.any-case"><var class="varname">ANY_CASE</var></a></var>
<span class="initializer"> = 8</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.spoofchecker.html#spoofchecker.constants.single-script"><var class="varname">SINGLE_SCRIPT</var></a></var>
<span class="initializer"> = 16</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.spoofchecker.html#spoofchecker.constants.invisible"><var class="varname">INVISIBLE</var></a></var>
<span class="initializer"> = 32</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.spoofchecker.html#spoofchecker.constants.char-limit"><var class="varname">CHAR_LIMIT</var></a></var>
<span class="initializer"> = 64</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="spoofchecker.areconfusable.html" class="methodname">areConfusable</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str1</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$str2</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$error</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="spoofchecker.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="spoofchecker.issuspicious.html" class="methodname">isSuspicious</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$text</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$error</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spoofchecker.setallowedlocales.html" class="methodname">setAllowedLocales</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$locale_list</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spoofchecker.setchecks.html" class="methodname">setChecks</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$checks</code></span>
)</div>
}</div>
</div>
<div class="section" id="spoofchecker.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="spoofchecker.constants.single-script-confusable"><strong><code>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="spoofchecker.constants.mixed-script-confusable"><strong><code>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="spoofchecker.constants.whole-script-confusable"><strong><code>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="spoofchecker.constants.any-case"><strong><code>Spoofchecker::ANY_CASE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="spoofchecker.constants.single-script"><strong><code>Spoofchecker::SINGLE_SCRIPT</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="spoofchecker.constants.invisible"><strong><code>Spoofchecker::INVISIBLE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="spoofchecker.constants.char-limit"><strong><code>Spoofchecker::CHAR_LIMIT</code></strong></dt>
<dd>
<p class="para"/>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="spoofchecker.areconfusable.html">Spoofchecker::areConfusable</a> — Checks if given strings can be confused</li><li><a href="spoofchecker.construct.html">Spoofchecker::__construct</a> — Constructor</li><li><a href="spoofchecker.issuspicious.html">Spoofchecker::isSuspicious</a> — Checks if a given text contains any suspicious characters</li><li><a href="spoofchecker.setallowedlocales.html">Spoofchecker::setAllowedLocales</a> — Locales to use when running checks</li><li><a href="spoofchecker.setchecks.html">Spoofchecker::setChecks</a> — Set the checks to run</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="resourcebundle.locales.html">ResourceBundle::getLocales</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spoofchecker.areconfusable.html">Spoofchecker::areConfusable</a></div>
<div class="up"><a href="book.intl.html">intl</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
