enchant_broker_describe

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0)

enchant_broker_describeEnchant プロバイダを列挙する

説明

enchant_broker_describe(EnchantBroker$broker): array

Enchant プロバイダを列挙し、その基本情報を通知します。 同じ情報が phpinfo() からでも取得できます。

パラメータ

broker

enchant_broker_init() によって返される Enchant ブローカー。

戻り値

利用可能な Enchant プロバイダの一覧と、その詳細を array として返します。

変更履歴

バージョン説明
8.0.0broker は、EnchantBroker クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース が期待されていました。
8.0.0 このバージョンより前では、この関数は失敗時に false を返していました。

例1 指定したブローカーが提供するバックエンドの一覧

<?php
$r
= enchant_broker_init();
$bprovides = enchant_broker_describe($r);
echo
"現在のブローカーは、次のバックエンドを提供します。\n";
print_r($bprovides);

?>

上の例の出力は、 たとえば以下のようになります。

現在のブローカーは、次のバックエンドを提供します。 Array ( [0] => Array ( [name] => aspell [desc] => Aspell Provider [file] => /usr/lib/enchant/libenchant_aspell.so ) [1] => Array ( [name] => hspell [desc] => Hspell Provider [file] => /usr/lib/enchant/libenchant_hspell.so ) [2] => Array ( [name] => ispell [desc] => Ispell Provider [file] => /usr/lib/enchant/libenchant_ispell.so ) [3] => Array ( [name] => myspell [desc] => Myspell Provider [file] => /usr/lib/enchant/libenchant_myspell.so ) )
To Top