Home/ Manual/ enchant / functions/ enchant_broker_request_dict

enchant_broker_request_dict

PHP function Edit on GitHub ✎

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

Create a new dictionary using a tag

Description

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

tag: A tag describing the locale, for example en_US, de_DE

Return Values

Returns a dictionary resource on successFalseforfailure.

Changelog

Version	Description
8.0.0	On success, this function returns an `EnchantDictionary` instance now; previously, a Resource was returned.

Examples

A enchant_broker_request_dict() example

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

php

<?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);
}
?>