Spoofchecker::setAllowedChars

(PHP 8 >= 8.4.0)

Spoofchecker::setAllowedChars — チェック時に許可する文字集合を設定する

説明

public function Spoofchecker::setAllowedChars(string $pattern, int $patternOptions = 0): void

これ以降のチェックで許容される文字を、 pattern で記述された集合に制限します。 この集合に含まれない文字が存在すると、 Spoofchecker::isSuspicious() はそれを疑わしいものとして報告します。

パラメータ

pattern
UnicodeSet パターン、 すなわち正規表現スタイルの文字クラスとして記述された文字集合。 [ で始まり ] で終わる必要があります。 たとえば [a-z0-9] のようにします。
patternOptions
pattern をどのように解釈するかを制御するビットマスク。 0 にするか、 Spoofchecker::IGNORE_SPACE を単独で指定するか、 あるいはそれと Spoofchecker::CASE_INSENSITIVE、 Spoofchecker::ADD_CASE_MAPPINGS、 Spoofchecker::SIMPLE_CASE_INSENSITIVE のいずれかひとつだけを組み合わせて指定しなければなりません。

戻り値

値を返しません。

エラー / 例外

pattern が有効な文字集合のパターンでない場合や、 patternOptions がオプションの有効な組み合わせでない場合に、 ValueError をスローします。

例

例1 Spoofchecker::setAllowedChars() の例

<?php
$checker = new Spoofchecker();
$checker->setAllowedChars('[a-z0-9]');

var_dump($checker->isSuspicious('hello'));
var_dump($checker->isSuspicious('héllo'));
?>

上の例の出力は以下となります。

bool(false)
bool(true)

参考