array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.enchant-broker-request-dict.php', 1 => 'enchant_broker_request_dict', 2 => 'Create a new dictionary using a tag', ), 'up' => array ( 0 => 'ref.enchant.php', 1 => 'Enchant Functions', ), 'prev' => array ( 0 => 'function.enchant-broker-list-dicts.php', 1 => 'enchant_broker_list_dicts', ), 'next' => array ( 0 => 'function.enchant-broker-request-pwl-dict.php', 1 => 'enchant_broker_request_pwl_dict', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/enchant/functions/enchant-broker-request-dict.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

enchant_broker_request_dict

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

enchant_broker_request_dict — 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

broker

An Enchant broker returned by enchant_broker_init().

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

Return Values

Returns a dictionary resource on success or false on failure.

Changelog

Version Description
8.0.0 broker expects an EnchantBroker instance now; previoulsy, 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);
}
?>

See Also