PHPKonf 2020 Online

enchant_broker_describe

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

enchant_broker_describeEnumerates the Enchant providers

Description

enchant_broker_describe ( EnchantBroker $broker ) : array

Enumerates the Enchant providers and tells you some rudimentary information about them. The same info is provided through phpinfo().

Parameters

broker

An Enchant broker returned by enchant_broker_init().

Return Values

Returns an array of available Enchant providers 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 the backends provided by the given broker

<?php
$r 
enchant_broker_init();
$bprovides enchant_broker_describe($r);
echo 
"Current broker provides the following backend(s):\n";
print_r($bprovides);

?>

The above example will output something similar to:

Current broker provides the following backend(s):
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
        )

)

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top