enchant_dict_describe

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

enchant_dict_describe — Describes an individual dictionary

Description

enchant_dict_describe(EnchantDictionary $dictionary): array

Returns the details of the dictionary.

Parameters

dictionary: An Enchant dictionary returned by enchant_broker_request_dict() or enchant_broker_request_pwl_dict().

Return Values

Returns true on success or false on failure.

Changelog

Version	Description
8.0.0	`dictionary` expects an EnchantDictionary instance now; previoulsy, a resource was expected.
8.0.0	Prior to this version, the function returned `false` on failure.

Examples

Example #1 A enchant_dict_describe() example

Check if a dictionary exists using enchant_broker_dict_exists() and show the detail of it.

<?php
$tag = 'en_US';
$broker = enchant_broker_init();
if (enchant_broker_dict_exists($broker,$tag)) {
    $dict = enchant_broker_request_dict($r, $tag);
    $dict_details = enchant_dict_describe($dict);
    print_r($dict_details);
}
?>

The above example will output something similar to:

Array
(
    [lang] => en_US
    [name] => aspell
    [desc] => Aspell Provider
    [file] => /usr/lib/enchant/libenchant_aspell.so
)

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.