PHP RFC: Deprecate and Remove image2wbmp()
- Version: 1.0
- Date: 2018-05-26
- Author: Christoph M. Becker, cmb@php.net
- Status: Implemented (PHP 7.3)
- First Published at: http://wiki.php.net/rfc/image2wbmp
Introduction
ext/gd has two functions to output WBMP 1) images: imagewbmp() and image2wbmp().
Both are supposed to handle the necessary monochrome conversion by different means.
While the former function allows the desired foreground color to be specified, the latter
function is supposed to take a brightness threshold parameter. However, as of PHP 5.0.0 the
threshold parameter of image2wbmp() is treated as foreground color, so both functions
are basically identical.
This pointless duplication of functionality could be resolved by fixing image2wbmp()
according to the documentation (i.e. treat the third parameter actually as brightness treshold),
but
- fixing this 10+y old bug is likely to cause more harm than good
- a monochrome conversion should be a general feature of GD (or rather libgd), since it may be useful for other image formats as well (e.g. PNG)
- the implemented monochrome conversion is very simplistic, and does not fit to gdImageGrayScale()'s algorithm
- WBMP might be considered obsolete nowadays
Proposal
Therefore, this RFC proposes to:
- fix the documentation according to the current implementation
- remove superfluous code (most notably _php_image_bw_convert())
- deprecate
image2wbmp() - finally remove
image2wbmp()altogether
Backward Incompatible Changes
After the deprecation, each call to image2wbmp() would issue a deprecated warning.
After the removal, each call to image2wbmp() would raise a fatal error.
Proposed PHP Version(s)
Item (1) to (3) of the proposal should target next PHP 7.y (i.e. PHP 7.3), while item (4) (i.e. the actual removal) should target next PHP x (supposedly PHP 8).
Voting
A single vote will be held to decide whether to implement the proposal. This vote will require a 2/3 supermajority. Voting started on 2018-05-26, and ended on 2018-06-09 21:00 UTC.
Patches and Tests
A pull request regarding the deprecation is available.
Implementation
- Implemented in PHP 7.3 via http://git.php.net/?p=php-src.git;a=commit;h=3cbf594dfd0708dc36f1655c50e16fa963e61501
References
- relevant bug report
- preliminary discussion on internals