PHP Manual: enchant_broker_request

Description

function enchant_broker_request_dict(EnchantBroker $broker, string $tag): EnchantDictionary|false

create a new dictionary using tag, the non-empty language tag you wish to request a dictionary for ("en_US", "de_DE", ...)

Parameters

broker: An Enchant broker returned by enchant_broker_init().
tag: A tag describing the locale, for example en_US, de_DE

Return Values

Returns an EnchantDictionary instance on success or false on failure.

Errors/Exceptions

Throws a ValueError if broker is not usable, for example if it is uninitialized or was already freed with enchant_broker_free().

Throws a ValueError if tag is empty.

Changelog

Version	Description
8.0.0	`broker` expects an EnchantBroker instance now; previously, a resource was expected.
8.0.0	On success, this function returns an EnchantDictionary instance now; previously, a resource was returned.

Examples

Example #1 A enchant_broker_request_dict() example

Check if a dictionary exists using enchant_broker_dict_exists() and request it.

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

enchant_broker_request_dict