Skip to content

Commit 328903c

Browse files
committed
Add proper return types to final phar methods
As these are final, we can add return types to them.
1 parent 541f8b7 commit 328903c

File tree

2 files changed

+62
-80
lines changed

2 files changed

+62
-80
lines changed

ext/phar/phar_object.stub.php

Lines changed: 38 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -142,50 +142,39 @@ public function startBuffering() {}
142142
/** @return void */
143143
public function stopBuffering() {}
144144

145-
/** @return string */
146-
final public static function apiVersion() {}
145+
final public static function apiVersion(): string {}
147146

148-
/** @return bool */
149-
final public static function canCompress(int $method = 0) {}
147+
final public static function canCompress(int $method = 0): bool {}
150148

151-
/** @return bool */
152-
final public static function canWrite() {}
149+
final public static function canWrite(): bool {}
153150

154-
/** @return string */
155-
final public static function createDefaultStub(string $index = UNKNOWN, string $webindex = UNKNOWN) {}
151+
final public static function createDefaultStub(
152+
string $index = UNKNOWN, string $webindex = UNKNOWN): string {}
156153

157-
/** @return array */
158-
final public static function getSupportedCompression() {}
154+
final public static function getSupportedCompression(): array {}
159155

160-
/** @return array */
161-
final public static function getSupportedSignatures() {}
156+
final public static function getSupportedSignatures(): array {}
162157

163-
/** @return void */
164-
final public static function interceptFileFuncs() {}
158+
final public static function interceptFileFuncs(): void {}
165159

166-
/** @return bool */
167-
final public static function isValidPharFilename(string $filename, bool $executable = true) {}
160+
final public static function isValidPharFilename(
161+
string $filename, bool $executable = true): bool {}
168162

169-
/** @return bool */
170-
final public static function loadPhar(string $filename, ?string $alias = null) {}
163+
final public static function loadPhar(string $filename, ?string $alias = null): bool {}
171164

172-
/** @return bool */
173-
final public static function mapPhar(?string $alias = null, int $offset = 0) {}
165+
final public static function mapPhar(?string $alias = null, int $offset = 0): bool {}
174166

175-
/** @return string */
176-
final public static function running(bool $retphar = true) {}
167+
final public static function running(bool $retphar = true): string {}
177168

178-
/** @return void */
179-
final public static function mount(string $inphar, string $externalfile) {}
169+
final public static function mount(string $inphar, string $externalfile): void {}
180170

181-
/** @return void */
182-
final public static function mungServer(array $munglist) {}
171+
final public static function mungServer(array $munglist): void {}
183172

184-
/** @return bool */
185-
final public static function unlinkArchive(string $archive) {}
173+
final public static function unlinkArchive(string $archive): bool {}
186174

187-
/** @return void */
188-
final public static function webPhar(?string $alias = null, ?string $index = null, string $f404 = UNKNOWN, array $mimetypes = [], $rewrites = UNKNOWN) {}
175+
final public static function webPhar(
176+
?string $alias = null, ?string $index = null, string $f404 = UNKNOWN,
177+
array $mimetypes = [], $rewrites = UNKNOWN): void {}
189178
}
190179

191180
class PharData extends RecursiveDirectoryIterator implements Countable, ArrayAccess
@@ -330,50 +319,39 @@ public function startBuffering() {}
330319
/** @return void */
331320
public function stopBuffering() {}
332321

333-
/** @return string */
334-
final public static function apiVersion() {}
322+
final public static function apiVersion(): string {}
335323

336-
/** @return bool */
337-
final public static function canCompress(int $method = 0) {}
324+
final public static function canCompress(int $method = 0): bool {}
338325

339-
/** @return bool */
340-
final public static function canWrite() {}
326+
final public static function canWrite(): bool {}
341327

342-
/** @return string */
343-
final public static function createDefaultStub(string $index = UNKNOWN, string $webindex = UNKNOWN) {}
328+
final public static function createDefaultStub(
329+
string $index = UNKNOWN, string $webindex = UNKNOWN): string {}
344330

345-
/** @return array */
346-
final public static function getSupportedCompression() {}
331+
final public static function getSupportedCompression(): array {}
347332

348-
/** @return array */
349-
final public static function getSupportedSignatures() {}
333+
final public static function getSupportedSignatures(): array {}
350334

351-
/** @return void */
352-
final public static function interceptFileFuncs() {}
335+
final public static function interceptFileFuncs(): void {}
353336

354-
/** @return bool */
355-
final public static function isValidPharFilename(string $filename, bool $executable = true) {}
337+
final public static function isValidPharFilename(
338+
string $filename, bool $executable = true): bool {}
356339

357-
/** @return bool */
358-
final public static function loadPhar(string $filename, ?string $alias = null) {}
340+
final public static function loadPhar(string $filename, ?string $alias = null): bool {}
359341

360-
/** @return bool */
361-
final public static function mapPhar(?string $alias = null, int $offset = 0) {}
342+
final public static function mapPhar(?string $alias = null, int $offset = 0): bool {}
362343

363-
/** @return string */
364-
final public static function running(bool $retphar = true) {}
344+
final public static function running(bool $retphar = true): string {}
365345

366-
/** @return void */
367-
final public static function mount(string $inphar, string $externalfile) {}
346+
final public static function mount(string $inphar, string $externalfile): void {}
368347

369-
/** @return void */
370-
final public static function mungServer(array $munglist) {}
348+
final public static function mungServer(array $munglist): void {}
371349

372-
/** @return bool */
373-
final public static function unlinkArchive(string $archive) {}
350+
final public static function unlinkArchive(string $archive): bool {}
374351

375-
/** @return void */
376-
final public static function webPhar(?string $alias = null, ?string $index = null, string $f404 = UNKNOWN, array $mimetypes = [], $rewrites = UNKNOWN) {}
352+
final public static function webPhar(
353+
?string $alias = null, ?string $index = null, string $f404 = UNKNOWN,
354+
array $mimetypes = [], $rewrites = UNKNOWN): void {}
377355
}
378356

379357
class PharFileInfo extends SplFileInfo

ext/phar/phar_object_arginfo.h

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -143,58 +143,62 @@ ZEND_END_ARG_INFO()
143143

144144
#define arginfo_class_Phar_stopBuffering arginfo_class_Phar___destruct
145145

146-
#define arginfo_class_Phar_apiVersion arginfo_class_Phar___destruct
146+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_apiVersion, 0, 0, IS_STRING, 0)
147+
ZEND_END_ARG_INFO()
147148

148-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_canCompress, 0, 0, 0)
149+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_canCompress, 0, 0, _IS_BOOL, 0)
149150
ZEND_ARG_TYPE_INFO(0, method, IS_LONG, 0)
150151
ZEND_END_ARG_INFO()
151152

152-
#define arginfo_class_Phar_canWrite arginfo_class_Phar___destruct
153+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_canWrite, 0, 0, _IS_BOOL, 0)
154+
ZEND_END_ARG_INFO()
153155

154-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_createDefaultStub, 0, 0, 0)
156+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_createDefaultStub, 0, 0, IS_STRING, 0)
155157
ZEND_ARG_TYPE_INFO(0, index, IS_STRING, 0)
156158
ZEND_ARG_TYPE_INFO(0, webindex, IS_STRING, 0)
157159
ZEND_END_ARG_INFO()
158160

159-
#define arginfo_class_Phar_getSupportedCompression arginfo_class_Phar___destruct
161+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_getSupportedCompression, 0, 0, IS_ARRAY, 0)
162+
ZEND_END_ARG_INFO()
160163

161-
#define arginfo_class_Phar_getSupportedSignatures arginfo_class_Phar___destruct
164+
#define arginfo_class_Phar_getSupportedSignatures arginfo_class_Phar_getSupportedCompression
162165

163-
#define arginfo_class_Phar_interceptFileFuncs arginfo_class_Phar___destruct
166+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_interceptFileFuncs, 0, 0, IS_VOID, 0)
167+
ZEND_END_ARG_INFO()
164168

165-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_isValidPharFilename, 0, 0, 1)
169+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_isValidPharFilename, 0, 1, _IS_BOOL, 0)
166170
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
167171
ZEND_ARG_TYPE_INFO(0, executable, _IS_BOOL, 0)
168172
ZEND_END_ARG_INFO()
169173

170-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_loadPhar, 0, 0, 1)
174+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_loadPhar, 0, 1, _IS_BOOL, 0)
171175
ZEND_ARG_TYPE_INFO(0, filename, IS_STRING, 0)
172176
ZEND_ARG_TYPE_INFO(0, alias, IS_STRING, 1)
173177
ZEND_END_ARG_INFO()
174178

175-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_mapPhar, 0, 0, 0)
179+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_mapPhar, 0, 0, _IS_BOOL, 0)
176180
ZEND_ARG_TYPE_INFO(0, alias, IS_STRING, 1)
177181
ZEND_ARG_TYPE_INFO(0, offset, IS_LONG, 0)
178182
ZEND_END_ARG_INFO()
179183

180-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_running, 0, 0, 0)
184+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_running, 0, 0, IS_STRING, 0)
181185
ZEND_ARG_TYPE_INFO(0, retphar, _IS_BOOL, 0)
182186
ZEND_END_ARG_INFO()
183187

184-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_mount, 0, 0, 2)
188+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_mount, 0, 2, IS_VOID, 0)
185189
ZEND_ARG_TYPE_INFO(0, inphar, IS_STRING, 0)
186190
ZEND_ARG_TYPE_INFO(0, externalfile, IS_STRING, 0)
187191
ZEND_END_ARG_INFO()
188192

189-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_mungServer, 0, 0, 1)
193+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_mungServer, 0, 1, IS_VOID, 0)
190194
ZEND_ARG_TYPE_INFO(0, munglist, IS_ARRAY, 0)
191195
ZEND_END_ARG_INFO()
192196

193-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_unlinkArchive, 0, 0, 1)
197+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_unlinkArchive, 0, 1, _IS_BOOL, 0)
194198
ZEND_ARG_TYPE_INFO(0, archive, IS_STRING, 0)
195199
ZEND_END_ARG_INFO()
196200

197-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Phar_webPhar, 0, 0, 0)
201+
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Phar_webPhar, 0, 0, IS_VOID, 0)
198202
ZEND_ARG_TYPE_INFO(0, alias, IS_STRING, 1)
199203
ZEND_ARG_TYPE_INFO(0, index, IS_STRING, 1)
200204
ZEND_ARG_TYPE_INFO(0, f404, IS_STRING, 0)
@@ -289,19 +293,19 @@ ZEND_END_ARG_INFO()
289293

290294
#define arginfo_class_PharData_stopBuffering arginfo_class_Phar___destruct
291295

292-
#define arginfo_class_PharData_apiVersion arginfo_class_Phar___destruct
296+
#define arginfo_class_PharData_apiVersion arginfo_class_Phar_apiVersion
293297

294298
#define arginfo_class_PharData_canCompress arginfo_class_Phar_canCompress
295299

296-
#define arginfo_class_PharData_canWrite arginfo_class_Phar___destruct
300+
#define arginfo_class_PharData_canWrite arginfo_class_Phar_canWrite
297301

298302
#define arginfo_class_PharData_createDefaultStub arginfo_class_Phar_createDefaultStub
299303

300-
#define arginfo_class_PharData_getSupportedCompression arginfo_class_Phar___destruct
304+
#define arginfo_class_PharData_getSupportedCompression arginfo_class_Phar_getSupportedCompression
301305

302-
#define arginfo_class_PharData_getSupportedSignatures arginfo_class_Phar___destruct
306+
#define arginfo_class_PharData_getSupportedSignatures arginfo_class_Phar_getSupportedCompression
303307

304-
#define arginfo_class_PharData_interceptFileFuncs arginfo_class_Phar___destruct
308+
#define arginfo_class_PharData_interceptFileFuncs arginfo_class_Phar_interceptFileFuncs
305309

306310
#define arginfo_class_PharData_isValidPharFilename arginfo_class_Phar_isValidPharFilename
307311

0 commit comments

Comments
 (0)