enchant_broker_free

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

enchant_broker_free — Free the broker resource and its dictionaries

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 EnchantBroker objects are freed automatically',
)]
function enchant_broker_free(EnchantBroker $broker): bool

Free a broker with all its dictionaries. As of PHP 8.0.0, it is recommended to unset the object instead of calling this function.

Parameters

broker: An Enchant broker returned by enchant_broker_init().

Return Values

Returns true 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 an Error if broker still has open dictionaries.

Changelog