Skip to content

Deprecate the procedural API of ext/zip #5746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions ext/zip/php_zip.stub.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,66 @@

/** @generate-function-entries */

/** @return resource|int|false */
/**
* @return resource|int|false
* @deprecated
*/
function zip_open(string $filename) {}

/**
* @param resource $zip
* @deprecated
*/
function zip_close($zip): void {}

/**
* @param resource $zip
* @return resource|false
* @deprecated
*/
function zip_read($zip) {}

/**
* @param resource $zip_dp
* @param resource $zip_entry
* @deprecated
*/
function zip_entry_open($zip_dp, $zip_entry, string $mode = 'rb'): bool {}

/**
* @param resource $zip_ent
* @deprecated
*/
function zip_entry_close($zip_ent): bool {}

/** @param resource $zip_entry */
/**
* @param resource $zip_entry
* @deprecated
*/
function zip_entry_read($zip_entry, int $len = 1024): string|false {}

/** @param resource $zip_entry */
/**
* @param resource $zip_entry
* @deprecated
*/
function zip_entry_name($zip_entry): string|false {}

/** @param resource $zip_entry */
/**
* @param resource $zip_entry
* @deprecated
*/
function zip_entry_compressedsize($zip_entry): int|false {}

/** @param resource $zip_entry */
/**
* @param resource $zip_entry
* @deprecated
*/
function zip_entry_filesize($zip_entry): int|false {}

/** @param resource $zip_entry */
/**
* @param resource $zip_entry
* @deprecated
*/
function zip_entry_compressionmethod($zip_entry): string|false {}

class ZipArchive
Expand Down
20 changes: 10 additions & 10 deletions ext/zip/php_zip_arginfo.h
Original file line number Diff line number Diff line change
Expand Up @@ -366,16 +366,16 @@ ZEND_METHOD(ZipArchive, isEncryptionMethodSupported);


static const zend_function_entry ext_functions[] = {
ZEND_FE(zip_open, arginfo_zip_open)
ZEND_FE(zip_close, arginfo_zip_close)
ZEND_FE(zip_read, arginfo_zip_read)
ZEND_FE(zip_entry_open, arginfo_zip_entry_open)
ZEND_FE(zip_entry_close, arginfo_zip_entry_close)
ZEND_FE(zip_entry_read, arginfo_zip_entry_read)
ZEND_FE(zip_entry_name, arginfo_zip_entry_name)
ZEND_FE(zip_entry_compressedsize, arginfo_zip_entry_compressedsize)
ZEND_FE(zip_entry_filesize, arginfo_zip_entry_filesize)
ZEND_FE(zip_entry_compressionmethod, arginfo_zip_entry_compressionmethod)
ZEND_DEP_FE(zip_open, arginfo_zip_open)
ZEND_DEP_FE(zip_close, arginfo_zip_close)
ZEND_DEP_FE(zip_read, arginfo_zip_read)
ZEND_DEP_FE(zip_entry_open, arginfo_zip_entry_open)
ZEND_DEP_FE(zip_entry_close, arginfo_zip_entry_close)
ZEND_DEP_FE(zip_entry_read, arginfo_zip_entry_read)
ZEND_DEP_FE(zip_entry_name, arginfo_zip_entry_name)
ZEND_DEP_FE(zip_entry_compressedsize, arginfo_zip_entry_compressedsize)
ZEND_DEP_FE(zip_entry_filesize, arginfo_zip_entry_filesize)
ZEND_DEP_FE(zip_entry_compressionmethod, arginfo_zip_entry_compressionmethod)
ZEND_FE_END
};

Expand Down
11 changes: 10 additions & 1 deletion ext/zip/tests/bug7214.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,14 @@ if (strlen($contents) == zip_entry_filesize($entry)) {
}

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_filesize() is deprecated in %s on line %d

Deprecated: Function zip_entry_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_filesize() is deprecated in %s on line %d
Ok
6 changes: 6 additions & 0 deletions ext/zip/tests/doubleclose.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,13 @@ if ($zip->status == ZIPARCHIVE::ER_OK) {
Done
--EXPECTF--
Procedural

Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
NULL

Deprecated: Function zip_close() is deprecated in %s on line %d
zip_close(): supplied resource is not a valid Zip Directory resource
Object
bool(true)
Expand Down
50 changes: 49 additions & 1 deletion ext/zip/tests/oo_setcompression.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,65 @@ zip_close($zip);
$tmpfile = __DIR__ . '/oo_setcompression.zip';
unlink($tmpfile);
?>
--EXPECT--
--EXPECTF--
bool(true)
bool(true)
bool(true)
bool(true)
bool(true)
bool(true)

Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
entry1.txt: deflated

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
entry2.txt: deflated

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
dir/entry3.txt: stored

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
entry4.txt: deflated

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
entry5.txt: stored

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
entry6.txt: deflated

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
entry7.txt: deflated

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
5 changes: 4 additions & 1 deletion ext/zip/tests/zip_close.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,8 @@ zip_close($zip);
echo "OK";

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
OK
19 changes: 15 additions & 4 deletions ext/zip/tests/zip_entry_close.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,19 @@ try {
zip_close($zip);
?>
Done
--EXPECT--
entry_open: bool(true)
entry_close: bool(true)
entry_close: zip_entry_close(): supplied resource is not a valid Zip Entry resource
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d
entry_open:
Deprecated: Function zip_entry_open() is deprecated in %s on line %d
bool(true)
entry_close:
Deprecated: Function zip_entry_close() is deprecated in %s on line %d
bool(true)
entry_close:
Deprecated: Function zip_entry_close() is deprecated in %s on line %d
zip_entry_close(): supplied resource is not a valid Zip Entry resource

Deprecated: Function zip_close() is deprecated in %s on line %d
Done
23 changes: 22 additions & 1 deletion ext/zip/tests/zip_entry_compressedsize.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,29 @@ while ($entry = zip_read($zip)) {
zip_close($zip);

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressedsize() is deprecated in %s on line %d
5

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressedsize() is deprecated in %s on line %d
4

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressedsize() is deprecated in %s on line %d
0

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressedsize() is deprecated in %s on line %d
24

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
23 changes: 22 additions & 1 deletion ext/zip/tests/zip_entry_compressionmethod.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,29 @@ while ($entry = zip_read($zip)) {
zip_close($zip);

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
stored

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
stored

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
stored

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_compressionmethod() is deprecated in %s on line %d
deflated

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
23 changes: 22 additions & 1 deletion ext/zip/tests/zip_entry_filesize.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,29 @@ while ($entry = zip_read($zip)) {
zip_close($zip);

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_filesize() is deprecated in %s on line %d
5

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_filesize() is deprecated in %s on line %d
4

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_filesize() is deprecated in %s on line %d
0

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_filesize() is deprecated in %s on line %d
27

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
23 changes: 22 additions & 1 deletion ext/zip/tests/zip_entry_name.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,29 @@ while ($entry = zip_read($zip)) {
zip_close($zip);

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d
foo

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d
bar

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d
foobar/

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_name() is deprecated in %s on line %d
foobar/baz

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
10 changes: 9 additions & 1 deletion ext/zip/tests/zip_entry_open.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,13 @@ zip_entry_close($entry);
zip_close($zip);

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_open() is deprecated in %s on line %d
OK
Deprecated: Function zip_entry_close() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
14 changes: 13 additions & 1 deletion ext/zip/tests/zip_entry_read.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,17 @@ zip_entry_close($entry);
zip_close($zip);

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d

Deprecated: Function zip_read() is deprecated in %s on line %d

Deprecated: Function zip_entry_open() is deprecated in %s on line %d

Deprecated: Function zip_entry_read() is deprecated in %s on line %d
foo


Deprecated: Function zip_entry_close() is deprecated in %s on line %d

Deprecated: Function zip_close() is deprecated in %s on line %d
3 changes: 2 additions & 1 deletion ext/zip/tests/zip_open.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ $zip = zip_open(__DIR__."/test_procedural.zip");
echo is_resource($zip) ? "OK" : "Failure";

?>
--EXPECT--
--EXPECTF--
Deprecated: Function zip_open() is deprecated in %s on line %d
OK
Loading