xref: /PHP-8.2/ext/pspell/pspell.stub.php (revision f72d2645) 
1<?php
2
3/** @generate-class-entries */
4
5namespace PSpell {
6    /**
7     * @strict-properties
8     * @not-serializable
9     */
10    final class Dictionary {}
11
12    /**
13     * @strict-properties
14     * @not-serializable
15     */
16    final class Config {}
17}
18
19namespace {
20    /**
21     * @var int
22     * @cvalue PSPELL_FAST
23     */
24    const PSPELL_FAST = UNKNOWN;
25    /**
26     * @var int
27     * @cvalue PSPELL_NORMAL
28     */
29    const PSPELL_NORMAL = UNKNOWN;
30    /**
31     * @var int
32     * @cvalue PSPELL_BAD_SPELLERS
33     */
34    const PSPELL_BAD_SPELLERS = UNKNOWN;
35    /**
36     * @var int
37     * @cvalue PSPELL_RUN_TOGETHER
38     */
39    const PSPELL_RUN_TOGETHER = UNKNOWN;
40
41    function pspell_new(string $language, string $spelling = "", string $jargon = "", string $encoding = "", int $mode = 0): PSpell\Dictionary|false {}
42
43    function pspell_new_personal(
44        string $filename,
45        string $language,
46        string $spelling = "",
47        string $jargon = "",
48        string $encoding = "",
49        int $mode = 0
50    ): PSpell\Dictionary|false {}
51
52    function pspell_new_config(PSpell\Config $config): PSpell\Dictionary|false {}
53
54    function pspell_check(PSpell\Dictionary $dictionary, string $word): bool {}
55
56    /**
57     * @return array<int, string>|false
58     * @refcount 1
59     */
60    function pspell_suggest(PSpell\Dictionary $dictionary, string $word): array|false {}
61    function pspell_store_replacement(PSpell\Dictionary $dictionary, string $misspelled, string $correct): bool {}
62    function pspell_add_to_personal(PSpell\Dictionary $dictionary, string $word): bool {}
63    function pspell_add_to_session(PSpell\Dictionary $dictionary, string $word): bool {}
64    function pspell_clear_session(PSpell\Dictionary $dictionary): bool {}
65    function pspell_save_wordlist(PSpell\Dictionary $dictionary): bool {}
66
67    function pspell_config_create(string $language, string $spelling = "", string $jargon = "", string $encoding = ""): PSpell\Config {}
68    function pspell_config_runtogether(PSpell\Config $config, bool $allow): bool {}
69    function pspell_config_mode(PSpell\Config $config, int $mode): bool {}
70    function pspell_config_ignore(PSpell\Config $config, int $min_length): bool {}
71    function pspell_config_personal(PSpell\Config $config, string $filename): bool {}
72    function pspell_config_dict_dir(PSpell\Config $config, string $directory): bool {}
73    function pspell_config_data_dir(PSpell\Config $config, string $directory): bool {}
74    function pspell_config_repl(PSpell\Config $config, string $filename): bool {}
75    function pspell_config_save_repl(PSpell\Config $config, bool $save): bool {}
76
77}
78