Skip to content

Commit c11191e

Browse files
nikicnikic
committed
Update ext/tidy parameter names
Closes GH-6283.
1 parent 1c411ed commit c11191e

File tree

3 files changed

+59
-70
lines changed

3 files changed

+59
-70
lines changed

‎ext/tidy/tests/021.phpt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ var_dump($t->getOptDoc('ncr'));
1616
var_dump(strlen(tidy_get_opt_doc($t, 'wrap')) > 99);
1717
?>
1818
--EXPECT--
19-
tidy_get_opt_doc(): Argument #2 ($optname) is an invalid configuration option, "some_bogus_cfg" given
19+
tidy_get_opt_doc(): Argument #2 ($option) is an invalid configuration option, "some_bogus_cfg" given
2020
string(73) "This option specifies if Tidy should allow numeric character references. "
2121
bool(true)

‎ext/tidy/tidy.stub.php

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,59 @@
22

33
/** @generate-function-entries */
44

5-
function tidy_parse_string(string $input, array|string|null $config_options = null, ?string $encoding = null): tidy|false {}
5+
function tidy_parse_string(string $string, array|string|null $config = null, ?string $encoding = null): tidy|false {}
66

7-
function tidy_get_error_buffer(tidy $object): string|false {}
7+
function tidy_get_error_buffer(tidy $tidy): string|false {}
88

9-
function tidy_get_output(tidy $object): string {}
9+
function tidy_get_output(tidy $tidy): string {}
1010

11-
function tidy_parse_file(string $file, array|string|null $config_options = null, ?string $encoding = null, bool $use_include_path = false): tidy|false {}
11+
function tidy_parse_file(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false): tidy|false {}
1212

13-
function tidy_clean_repair(tidy $object): bool {}
13+
function tidy_clean_repair(tidy $tidy): bool {}
1414

15-
function tidy_repair_string(string $data, array|string|null $config_options = null, ?string $encoding = null): string|false {}
15+
function tidy_repair_string(string $string, array|string|null $config = null, ?string $encoding = null): string|false {}
1616

17-
function tidy_repair_file(string $filename, array|string|null $config_options = null, ?string $encoding = null, bool $use_include_path = false): string|false {}
17+
function tidy_repair_file(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false): string|false {}
1818

19-
function tidy_diagnose(tidy $object): bool {}
19+
function tidy_diagnose(tidy $tidy): bool {}
2020

2121
function tidy_get_release(): string {}
2222

2323
#ifdef HAVE_TIDYOPTGETDOC
24-
function tidy_get_opt_doc(tidy $object, string $optname): string|false {}
24+
function tidy_get_opt_doc(tidy $tidy, string $option): string|false {}
2525
#endif
2626

27-
function tidy_get_config(tidy $object): array {}
27+
function tidy_get_config(tidy $tidy): array {}
2828

29-
function tidy_get_status(tidy $object): int {}
29+
function tidy_get_status(tidy $tidy): int {}
3030

31-
function tidy_get_html_ver(tidy $object): int {}
31+
function tidy_get_html_ver(tidy $tidy): int {}
3232

33-
function tidy_is_xhtml(tidy $object): bool {}
33+
function tidy_is_xhtml(tidy $tidy): bool {}
3434

35-
function tidy_is_xml(tidy $object): bool {}
35+
function tidy_is_xml(tidy $tidy): bool {}
3636

37-
function tidy_error_count(tidy $object): int {}
37+
function tidy_error_count(tidy $tidy): int {}
3838

39-
function tidy_warning_count(tidy $object): int {}
39+
function tidy_warning_count(tidy $tidy): int {}
4040

41-
function tidy_access_count(tidy $object): int {}
41+
function tidy_access_count(tidy $tidy): int {}
4242

43-
function tidy_config_count(tidy $object): int {}
43+
function tidy_config_count(tidy $tidy): int {}
4444

45-
function tidy_getopt(tidy $object, string $option): string|int|bool {}
45+
function tidy_getopt(tidy $tidy, string $option): string|int|bool {}
4646

47-
function tidy_get_root(tidy $object): ?tidyNode {}
47+
function tidy_get_root(tidy $tidy): ?tidyNode {}
4848

49-
function tidy_get_html(tidy $object): ?tidyNode {}
49+
function tidy_get_html(tidy $tidy): ?tidyNode {}
5050

51-
function tidy_get_head(tidy $object): ?tidyNode {}
51+
function tidy_get_head(tidy $tidy): ?tidyNode {}
5252

5353
function tidy_get_body(tidy $tidy): ?tidyNode {}
5454

5555
class tidy
5656
{
57-
public function __construct(?string $filename = null, array|string|null $config_options = null, ?string $encoding = null, bool $use_include_path = false) {}
57+
public function __construct(?string $filename = null, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false) {}
5858

5959
/**
6060
* @return string|int|bool
@@ -69,22 +69,22 @@ public function getOpt(string $option) {}
6969
public function cleanRepair() {}
7070

7171
/** @return bool */
72-
public function parseFile(string $file, array|string|null $config_options = null, ?string $encoding = null, bool $use_include_path = false) {}
72+
public function parseFile(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false) {}
7373

7474
/** @return bool */
75-
public function parseString(string $input, array|string|null $config_options = null, ?string $encoding = null) {}
75+
public function parseString(string $string, array|string|null $config = null, ?string $encoding = null) {}
7676

7777
/**
7878
* @return bool
7979
* @alias tidy_repair_string
8080
*/
81-
public function repairString(string $data, array|string|null $config_options = null, ?string $encoding = null) {}
81+
public function repairString(string $string, array|string|null $config = null, ?string $encoding = null) {}
8282

8383
/**
8484
* @return bool
8585
* @alias tidy_repair_file
8686
*/
87-
public function repairFile(string $filename, array|string|null $config_options = null, ?string $encoding = null, bool $use_include_path = false) {}
87+
public function repairFile(string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false) {}
8888

8989
/**
9090
* @return bool
@@ -121,7 +121,7 @@ public function getHtmlVer() {}
121121
* @return string|false
122122
* @alias tidy_get_opt_doc
123123
*/
124-
public function getOptDoc(string $optname) {}
124+
public function getOptDoc(string $option) {}
125125
#endif
126126

127127
/**

‎ext/tidy/tidy_arginfo.h

Lines changed: 30 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: 62b1cdb7f9b9a5641d3bd9248f5a73c30266d02e */
2+
* Stub hash: ac4cd960d6c65653994b8b044dcc52c179a57d45 */
33

44
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_tidy_parse_string, 0, 1, tidy, MAY_BE_FALSE)
5-
ZEND_ARG_TYPE_INFO(0, input, IS_STRING, 0)
6-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
5+
ZEND_ARG_TYPE_INFO(0, string, IS_STRING, 0)
6+
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
77
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
88
ZEND_END_ARG_INFO()
99

1010
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_tidy_get_error_buffer, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
11-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
11+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
1212
ZEND_END_ARG_INFO()
1313

1414
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_tidy_get_output, 0, 1, IS_STRING, 0)
15-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
15+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
1616
ZEND_END_ARG_INFO()
1717

1818
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_tidy_parse_file, 0, 1, tidy, MAY_BE_FALSE)
19-
ZEND_ARG_TYPE_INFO(0, file, IS_STRING, 0)
20-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
19+
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
20+
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
2121
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
22-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, use_include_path, _IS_BOOL, 0, "false")
22+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, useIncludePath, _IS_BOOL, 0, "false")
2323
ZEND_END_ARG_INFO()
2424

2525
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_tidy_clean_repair, 0, 1, _IS_BOOL, 0)
26-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
26+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
2727
ZEND_END_ARG_INFO()
2828

2929
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_tidy_repair_string, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
30-
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
31-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
30+
ZEND_ARG_TYPE_INFO(0, string, IS_STRING, 0)
31+
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
3232
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
3333
ZEND_END_ARG_INFO()
3434

3535
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_tidy_repair_file, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
3636
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
37-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
37+
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
3838
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
39-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, use_include_path, _IS_BOOL, 0, "false")
39+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, useIncludePath, _IS_BOOL, 0, "false")
4040
ZEND_END_ARG_INFO()
4141

4242
#define arginfo_tidy_diagnose arginfo_tidy_clean_repair
@@ -46,17 +46,17 @@ ZEND_END_ARG_INFO()
4646

4747
#if defined(HAVE_TIDYOPTGETDOC)
4848
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_tidy_get_opt_doc, 0, 2, MAY_BE_STRING|MAY_BE_FALSE)
49-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
50-
ZEND_ARG_TYPE_INFO(0, optname, IS_STRING, 0)
49+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
50+
ZEND_ARG_TYPE_INFO(0, option, IS_STRING, 0)
5151
ZEND_END_ARG_INFO()
5252
#endif
5353

5454
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_tidy_get_config, 0, 1, IS_ARRAY, 0)
55-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
55+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
5656
ZEND_END_ARG_INFO()
5757

5858
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_tidy_get_status, 0, 1, IS_LONG, 0)
59-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
59+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
6060
ZEND_END_ARG_INFO()
6161

6262
#define arginfo_tidy_get_html_ver arginfo_tidy_get_status
@@ -74,27 +74,25 @@ ZEND_END_ARG_INFO()
7474
#define arginfo_tidy_config_count arginfo_tidy_get_status
7575

7676
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_tidy_getopt, 0, 2, MAY_BE_STRING|MAY_BE_LONG|MAY_BE_BOOL)
77-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
77+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
7878
ZEND_ARG_TYPE_INFO(0, option, IS_STRING, 0)
7979
ZEND_END_ARG_INFO()
8080

8181
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_tidy_get_root, 0, 1, tidyNode, 1)
82-
ZEND_ARG_OBJ_INFO(0, object, tidy, 0)
82+
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
8383
ZEND_END_ARG_INFO()
8484

8585
#define arginfo_tidy_get_html arginfo_tidy_get_root
8686

8787
#define arginfo_tidy_get_head arginfo_tidy_get_root
8888

89-
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_tidy_get_body, 0, 1, tidyNode, 1)
90-
ZEND_ARG_OBJ_INFO(0, tidy, tidy, 0)
91-
ZEND_END_ARG_INFO()
89+
#define arginfo_tidy_get_body arginfo_tidy_get_root
9290

9391
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy___construct, 0, 0, 0)
9492
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, filename, IS_STRING, 1, "null")
95-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
93+
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
9694
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
97-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, use_include_path, _IS_BOOL, 0, "false")
95+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, useIncludePath, _IS_BOOL, 0, "false")
9896
ZEND_END_ARG_INFO()
9997

10098
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_getOpt, 0, 0, 1)
@@ -105,30 +103,21 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_cleanRepair, 0, 0, 0)
105103
ZEND_END_ARG_INFO()
106104

107105
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_parseFile, 0, 0, 1)
108-
ZEND_ARG_TYPE_INFO(0, file, IS_STRING, 0)
109-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
106+
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
107+
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
110108
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
111-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, use_include_path, _IS_BOOL, 0, "false")
109+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, useIncludePath, _IS_BOOL, 0, "false")
112110
ZEND_END_ARG_INFO()
113111

114112
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_parseString, 0, 0, 1)
115-
ZEND_ARG_TYPE_INFO(0, input, IS_STRING, 0)
116-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
113+
ZEND_ARG_TYPE_INFO(0, string, IS_STRING, 0)
114+
ZEND_ARG_TYPE_MASK(0, config, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
117115
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
118116
ZEND_END_ARG_INFO()
119117

120-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_repairString, 0, 0, 1)
121-
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
122-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
123-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
124-
ZEND_END_ARG_INFO()
118+
#define arginfo_class_tidy_repairString arginfo_class_tidy_parseString
125119

126-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_repairFile, 0, 0, 1)
127-
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
128-
ZEND_ARG_TYPE_MASK(0, config_options, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_NULL, "null")
129-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, encoding, IS_STRING, 1, "null")
130-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, use_include_path, _IS_BOOL, 0, "false")
131-
ZEND_END_ARG_INFO()
120+
#define arginfo_class_tidy_repairFile arginfo_class_tidy_parseFile
132121

133122
#define arginfo_class_tidy_diagnose arginfo_class_tidy_cleanRepair
134123

@@ -142,7 +131,7 @@ ZEND_END_ARG_INFO()
142131

143132
#if defined(HAVE_TIDYOPTGETDOC)
144133
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_tidy_getOptDoc, 0, 0, 1)
145-
ZEND_ARG_TYPE_INFO(0, optname, IS_STRING, 0)
134+
ZEND_ARG_TYPE_INFO(0, option, IS_STRING, 0)
146135
ZEND_END_ARG_INFO()
147136
#endif
148137

0 commit comments

Comments
 (0)