pspell_new
(PHP 4 >= 4.0.2, PHP 5, PHP 7)
pspell_new — 新規辞書をロードする
説明
pspell_new
( string $language
[, string $spelling = ""
[, string $jargon = ""
[, string $encoding = ""
[, int $mode = 0
]]]] ) : int|false
pspell_new() は、新規の辞書をロードして 辞書リンク ID を返します。このリンク ID は、他の pspell 関数で使用されます。
詳細な情報および例については、pspell の Web サイト
にあるインラインマニュアルを参照ください。
パラメータ
languageパラメータ language は、2 文字の ISO 639 言語コードと オプションでダッシュまたはアンダースコアの後に 2 文字の ISO 3166 国コードからなる言語コードです。
spellingパラメータ spelling は、英語のように複数のスペルがある言語に関して スペルの指定を行うものです。指定可能な値は、 'american', 'british', 'canadian'です。
jargonパラメータ jargon は、同じ language および spelling パラメータを有する 2 つの異なる単語リストを区別するための 追加情報を有しています。
encodingパラメータ encoding は、単語のエンコーディングとして 予想されるものです。有効な値は、'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned 32' です。このパラメータはよくテストされていないため、 使用する際には注意してください。
modeパラメータ mode は、スペルチェッカの動作モードです。 使用可能なモードを以下に示します。
-
PSPELL_FAST- 高速モード (修正候補の数は最小) -
PSPELL_NORMAL- 通常モード (修正候補はより多い) -
PSPELL_BAD_SPELLERS- 低速モード (修正候補は多い) -
PSPELL_RUN_TOGETHER- つながった単語を複合語 （legal compound）として考慮します。この場合、"thecat" には二つの 単語の間に空白はありませんが複合語となります。この設定の変更は pspell_check() から返される結果にのみ影響します。 設定変更後も pspell_suggest() は修正候補を返します。
mode は、これらのさまざまな定数を用いたビットマスクです。 しかし
PSPELL_FAST、PSPELL_NORMALおよびPSPELL_BAD_SPELLERSは相反するため、 この中のひとつを選択する必要があります。-
返り値
成功した場合にディレクトリリンク識別子、失敗した場合に false を返します。
例
例1 pspell_new()
<?php$pspell_link = pspell_new("en", "", "", "", (PSPELL_FAST|PSPELL_RUN_TOGETHER));?>
