enchant_broker_free_dict

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

enchant_broker_free_dict — Free a dictionary resource

Warning

This function has been DEPRECATED as of PHP 8.0.0. Relying on this function is highly discouraged.

Description

#[\Deprecated(
since: '8.0',
message: 'as EnchantDictionary objects are freed automatically',
)]
function enchant_broker_free_dict(EnchantDictionary $dictionary): bool

Free a dictionary. As of PHP 8.0.0, it is recommended to unset the object instead of calling this function.

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.

Errors/Exceptions

Throws a ValueError if dictionary is not usable, for example if it is uninitialized or was already released with enchant_broker_free_dict().

Changelog