xref: /PHP-8.4/ext/enchant/enchant.stub.php (revision 29f98e74) 
1<?php
2
3/** @generate-class-entries */
4
5/**
6 * @var int
7 * @cvalue PHP_ENCHANT_MYSPELL
8 * @deprecated
9 */
10const ENCHANT_MYSPELL = UNKNOWN;
11/**
12 * @var int
13 * @cvalue PHP_ENCHANT_ISPELL
14 * @deprecated
15 */
16const ENCHANT_ISPELL = UNKNOWN;
17#ifdef HAVE_ENCHANT_GET_VERSION
18/**
19 * @var string
20 * @cvalue PHP_ENCHANT_GET_VERSION
21 */
22const LIBENCHANT_VERSION = UNKNOWN;
23#endif
24
25/**
26 * @strict-properties
27 * @not-serializable
28 */
29final class EnchantBroker
30{
31}
32
33/**
34 * @strict-properties
35 * @not-serializable
36 */
37final class EnchantDictionary
38{
39}
40
41function enchant_broker_init(): EnchantBroker|false {}
42
43#[\Deprecated(since: '8.0', message: 'as EnchantBroker objects are freed automatically')]
44function enchant_broker_free(EnchantBroker $broker): bool {}
45
46function enchant_broker_get_error(EnchantBroker $broker): string|false {}
47
48#[\Deprecated(since: '8.0')]
49function enchant_broker_set_dict_path(EnchantBroker $broker, int $type, string $path): bool {}
50
51#[\Deprecated(since: '8.0')]
52function enchant_broker_get_dict_path(EnchantBroker $broker, int $type): string|false {}
53
54/**
55 * @return array<int, array>
56 * @refcount 1
57 */
58function enchant_broker_list_dicts(EnchantBroker $broker): array {}
59
60function enchant_broker_request_dict(EnchantBroker $broker, string $tag): EnchantDictionary|false {}
61
62function enchant_broker_request_pwl_dict(EnchantBroker $broker, string $filename): EnchantDictionary|false {}
63
64#[\Deprecated(since: '8.0', message: 'as EnchantDictionary objects are freed automatically')]
65function enchant_broker_free_dict(EnchantDictionary $dictionary): bool {}
66
67function enchant_broker_dict_exists(EnchantBroker $broker, string $tag): bool {}
68
69function enchant_broker_set_ordering(EnchantBroker $broker, string $tag, string $ordering): bool {}
70
71/**
72 * @return array<int, array>
73 * @refcount 1
74 */
75function enchant_broker_describe(EnchantBroker $broker): array {}
76
77/** @param array $suggestions */
78function enchant_dict_quick_check(EnchantDictionary $dictionary, string $word, &$suggestions = null): bool {}
79
80function enchant_dict_check(EnchantDictionary $dictionary, string $word): bool {}
81
82/**
83 * @return array<int, string>
84 * @refcount 1
85 */
86function enchant_dict_suggest(EnchantDictionary $dictionary, string $word): array {}
87
88function enchant_dict_add(EnchantDictionary $dictionary, string $word): void {}
89
90/**
91* @alias enchant_dict_add
92*/
93#[\Deprecated(since: '8.0', message: 'use enchant_dict_add() instead')]
94function enchant_dict_add_to_personal(EnchantDictionary $dictionary, string $word): void {}
95
96function enchant_dict_add_to_session(EnchantDictionary $dictionary, string $word): void {}
97
98function enchant_dict_is_added(EnchantDictionary $dictionary, string $word): bool {}
99
100/**
101* @alias enchant_dict_is_added
102*/
103#[\Deprecated(since: '8.0', message: 'use enchant_dict_is_added() instead')]
104function enchant_dict_is_in_session(EnchantDictionary $dictionary, string $word): bool {}
105
106function enchant_dict_store_replacement(EnchantDictionary $dictionary, string $misspelled, string $correct): void {}
107
108function enchant_dict_get_error(EnchantDictionary $dictionary): string|false {}
109
110/**
111 * @return array<string, string>
112 * @refcount 1
113 */
114function enchant_dict_describe(EnchantDictionary $dictionary): array {}
115