Php/docs/function.enchant-broker-list-dicts

From Get docs

enchant_broker_list_dicts

(PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 1.0.1)

enchant_broker_list_dictsReturns a list of available dictionaries


Description

enchant_broker_list_dicts ( EnchantBroker $broker ) : array

Returns a list of available dictionaries with their details.


Parameters

broker
An Enchant broker returned by enchant_broker_init().


Return Values

Returns an array of available dictionaries with their details.


Changelog

Version Description
8.0.0 broker expects an EnchantBroker instance now;

previoulsy, a resource was expected.

8.0.0 Prior to this version, the function returned FALSE on failure.


Examples

Example #1 List all available dictionaries for one broker

<?php$r = enchant_broker_init();$dicts = enchant_broker_list_dicts($r);print_r($dicts);?>

The above example will output something similar to:


Array
(
    [0] => Array
        (
            [lang_tag] => de
            [provider_name] => aspell
            [provider_desc] => Aspell Provider
            [provider_file] => /usr/lib/enchant/libenchant_aspell.so
        )

    [1] => Array
        (
            [lang_tag] => de_DE
            [provider_name] => aspell
            [provider_desc] => Aspell Provider
            [provider_file] => /usr/lib/enchant/libenchant_aspell.so
        )

    [3] => Array
        (
            [lang_tag] => en
            [provider_name] => aspell
            [provider_desc] => Aspell Provider
            [provider_file] => /usr/lib/enchant/libenchant_aspell.so
        )

    [4] => Array
        (
            [lang_tag] => en_GB
            [provider_name] => aspell
            [provider_desc] => Aspell Provider
            [provider_file] => /usr/lib/enchant/libenchant_aspell.so
        )

    [5] => Array
        (
            [lang_tag] => en_US
            [provider_name] => aspell
            [provider_desc] => Aspell Provider
            [provider_file] => /usr/lib/enchant/libenchant_aspell.so
        )

    [6] => Array
        (
            [lang_tag] => hi_IN
            [provider_name] => myspell
            [provider_desc] => Myspell Provider
            [provider_file] => /usr/lib/enchant/libenchant_myspell.so
        )

)

See Also