Skip to content

Commit c9c7820

Browse files
committed
Review parameter names in ext/ftp
Closes GH-6254
1 parent ae77c7b commit c9c7820

File tree

2 files changed

+57
-60
lines changed

2 files changed

+57
-60
lines changed

ext/ftp/ftp.stub.php

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
/** @generate-function-entries */
44

55
/** @return resource|false */
6-
function ftp_connect(string $host, int $port = 21, int $timeout = 90) {}
6+
function ftp_connect(string $hostname, int $port = 21, int $timeout = 90) {}
77

88
#ifdef HAVE_FTP_SSL
99
/** @return resource|false */
10-
function ftp_ssl_connect(string $host, int $port = 21, int $timeout = 90) {}
10+
function ftp_ssl_connect(string $hostname, int $port = 21, int $timeout = 90) {}
1111
#endif
1212

1313
/** @param resource $ftp */
@@ -35,7 +35,7 @@ function ftp_mkdir($ftp, string $directory): string|false {}
3535
function ftp_rmdir($ftp, string $directory): bool {}
3636

3737
/** @param resource $ftp */
38-
function ftp_chmod($ftp, int $mode, string $filename): int|false {}
38+
function ftp_chmod($ftp, int $permissions, string $filename): int|false {}
3939

4040
/**
4141
* @param resource $ftp
@@ -47,7 +47,7 @@ function ftp_alloc($ftp, int $size, &$response = null): bool {}
4747
function ftp_nlist($ftp, string $directory): array|false {}
4848

4949
/** @param resource $ftp */
50-
function ftp_rawlist($ftp, string $directory, bool $recurse = false): array|false {}
50+
function ftp_rawlist($ftp, string $directory, bool $recursive = false): array|false {}
5151

5252
/** @param resource $ftp */
5353
function ftp_mlsd($ftp, string $directory): array|false {}
@@ -57,48 +57,48 @@ function ftp_systype($ftp): string|false {}
5757

5858
/**
5959
* @param resource $ftp
60-
* @param resource $fp
60+
* @param resource $stream
6161
*/
62-
function ftp_fget($ftp, $fp, string $remote_file, int $mode = FTP_BINARY, int $resumepos = 0): bool {}
62+
function ftp_fget($ftp, $stream, string $remote_filename, int $mode = FTP_BINARY, int $offset = 0): bool {}
6363

6464
/**
6565
* @param resource $ftp
66-
* @param resource $fp
66+
* @param resource $stream
6767
*/
68-
function ftp_nb_fget($ftp, $fp, string $remote_file, int $mode = FTP_BINARY, int $resumpos = 0): int {}
68+
function ftp_nb_fget($ftp, $stream, string $remote_filename, int $mode = FTP_BINARY, int $offset = 0): int {}
6969

7070
/** @param resource $ftp */
71-
function ftp_pasv($ftp, bool $pasv): bool {}
71+
function ftp_pasv($ftp, bool $enable): bool {}
7272

7373
/** @param resource $ftp */
74-
function ftp_get($ftp, string $local_file, string $remote_file, int $mode = FTP_BINARY, int $resumepos = 0): bool {}
74+
function ftp_get($ftp, string $local_filename, string $remote_filename, int $mode = FTP_BINARY, int $offset = 0): bool {}
7575

7676
/** @param resource $ftp */
77-
function ftp_nb_get($ftp, string $local_file, string $remote_file, int $mode = FTP_BINARY, int $resume_pos = 0): int {}
77+
function ftp_nb_get($ftp, string $local_filename, string $remote_filename, int $mode = FTP_BINARY, int $offset = 0): int {}
7878

7979
/** @param resource $ftp */
8080
function ftp_nb_continue($ftp): int {}
8181

8282
/**
8383
* @param resource $ftp
84-
* @param resource $fp
84+
* @param resource $stream
8585
*/
86-
function ftp_fput($ftp, string $remote_file, $fp, int $mode = FTP_BINARY, int $startpos = 0): bool {}
86+
function ftp_fput($ftp, string $remote_filename, $stream, int $mode = FTP_BINARY, int $offset = 0): bool {}
8787

8888
/**
8989
* @param resource $ftp
90-
* @param resource $fp
90+
* @param resource $stream
9191
*/
92-
function ftp_nb_fput($ftp, string $remote_file, $fp, int $mode = FTP_BINARY, int $startpos = 0): int {}
92+
function ftp_nb_fput($ftp, string $remote_filename, $stream, int $mode = FTP_BINARY, int $offset = 0): int {}
9393

9494
/** @param resource $ftp */
95-
function ftp_put($ftp, string $remote_file, string $local_file, int $mode = FTP_BINARY, int $startpos = 0): bool {}
95+
function ftp_put($ftp, string $remote_filename, string $local_filename, int $mode = FTP_BINARY, int $offset = 0): bool {}
9696

9797
/** @param resource $ftp */
98-
function ftp_append($ftp, string $remove_file, string $local_file, int $mode = FTP_BINARY): bool {}
98+
function ftp_append($ftp, string $remote_filename, string $local_filename, int $mode = FTP_BINARY): bool {}
9999

100100
/** @param resource $ftp */
101-
function ftp_nb_put($ftp, string $remote_file, string $local_file, int $mode = FTP_BINARY, int $startpos = 0): int|false {}
101+
function ftp_nb_put($ftp, string $remote_filename, string $local_filename, int $mode = FTP_BINARY, int $offset = 0): int|false {}
102102

103103
/** @param resource $ftp */
104104
function ftp_size($ftp, string $filename): int {}
@@ -107,13 +107,13 @@ function ftp_size($ftp, string $filename): int {}
107107
function ftp_mdtm($ftp, string $filename): int {}
108108

109109
/** @param resource $ftp */
110-
function ftp_rename($ftp, string $src, string $dest): bool {}
110+
function ftp_rename($ftp, string $from, string $to): bool {}
111111

112112
/** @param resource $ftp */
113-
function ftp_delete($ftp, string $file): bool {}
113+
function ftp_delete($ftp, string $filename): bool {}
114114

115115
/** @param resource $ftp */
116-
function ftp_site($ftp, string $cmd): bool {}
116+
function ftp_site($ftp, string $command): bool {}
117117

118118
/** @param resource $ftp */
119119
function ftp_close($ftp): bool {}

ext/ftp/ftp_arginfo.h

Lines changed: 36 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: 7cf8b5776e7d2ad943683d1f1c43d44b85dea7a1 */
2+
* Stub hash: 4957601533b387d70ebb15811821fc06507cdbc2 */
33

44
ZEND_BEGIN_ARG_INFO_EX(arginfo_ftp_connect, 0, 0, 1)
5-
ZEND_ARG_TYPE_INFO(0, host, IS_STRING, 0)
5+
ZEND_ARG_TYPE_INFO(0, hostname, IS_STRING, 0)
66
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, port, IS_LONG, 0, "21")
77
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, timeout, IS_LONG, 0, "90")
88
ZEND_END_ARG_INFO()
99

1010
#if defined(HAVE_FTP_SSL)
1111
ZEND_BEGIN_ARG_INFO_EX(arginfo_ftp_ssl_connect, 0, 0, 1)
12-
ZEND_ARG_TYPE_INFO(0, host, IS_STRING, 0)
12+
ZEND_ARG_TYPE_INFO(0, hostname, IS_STRING, 0)
1313
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, port, IS_LONG, 0, "21")
1414
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, timeout, IS_LONG, 0, "90")
1515
ZEND_END_ARG_INFO()
@@ -53,7 +53,7 @@ ZEND_END_ARG_INFO()
5353

5454
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_ftp_chmod, 0, 3, MAY_BE_LONG|MAY_BE_FALSE)
5555
ZEND_ARG_INFO(0, ftp)
56-
ZEND_ARG_TYPE_INFO(0, mode, IS_LONG, 0)
56+
ZEND_ARG_TYPE_INFO(0, permissions, IS_LONG, 0)
5757
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
5858
ZEND_END_ARG_INFO()
5959

@@ -71,7 +71,7 @@ ZEND_END_ARG_INFO()
7171
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_ftp_rawlist, 0, 2, MAY_BE_ARRAY|MAY_BE_FALSE)
7272
ZEND_ARG_INFO(0, ftp)
7373
ZEND_ARG_TYPE_INFO(0, directory, IS_STRING, 0)
74-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, recurse, _IS_BOOL, 0, "false")
74+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, recursive, _IS_BOOL, 0, "false")
7575
ZEND_END_ARG_INFO()
7676

7777
#define arginfo_ftp_mlsd arginfo_ftp_nlist
@@ -80,39 +80,39 @@ ZEND_END_ARG_INFO()
8080

8181
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_fget, 0, 3, _IS_BOOL, 0)
8282
ZEND_ARG_INFO(0, ftp)
83-
ZEND_ARG_INFO(0, fp)
84-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
83+
ZEND_ARG_INFO(0, stream)
84+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
8585
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
86-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, resumepos, IS_LONG, 0, "0")
86+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
8787
ZEND_END_ARG_INFO()
8888

8989
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_nb_fget, 0, 3, IS_LONG, 0)
9090
ZEND_ARG_INFO(0, ftp)
91-
ZEND_ARG_INFO(0, fp)
92-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
91+
ZEND_ARG_INFO(0, stream)
92+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
9393
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
94-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, resumpos, IS_LONG, 0, "0")
94+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
9595
ZEND_END_ARG_INFO()
9696

9797
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_pasv, 0, 2, _IS_BOOL, 0)
9898
ZEND_ARG_INFO(0, ftp)
99-
ZEND_ARG_TYPE_INFO(0, pasv, _IS_BOOL, 0)
99+
ZEND_ARG_TYPE_INFO(0, enable, _IS_BOOL, 0)
100100
ZEND_END_ARG_INFO()
101101

102102
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_get, 0, 3, _IS_BOOL, 0)
103103
ZEND_ARG_INFO(0, ftp)
104-
ZEND_ARG_TYPE_INFO(0, local_file, IS_STRING, 0)
105-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
104+
ZEND_ARG_TYPE_INFO(0, local_filename, IS_STRING, 0)
105+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
106106
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
107-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, resumepos, IS_LONG, 0, "0")
107+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
108108
ZEND_END_ARG_INFO()
109109

110110
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_nb_get, 0, 3, IS_LONG, 0)
111111
ZEND_ARG_INFO(0, ftp)
112-
ZEND_ARG_TYPE_INFO(0, local_file, IS_STRING, 0)
113-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
112+
ZEND_ARG_TYPE_INFO(0, local_filename, IS_STRING, 0)
113+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
114114
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
115-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, resume_pos, IS_LONG, 0, "0")
115+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
116116
ZEND_END_ARG_INFO()
117117

118118
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_nb_continue, 0, 1, IS_LONG, 0)
@@ -121,41 +121,41 @@ ZEND_END_ARG_INFO()
121121

122122
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_fput, 0, 3, _IS_BOOL, 0)
123123
ZEND_ARG_INFO(0, ftp)
124-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
125-
ZEND_ARG_INFO(0, fp)
124+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
125+
ZEND_ARG_INFO(0, stream)
126126
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
127-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, startpos, IS_LONG, 0, "0")
127+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
128128
ZEND_END_ARG_INFO()
129129

130130
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_nb_fput, 0, 3, IS_LONG, 0)
131131
ZEND_ARG_INFO(0, ftp)
132-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
133-
ZEND_ARG_INFO(0, fp)
132+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
133+
ZEND_ARG_INFO(0, stream)
134134
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
135-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, startpos, IS_LONG, 0, "0")
135+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
136136
ZEND_END_ARG_INFO()
137137

138138
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_put, 0, 3, _IS_BOOL, 0)
139139
ZEND_ARG_INFO(0, ftp)
140-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
141-
ZEND_ARG_TYPE_INFO(0, local_file, IS_STRING, 0)
140+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
141+
ZEND_ARG_TYPE_INFO(0, local_filename, IS_STRING, 0)
142142
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
143-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, startpos, IS_LONG, 0, "0")
143+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
144144
ZEND_END_ARG_INFO()
145145

146146
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_append, 0, 3, _IS_BOOL, 0)
147147
ZEND_ARG_INFO(0, ftp)
148-
ZEND_ARG_TYPE_INFO(0, remove_file, IS_STRING, 0)
149-
ZEND_ARG_TYPE_INFO(0, local_file, IS_STRING, 0)
148+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
149+
ZEND_ARG_TYPE_INFO(0, local_filename, IS_STRING, 0)
150150
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
151151
ZEND_END_ARG_INFO()
152152

153153
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_ftp_nb_put, 0, 3, MAY_BE_LONG|MAY_BE_FALSE)
154154
ZEND_ARG_INFO(0, ftp)
155-
ZEND_ARG_TYPE_INFO(0, remote_file, IS_STRING, 0)
156-
ZEND_ARG_TYPE_INFO(0, local_file, IS_STRING, 0)
155+
ZEND_ARG_TYPE_INFO(0, remote_filename, IS_STRING, 0)
156+
ZEND_ARG_TYPE_INFO(0, local_filename, IS_STRING, 0)
157157
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "FTP_BINARY")
158-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, startpos, IS_LONG, 0, "0")
158+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, offset, IS_LONG, 0, "0")
159159
ZEND_END_ARG_INFO()
160160

161161
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_size, 0, 2, IS_LONG, 0)
@@ -167,19 +167,16 @@ ZEND_END_ARG_INFO()
167167

168168
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_rename, 0, 3, _IS_BOOL, 0)
169169
ZEND_ARG_INFO(0, ftp)
170-
ZEND_ARG_TYPE_INFO(0, src, IS_STRING, 0)
171-
ZEND_ARG_TYPE_INFO(0, dest, IS_STRING, 0)
170+
ZEND_ARG_TYPE_INFO(0, from, IS_STRING, 0)
171+
ZEND_ARG_TYPE_INFO(0, to, IS_STRING, 0)
172172
ZEND_END_ARG_INFO()
173173

174174
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_delete, 0, 2, _IS_BOOL, 0)
175175
ZEND_ARG_INFO(0, ftp)
176-
ZEND_ARG_TYPE_INFO(0, file, IS_STRING, 0)
176+
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
177177
ZEND_END_ARG_INFO()
178178

179-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_ftp_site, 0, 2, _IS_BOOL, 0)
180-
ZEND_ARG_INFO(0, ftp)
181-
ZEND_ARG_TYPE_INFO(0, cmd, IS_STRING, 0)
182-
ZEND_END_ARG_INFO()
179+
#define arginfo_ftp_site arginfo_ftp_exec
183180

184181
#define arginfo_ftp_close arginfo_ftp_cdup
185182

0 commit comments

Comments
 (0)